From 38a2b86184089f45863b4b1344036f6cf4645e1a Mon Sep 17 00:00:00 2001
From: James API documentation for Amazon AppStream 2.0. Associate a fleet to a stack. Creates a directory configuration with the given parameters. Creates a new fleet. Create a new stack. Creates a URL to start an AppStream 2.0 streaming session for a user. By default, the URL is valid only for 1 minute from the time that it is generated. Deletes the directory configuration with the given parameters. Deletes a fleet. Deletes the stack. After this operation completes, the environment can no longer be activated, and any reservations made for the stack are released. Returns a list describing the specified directory configurations. If fleet names are provided, this operation describes the specified fleets; otherwise, all the fleets in the account are described. Describes the images. If a list of names is not provided, all images in your account are returned. This operation does not return a paginated result. Describes the streaming sessions for a stack and a fleet. If a user ID is provided, this operation returns streaming sessions for only that user. Pass this value for the If stack names are not provided, this operation describes the specified stacks; otherwise, all stacks in the account are described. Pass the Describes the streaming sessions for a stack and a fleet. If a user ID is provided, this operation returns streaming sessions for only that user. To retrieve the next set of items, pass this value for the If stack names are not provided, this operation describes the specified stacks; otherwise, all stacks in the account are described. To retrieve the next set of items, pass the Disassociates a fleet from a stack. This operation immediately stops a streaming session. Lists all fleets associated with the stack. Lists all stacks to which the specified fleet is associated. Starts a fleet. Stops a fleet. Updates the directory configuration with the given parameters. Updates an existing fleet. All the attributes except the fleet name can be updated in the STOPPED state. When a fleet is in the RUNNING state, only Updates the specified fields in the stack with the specified name. The user name of an account in the directory that is used by AppStream 2.0 streaming instances to connect to the directory. This account must have the following privileges: create computer objects, join computers to the domain, change/reset the password on descendant computer objects for the organizational units specified. The password for the user account for directory actions. An entry for a single application in the application catalog. An application can be disabled after image creation if there is a problem. If there is a problem, an application can be disabled after image creation. Whether an image builder can be launched from this image. Delete the VPC association for the specified fleet. Remove all the storage connectors currently enabled for the stack. Enables or disables default Internet access for the fleet. Whether default Internet access is enabled for the fleet. Enables or disables default Internet access for the fleet. Enables or disables default internet access for the fleet. Whether default internet access is enabled for the fleet. Enables or disables default internet access for the fleet. Contains the parameters for the new fleet to create. The description displayed to end users on the AppStream 2.0 portal. Full directory configuration details, which are used to join domains for the AppStream 2.0 streaming instances. Directory configuration details. The updated directory configuration details. The list of directory configurations. The fully qualified name of the directory, such as corp.example.com The name of the directory configuration to be deleted. The fully qualified name of the directory, such as corp.example.com The fully qualified name of the directory, such as corp.example.com The name of the existing directory configuration to be updated. A specific list of directory names. The name displayed to end users on the AppStream 2.0 portal. The DirectoryName and OrganizationalUnitDistinguishedName values, which are used to join domains for the AppStream 2.0 streaming instances. The DirectoryName and OrganizationalUnitDistinguishedName values, which are used to join domains for the AppStream 2.0 streaming instances. The DirectoryName and OrganizationalUnitDistinguishedName values, which are used to join domains for the AppStream 2.0 streaming instances. The DirectoryName and OrganizationalUnitDistinguishedName values, which are used to join domains for the AppStream 2.0 streaming instances. The error message in the exception. The image starts in the PENDING state, and then moves to AVAILABLE if image creation succeeds and FAILED if image creation has failed. The image starts in the PENDING state. If image creation succeeds, it moves to AVAILABLE. If image creation fails, it moves to FAILED. The number of currently available instances that can be used to stream sessions. The maximum time for which a streaming session can run. The input can be any numeric value in seconds between 600 and 57600. The time after disconnection when a session is considered to have ended. If a user who got disconnected reconnects within this timeout interval, the user is connected back to their previous session. The input can be any numeric value in seconds between 60 and 57600. The size of each page of results. The size of each page of results. The default value is 20 and the maximum supported value is 50. The maximum time for which a streaming session can run. The value can be any numeric value in seconds between 600 and 57600. The time after disconnection when a session is considered to have ended. If a user who got disconnected reconnects within this timeout interval, the user is connected back to their previous session. The input can be any numeric value in seconds between 60 and 57600. The distinguished name of the organizational unit to place the computer account in. The list of the distinguished names of organizational units to place computer accounts in. The list of the distinguished names of organizational units in which to place computer accounts. The list of the distinguished names of organizational units to place computer accounts in. Security groups associated with the fleet. The AccountName and AccountPassword of the service account, to be used by the streaming instance to connect to the directory. The AccountName and AccountPassword values for the service account, which are used by the streaming instance to connect to the directory. The AccountName and AccountPassword of the service account, to be used by the streaming instance to connect to the directory. The AccountName and AccountPassword values for the service account, which are used by the streaming instance to connect to the directory Contains the parameters for a streaming session. The type of storage connector. The possible values include: HOMEFOLDERS. A unique user ID for whom the URL is generated. The name of the fleet to associate. The name of the stack to which the fleet is associated. Unique name of the image used by the fleet. The instance type of compute resources for the fleet. Fleet instances are launched from this instance type. The instance type of compute resources for the fleet. Fleet instances are launched from this instance type. Available instance types are: stream.standard.medium stream.standard.large stream.compute.large stream.compute.xlarge stream.compute.2xlarge stream.compute.4xlarge stream.compute.8xlarge stream.memory.large stream.memory.xlarge stream.memory.2xlarge stream.memory.4xlarge stream.memory.8xlarge The unique identifier for this stack. The stack for which the URL is generated. The fleet for which the URL is generated. The URL to start the AppStream 2.0 streaming session. The name of the fleet to be deleted. The name of the stack to delete. The DescribeDirectoryConfigsResult.NextToken from a previous call to DescribeDirectoryConfigs. If this is the first call, pass null. If not null, more results are available. To retrieve the next set of items, pass this value for the NextToken parameter in a subsequent call to DescribeDirectoryConfigs. The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page. The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null. The name of the stack for which to list sessions. The image name from which a fleet is created. The name of the fleet. The instance type of compute resources for the fleet. Fleet instances are launched from this instance type. The instance type of compute resources for the fleet. Fleet instances are launched from this instance type. Available instance types are: stream.standard.medium stream.standard.large stream.compute.large stream.compute.xlarge stream.compute.2xlarge stream.compute.4xlarge stream.compute.8xlarge stream.memory.large stream.memory.xlarge stream.memory.2xlarge stream.memory.4xlarge stream.memory.8xlarge The name of the stack to update. Elapsed seconds after the Unix epoch, at which time this URL expires. Elapsed seconds after the Unix epoch, when this URL expires. The time stamp when the directory configuration was created within AppStream 2.0. The time at which the fleet was created. The timestamp when the image was created. The time stamp when the image was created. The AWS release date of the public base image. For private images, this date is the release date of the base image from which the image was created. The timestamp when the stack was created. The time stamp when the stack was created. A unique user ID for whom the URL is generated. The user for whom to list sessions. Use null to describe all the sessions for the stack and fleet. The identifier of the user for whom the session was created. Specifies the attributes that should be indexed on. Currently only a single attribute is supported. Specifies the attributes that should be indexed on. Currently only a single attribute is supported. A set of attributes that are associated with the typed link. A set of attributes that are associated with the typed link. Identifies the attribute value to update. The order of identity attributes for the facet, from most significant to least significant. The ability to filter typed links considers the order that the attributes are defined on the typed link facet. When providing ranges to typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range. Filters are interpreted in the order of the attributes on the typed link facet, not the order in which they are supplied to any API calls. For more information about identity attributes, see Typed link. The set of attributes that distinguish links made from this facet from each other, in the order of significance. Listing typed links can filter on the values of these attributes. See ListOutgoingTypedLinks and ListIncomingTypeLinks for details. The set of attributes that distinguish links made from this facet from each other, in the order of significance. Listing typed links can filter on the values of these attributes. See ListOutgoingTypedLinks and ListIncomingTypedLinks for details. The order of identity attributes for the facet, from most significant to least significant. The ability to filter typed links considers the order that the attributes are defined on the typed link facet. When providing ranges to a typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range. Filters are interpreted in the order of the attributes on the typed link facet, not the order in which they are supplied to any API calls. For more information about identity attributes, see Typed link. Represents the output of an Represents the output of an AttachObject operation. Attaches an object to a Directory. Represents the output batch Represents the output batch AttachObject response operation. Attaches an object to a Directory. Attaches a policy object to a regular object inside a BatchRead operation. For more information, see AttachPolicy and BatchReadRequest$Operations. Attaches a policy object to a regular object. An object can have a limited number of attached policies. Represents the output of an AttachPolicy response operation. Attaches a policy object to a regular object. An object can have a limited number of attached policies. Attaches the specified object to the specified index inside a BatchRead operation. For more information, see AttachToIndex and BatchReadRequest$Operations. Attaches the specified object to the specified index. Represents the output of a AttachToIndex response operation. Attaches the specified object to the specified index. Attaches a typed link to a specified source and target object inside a BatchRead operation. For more information, see AttachTypedLink and BatchReadRequest$Operations. Attaches a typed link to a specified source and target object. For more information, see Typed link. Represents the output of a AttachTypedLink response operation. Attaches a typed link to a specified source and target object. For more information, see Typed link. Creates an index object inside of a BatchRead operation. For more information, see CreateIndex and BatchReadRequest$Operations. Creates an index object. See Indexing for more information. Represents the output of a CreateIndex response operation. Creates an index object. See Indexing for more information. Represents the output of a Represents the output of a CreateObject operation. Creates an object. Represents the output of a Represents the output of a CreateObject response operation. Creates an object in a Directory. Represents the output of a Represents the output of a DeleteObject operation. Deletes an object in a Directory. Represents the output of a Represents the output of a DeleteObject response operation. Deletes an object in a Directory. Detaches the specified object from the specified index inside a BatchRead operation. For more information, see DetachFromIndex and BatchReadRequest$Operations. Detaches the specified object from the specified index. Represents the output of a DetachFromIndex response operation. Detaches the specified object from the specified index. Represents the output of a Represents the output of a DetachObject operation. Detaches an object from a Directory. Represents the output of a Represents the output of a DetachObject response operation. Detaches an object from a Directory. Detaches a typed link from a specified source and target object inside a BatchRead operation. For more information, see DetachTypedLink and BatchReadRequest$Operations. Detaches a typed link from a specified source and target object. For more information, see Typed link. Represents the output of a DetachTypedLink response operation. Detaches a typed link from a specified source and target object. For more information, see Typed link. Retrieves metadata about an object inside a BatchRead operation. For more information, see GetObjectInformation and BatchReadRequest$Operations. Retrieves metadata about an object. Represents the output of a GetObjectInformation response operation. Retrieves metadata about an object. Lists indices attached to an object inside a BatchRead operation. For more information, see ListAttachedIndices and BatchReadRequest$Operations. Lists indices attached to an object. Represents the output of a ListAttachedIndices response operation. Lists indices attached to an object. Returns a paginated list of all the incoming TypedLinkSpecifier information for an object inside a BatchRead operation. For more information, see ListIncomingTypedLinks and BatchReadRequest$Operations. Returns a paginated list of all the incoming TypedLinkSpecifier information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see Typed link. Represents the output of a ListIncomingTypedLinks response operation. Returns a paginated list of all the incoming TypedLinkSpecifier information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see Typed link. Lists objects attached to the specified index inside a BatchRead operation. For more information, see ListIndex and BatchReadRequest$Operations. Lists objects attached to the specified index. Represents the output of a ListIndex response operation. Lists objects attached to the specified index. Represents the output of a Represents the output of a ListObjectAttributes operation. Lists all attributes that are associated with an object. Represents the output of a Represents the output of a ListObjectAttributes response operation. Lists all attributes that are associated with an object. Represents the output of a Represents the output of a ListObjectChildren operation. Returns a paginated list of child objects that are associated with a given object. Represents the output of a Represents the output of a ListObjectChildren response operation. Returns a paginated list of child objects that are associated with a given object. Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects inside a BatchRead operation. For more information, see ListObjectParentPaths and BatchReadRequest$Operations. Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects. For more information about objects, see Directory Structure. Represents the output of a ListObjectParentPaths response operation. Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects. For more information about objects, see Directory Structure. Returns policies attached to an object in pagination fashion inside a BatchRead operation. For more information, see ListObjectPolicies and BatchReadRequest$Operations. Returns policies attached to an object in pagination fashion. Represents the output of a ListObjectPolicies response operation. Returns policies attached to an object in pagination fashion. Returns a paginated list of all the outgoing TypedLinkSpecifier information for an object inside a BatchRead operation. For more information, see ListOutgoingTypedLinks and BatchReadRequest$Operations. Returns a paginated list of all the outgoing TypedLinkSpecifier information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see Typed link. Represents the output of a ListOutgoingTypedLinks response operation. Returns a paginated list of all the outgoing TypedLinkSpecifier information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see Typed link. Returns all of the Returns all of the Represents the output of a ListPolicyAttachments response operation. Returns all of the Lists all policies from the root of the Directory to the object specified inside a BatchRead operation. For more information, see LookupPolicy and BatchReadRequest$Operations. Lists all policies from the root of the Directory to the object specified. If there are no policies present, an empty list is returned. If policies are present, and if some objects don't have the policies attached, it returns the Represents the output of a LookupPolicy response operation. Lists all policies from the root of the Directory to the object specified. If there are no policies present, an empty list is returned. If policies are present, and if some objects don't have the policies attached, it returns the The batch reference name. See Batches for more information. The batch reference name. See Batches for more information. The batch reference name. See Batches for more information. Indicates whether the attribute that is being indexed has unique values or not. Indicates whether the attribute that is being indexed has unique values or not. Whether the attribute is mutable or not. Whether the attribute is mutable or not. The indices attached to the specified object. The objects and indexed values attached to the index. The indices attached to the specified object. The objects and indexed values attached to the index. The link name with which the child object is attached to the parent. The name of the link. The name of the link between the parent object and the index object. The name of the link. The name of the link. The name of the link between the parent object and the index object. The pagination token. The pagination token. The pagination token. The pagination token. The pagination token. The pagination token. The pagination token. The pagination token. The pagination token. The pagination token. The pagination token. The pagination token. The pagination token. The pagination token. The pagination token. The pagination token. The pagination token. The pagination token. The pagination token. The pagination token. The pagination token. The pagination token. The pagination token. The maximum number of results to retrieve. The maximum number of results to retrieve. The maximum number of results to retrieve. The maximum number of items to be retrieved in a single call. This is an approximate number. Maximum number of items to be retrieved in a single call. This is an approximate number. The maximum number of results to retrieve. The maximum number of results to retrieve. The maximum number of results to retrieve. The maximum number of results to retrieve. The maximum number of results to retrieve. The maximum number of results to retrieve. The maximum number of results to retrieve. The maximum number of results to retrieve. Specifies the ranges of indexed values that you want to query. Specifies the ranges of indexed values that you want to query. The attached The The The The The ID that is associated with the object. The The The ID that is associated with the object. The root object node of the created directory. The A list of policy A list of A list of policy A list of Lists A reference to the object being mutated. The parent object reference. The child object reference that is to be attached to the object. The reference that is associated with the policy object. The reference that identifies the object to which the policy will be attached. A reference to the index that you are attaching the object to. A reference to the object that you are attaching to the index. Identifies the source object that the typed link will attach to. Identifies the target object that the typed link will attach to. A reference to the parent object that contains the index object. If specified, the parent reference to which this object will be attached. The reference that identifies the object. A reference to the index object. A reference to the object being detached from the index. Parent reference from which the object with the specified link name is detached. A reference to the object. A reference to the object that has indices attached. The reference that identifies the object whose attributes will be listed. The reference to the index to list. Reference of the object whose attributes need to be listed. Reference of the object for which child objects are being listed. The reference that identifies the object whose attributes will be listed. The reference that identifies the object whose attributes will be listed. The reference that identifies the object whose attributes will be listed. The reference that identifies the policy object. Reference that identifies the object whose policies will be looked up. A reference to the object whose facet will be removed. Reference that identifies the object. A reference to the parent object that contains the index object. Reference that identifies the policy object. Reference that identifies the object whose policy object will be detached. A reference to the object. A reference to the object to that has indices attached. A reference to the object that has indices attached. Reference that identifies the object whose attributes will be listed. The reference to the index to list. The reference that identifies the object whose attributes will be listed. Returns the path to the Returns the path to the Provides list of path to policies. Policies contain Provides list of path to policies. Policies contain A list of The facets attached to the specified object. A list of schema facets to be associated with the object that contains The facets attached to the specified object. Provides range filters for multiple attributes. When providing ranges to typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range. Provides range filters for multiple attributes. When providing ranges to typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range. Provides range filters for multiple attributes. When providing ranges to typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range. Provides range filters for multiple attributes. When providing ranges to typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range. Identifies the schema Amazon Resource Name (ARN) and facet name for the typed link. Identifies the typed link facet that is associated with the typed link. Identifies the typed link facet that is associated with the typed link. Filters are interpreted in the order of the attributes on the typed link facet, not the order in which they are supplied to any API calls. Filters are interpreted in the order of the attributes defined on the typed link facet, not the order they are supplied to any API calls. Filters are interpreted in the order of the attributes on the typed link facet, not the order in which they are supplied to any API calls. Filters are interpreted in the order of the attributes defined on the typed link facet, not the order they are supplied to any API calls. Identifies the typed link facet that is associated with the typed link. Contains all the information that is used to uniquely identify a typed link. The parameters discussed in this topic are used to uniquely specify the typed link being operated on. The AttachTypedLink API returns a typed link specifier while the DetachTypedLink API accepts one as input. Similarly, the ListIncomingTypedLinks and ListOutgoingTypedLinks API operations provide typed link specifiers as output. You can also construct a typed link specifier from scratch. Returns a typed link specifier as output. Returns a typed link specifier as output. Used to accept a typed link specifier as input. Used to accept a typed link specifier as input. Returns one or more typed link specifiers as output. Returns a typed link specifier as output. Returns one or more typed link specifiers as output. Returns a typed link specifier as output. AWS CloudFormation allows you to create and manage AWS infrastructure deployments predictably and repeatedly. You can use AWS CloudFormation to leverage AWS products, such as Amazon Elastic Compute Cloud, Amazon Elastic Block Store, Amazon Simple Notification Service, Elastic Load Balancing, and Auto Scaling to build highly-reliable, highly scalable, cost-effective applications without creating or configuring the underlying AWS infrastructure. With AWS CloudFormation, you declare all of your resources and dependencies in a template file. The template defines a collection of resources as a single unit called a stack. AWS CloudFormation creates and deletes all member resources of the stack together and manages all dependencies between the resources for you. For more information about AWS CloudFormation, see the AWS CloudFormation Product Page. Amazon CloudFormation makes use of other AWS products. If you need additional technical information about a specific AWS product, you can find the product's technical documentation at docs.aws.amazon.com. AWS CloudFormation allows you to create and manage AWS infrastructure deployments predictably and repeatedly. You can use AWS CloudFormation to leverage AWS products, such as Amazon Elastic Compute Cloud, Amazon Elastic Block Store, Amazon Simple Notification Service, Elastic Load Balancing, and Auto Scaling to build highly-reliable, highly scalable, cost-effective applications without creating or configuring the underlying AWS infrastructure. With AWS CloudFormation, you declare all of your resources and dependencies in a template file. The template defines a collection of resources as a single unit called a stack. AWS CloudFormation creates and deletes all member resources of the stack together and manages all dependencies between the resources for you. For more information about AWS CloudFormation, see the AWS CloudFormation Product Page. Amazon CloudFormation makes use of other AWS products. If you need additional technical information about a specific AWS product, you can find the product's technical documentation at docs.aws.amazon.com. APIs for stacks When you use AWS CloudFormation, you manage related resources as a single unit called a stack. You create, update, and delete a collection of resources by creating, updating, and deleting stacks. All the resources in a stack are defined by the stack's AWS CloudFormation template. Actions Data Types APIs for change sets If you need to make changes to the running resources in a stack, you update the stack. Before making changes to your resources, you can generate a change set, which is summary of your proposed changes. Change sets allow you to see how your changes might impact your running resources, especially for critical resources, before implementing them. Actions Data Types APIs for stack sets AWS CloudFormation StackSets lets you create a collection, or stack set, of stacks that can automatically and safely provision a common set of AWS resources across multiple AWS accounts and multiple AWS regions from a single AWS CloudFormation template. When you create a stack set, AWS CloudFormation provisions a stack in each of the specified accounts and regions by using the supplied AWS CloudFormation template and parameters. Stack sets let you manage a common set of AWS resources in a selection of accounts and regions in a single operation. Actions Data Types Cancels an update on the specified stack. If the call completes successfully, the stack rolls back the update and reverts to the previous stack configuration. You can cancel only stacks that are in the UPDATE_IN_PROGRESS state. For a specified stack that is in the A stack goes into the Creates a list of changes that will be applied to a stack so that you can review the changes before executing them. You can create a change set for a stack that doesn't exist or an existing stack. If you create a change set for a stack that doesn't exist, the change set shows all of the resources that AWS CloudFormation will create. If you create a change set for an existing stack, AWS CloudFormation compares the stack's information with the information that you submit in the change set and lists the differences. Use change sets to understand which resources AWS CloudFormation will create or change, and how it will change resources in an existing stack, before you create or update a stack. To create a change set for a stack that doesn't exist, for the When you are satisfied with the changes the change set will make, execute the change set by using the ExecuteChangeSet action. AWS CloudFormation doesn't make changes until you execute the change set. Creates a stack as specified in the template. After the call completes successfully, the stack creation starts. You can check the status of the stack via the DescribeStacks API. Creates stack instances for the specified accounts, within the specified regions. A stack instance refers to a stack in a specific account and region. Creates a stack set. Deletes the specified change set. Deleting change sets ensures that no one executes the wrong change set. If the call successfully completes, AWS CloudFormation successfully deleted the change set. Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks do not show up in the DescribeStacks API if the deletion has been completed successfully. Deletes stack instances for the specified accounts, in the specified regions. Deletes a stack set. Before you can delete a stack set, all of its member stack instances must be deleted. For more information about how to do this, see DeleteStackInstances. Retrieves your account's AWS CloudFormation limits, such as the maximum number of stacks that you can create in your account. Returns the inputs for the change set and a list of changes that AWS CloudFormation will make if you execute the change set. For more information, see Updating Stacks Using Change Sets in the AWS CloudFormation User Guide. Returns all stack related events for a specified stack in reverse chronological order. For more information about a stack's event history, go to Stacks in the AWS CloudFormation User Guide. You can list events for stacks that have failed to create or have been deleted by specifying the unique stack identifier (stack ID). Returns the stack instance that's associated with the specified stack set, AWS account, and region. For a list of stack instances that are associated with a specific stack set, use ListStackInstances. Returns a description of the specified resource in the specified stack. For deleted stacks, DescribeStackResource returns resource information for up to 90 days after the stack has been deleted. Returns AWS resource descriptions for running and deleted stacks. If Only the first 100 resources will be returned. If your stack has more resources than this, you should use For deleted stacks, You must specify either A Returns the description of the specified stack set. Returns the description of the specified stack set operation. Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created. If the stack does not exist, an Returns the estimated monthly cost of a template. The return value is an AWS Simple Monthly Calculator URL with a query string that describes the resources required to run the template. Updates a stack using the input information that was provided when the specified change set was created. After the call successfully completes, AWS CloudFormation starts updating the stack. Use the DescribeStacks action to view the status of the update. When you execute a change set, AWS CloudFormation deletes all other change sets associated with the stack because they aren't valid for the updated stack. If a stack policy is associated with the stack, AWS CloudFormation enforces the policy during the update. You can't specify a temporary stack policy that overrides the current policy. Returns the ID and status of each active change set for a stack. For example, AWS CloudFormation lists change sets that are in the Lists all exported output values in the account and region in which you call this action. Use this action to see the exported output values that you can import into other stacks. To import values, use the For more information, see AWS CloudFormation Export Stack Output Values. Lists all stacks that are importing an exported output value. To modify or remove an exported output value, first use this action to see which stacks are using it. To see the exported output values in your account, see ListExports. For more information about importing an exported output value, see the Returns summary information about stack instances that are associated with the specified stack set. You can filter for stack instances that are associated with a specific AWS account name or region. Returns descriptions of all resources of the specified stack. For deleted stacks, ListStackResources returns resource information for up to 90 days after the stack has been deleted. Returns summary information about the results of a stack set operation. Returns summary information about operations performed on a stack set. Returns summary information about stack sets that are associated with the user. Returns the summary information for stacks whose status matches the specified StackStatusFilter. Summary information for stacks that have been deleted is kept for 90 days after the stack is deleted. If no StackStatusFilter is specified, summary information for all stacks is returned (including existing stacks and stacks that have been deleted). Sets a stack policy for a specified stack. Sends a signal to the specified resource with a success or failure status. You can use the SignalResource API in conjunction with a creation policy or update policy. AWS CloudFormation doesn't proceed with a stack creation or update until resources receive the required number of signals or the timeout period is exceeded. The SignalResource API is useful in cases where you want to send signals from anywhere other than an Amazon EC2 instance. Stops an in-progress operation on a stack set and its associated stack instances. Updates a stack as specified in the template. After the call completes successfully, the stack update starts. You can check the status of the stack via the DescribeStacks action. To get a copy of the template for an existing stack, you can use the GetTemplate action. For more information about creating an update template, updating a stack, and monitoring the progress of the update, see Updating a Stack. Updates the stack set and all associated stack instances. Even if the stack set operation created by updating the stack set fails (completely or partially, below or above a specified failure tolerance), the stack set is updated with your changes. Subsequent CreateStackInstances calls on the specified stack set use the updated stack set. Validates a specified template. AWS CloudFormation first checks if the template is valid JSON. If it isn't, AWS CloudFormation checks if the template is valid YAML. If both these checks fail, AWS CloudFormation returns a template validation error. The ID of an AWS account that's associated with this stack instance. The name of the AWS account that you want to list stack instances for. The name of the AWS account that the stack instance is associated with. The name of the AWS account that the stack instance is associated with. The name of the AWS account for this operation result. Structure that contains the results of the account gate function AWS CloudFormation StackSets invokes, if present, before proceeding with stack set operations in an account. Account gating enables you to specify a Lamdba function for an account that encapsulates any requirements that must be met before AWS CloudFormation StackSets proceeds with stack set operations in that account. CloudFormation invokes the function each time stack set operations are initiated for that account, and only proceeds if the function returns a success code. The results of the account gate function AWS CloudFormation invokes, if present, before proceeding with stack set operations in an account The status of the account gate function. The reason for the account gate status assigned to this account. The AccountLimit data type. An account limit structure that contain a list of AWS CloudFormation account limits and their values. The names of one or more AWS accounts that you want to create stack instances in the specified region(s) for. The names of the AWS accounts that you want to delete stack instances for. Resource with the name requested already exists. The resource with the name requested already exists. A list of values that you must specify before AWS CloudFormation can update certain stacks. Some stack templates might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge their capabilities by specifying this parameter. The only valid values are If you have IAM resources, you can specify either capability. If you have IAM resources with custom names, you must specify For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates. A list of values that you must specify before AWS CloudFormation can create certain stacks. Some stack templates might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge their capabilities by specifying this parameter. The only valid values are If you have IAM resources, you can specify either capability. If you have IAM resources with custom names, you must specify For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates. A list of values that you must specify before AWS CloudFormation can create certain stack sets. Some stack set templates might include resources that can affect permissions in your AWS account—for example, by creating new AWS Identity and Access Management (IAM) users. For those stack sets, you must explicitly acknowledge their capabilities by specifying this parameter. The only valid values are CAPABILITY_IAM and CAPABILITY_NAMED_IAM. The following resources require you to specify this parameter: AWS::IAM::AccessKey AWS::IAM::Group AWS::IAM::InstanceProfile AWS::IAM::Policy AWS::IAM::Role AWS::IAM::User AWS::IAM::UserToGroupAddition If your stack template contains these resources, we recommend that you review all permissions that are associated with them and edit their permissions if necessary. If you have IAM resources, you can specify either capability. If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM. If you don't specify this parameter, this action returns an For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates. If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created. The capabilities found within the template. If your template contains IAM resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities error. For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates. The capabilities allowed in the stack. The capabilities that are allowed in the stack set. Some stack set templates might include resources that can affect permissions in your AWS account—for example, by creating new AWS Identity and Access Management (IAM) users. For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates. A list of values that you must specify before AWS CloudFormation can update certain stacks. Some stack templates might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge their capabilities by specifying this parameter. The only valid values are If you have IAM resources, you can specify either capability. If you have IAM resources with custom names, you must specify For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates. A list of values that you must specify before AWS CloudFormation can create certain stack sets. Some stack set templates might include resources that can affect permissions in your AWS account—for example, by creating new AWS Identity and Access Management (IAM) users. For those stack sets, you must explicitly acknowledge their capabilities by specifying this parameter. The only valid values are CAPABILITY_IAM and CAPABILITY_NAMED_IAM. The following resources require you to specify this parameter: AWS::IAM::AccessKey AWS::IAM::Group AWS::IAM::InstanceProfile AWS::IAM::Policy AWS::IAM::Role AWS::IAM::User AWS::IAM::UserToGroupAddition If your stack template contains these resources, we recommend that you review all permissions that are associated with them and edit their permissions if necessary. If you have IAM resources, you can specify either capability. If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM. If you don't specify this parameter, this action returns an For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates. The capabilities found within the template. If your template contains IAM resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities error. For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates. A unique identifier for this A unique identifier for this A unique identifier for this A unique identifier for this A unique identifier for this All events triggered by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: The unique identifier for this stack set operation. The operation ID also functions as an idempotency token, to ensure that AWS CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that AWS CloudFormation successfully received them. If you don't specify an operation ID, the SDK generates one automatically. Repeating this stack set operation with a new operation ID retries all stack instances whose status is The unique identifier for this stack set operation. A unique identifier for this If you don't specify an operation ID, the SDK generates one automatically. A unique identifier for this All events triggered by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: The unique identifier for this stack set operation. If you don't specify an operation ID, the SDK generates one automatically. The operation ID also functions as an idempotency token, to ensure that AWS CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You can retry stack set operation requests to ensure that AWS CloudFormation successfully received them. Repeating this stack set operation with a new operation ID retries all stack instances whose status is The unique identifier for this stack set operation. The unique ID of the stack set operation. A unique identifier for this The token passed to the operation that generated this event. For example, if you execute a A unique identifier for this The ID of the stack set operation. The token passed to the operation that generated this event. All events triggered by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: The unique ID of a stack set operation. The unique ID of the stack set operation. The ID of the stack operation. A unique identifier for this All events triggered by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: The unique ID for this stack set operation. The operation ID also functions as an idempotency token, to ensure that AWS CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that AWS CloudFormation successfully received them. If you don't specify an operation ID, AWS CloudFormation generates one automatically. Repeating this stack set operation with a new operation ID retries all stack instances whose status is The unique ID for this stack set operation. The output for a CreateStack action. The specified resource exists, but has been changed. The input for DescribeStackResource action. The input for DescribeStacks action. Descriptive information about the change set. A description to help you identify this change set. A description of the stack set. You can use the description to identify the stack set's purpose or other important information. Information about the change set. The value that is defined in the User defined description associated with the output. A user-defined description associated with the stack. User defined description associated with the resource. User defined description associated with the resource. A description of the stack set that you specify when the stack set is created or updated. A description of the stack set that you specify when the stack set is created or updated. User defined description associated with the parameter. A brief description of updates that you are making. The description found within the template. The name of exported output value. Use this name and the The name of the exported output value. AWS CloudFormation returns the stack names that are importing this value. The name of the exported output value. AWS CloudFormation returns the stack names that are importing this value. The name of the export associated with the output. The output for the ListExports action. The number of accounts, per region, for which this operation can fail before AWS CloudFormation stops the operation in that region. If the operation is stopped in a region, AWS CloudFormation doesn't attempt the operation in any subsequent regions. Conditional: You must specify either The percentage of accounts, per region, for which this stack operation can fail before AWS CloudFormation stops the operation in that region. If the operation is stopped in a region, AWS CloudFormation doesn't attempt the operation in any subsequent regions. When calculating the number of accounts based on the specified percentage, AWS CloudFormation rounds down to the next whole number. Conditional: You must specify either The input for the GetStackPolicy action. The template contains resources with capabilities that were not specified in the Capabilities parameter. The template contains resources with capabilities that weren't specified in the Capabilities parameter. The specified change set cannot be used to update the stack. For example, the change set status might be The specified change set can't be used to update the stack. For example, the change set status might be The specified operation isn't valid. Quota for the resource has already been reached. The quota for the resource has already been reached. The input for the ListStackResource action. The input for ListStacks action. The logical name of the resource specified in the template. The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of Conditional: You must specify either The maximum percentage of accounts in which to perform this operation at one time. When calculating the number of accounts based on the specified percentage, AWS CloudFormation rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, CloudFormation sets the number as one instead. Conditional: You must specify either The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a The content of the The specified name is already in use. If the output exceeds 100 exported output values, a string that identifies the next page of exports. If there is no additional page, this value is null. A string (provided by the ListImports response output) that identifies the next page of stacks that are importing the specified exported output value. A string that identifies the next page of exports. If there is no additional page, this value is null. If the previous request didn't return all of the remaining results, the response's If the request doesn't return all of the remaining results, A string that identifies the next page of stack resources that you want to retrieve. If the output exceeds 1 MB, a string that identifies the next page of stack resources. If no additional page exists, this value is null. If the previous request didn't return all of the remaining results, the response object's If the request doesn't return all results, If the previous paginated request didn't return all of the remaining results, the response object's If the request doesn't return all results, If the previous paginated request didn't return all of the remaining results, the response object's If the request doesn't return all of the remaining results, A string that identifies the next page of stacks that you want to retrieve. If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If no additional page exists, this value is null. Determines what action will be taken if stack creation fails. This must be one of: DO_NOTHING, ROLLBACK, or DELETE. You can specify either Default: The specified operation ID already exists. Another operation is currently in progress for this stack set. Only one operation can be performed for a stack set at a given time. The specified ID refers to an operation that doesn't exist. The Output data type. A list of A list of The input parameters for the stack set template. A list of A list of A list of A list of A list of input parameters for a stack set. A list of A list of input parameters for the stack set template. If the The explanation for the specific status code that is assigned to this stack instance. The explanation for the specific status code assigned to this stack instance. The reason for the assigned result status. The name of a region that's associated with this stack instance. The name of the region where you want to list stack instances. The name of the AWS region that the stack instance is associated with. The name of the AWS region that the stack instance is associated with. The name of the AWS region for this operation result. The names of one or more regions where you want to create stack instances using the specified AWS account(s). The regions where you want to delete stack set instances. The order of the regions in where you want to perform the stack operation. A list of the logical IDs of the resources that AWS CloudFormation skips during the continue update rollback operation. You can specify only resources that are in the Specify this property to skip rolling back resources that AWS CloudFormation can't successfully roll back. We recommend that you troubleshoot resources before skipping them. AWS CloudFormation sets the status of the specified resources to Specify the minimum number of resources required to successfully roll back your stack. For example, a failed resource update might cause dependent resources to fail. In this case, it might not be necessary to skip the dependent resources. To specify resources in a nested stack, use the following format: A list of the logical IDs of the resources that AWS CloudFormation skips during the continue update rollback operation. You can specify only resources that are in the Specify this property to skip rolling back resources that AWS CloudFormation can't successfully roll back. We recommend that you troubleshoot resources before skipping them. AWS CloudFormation sets the status of the specified resources to Specify the minimum number of resources required to successfully roll back your stack. For example, a failed resource update might cause dependent resources to fail. In this case, it might not be necessary to skip the dependent resources. To skip resources that are part of nested stacks, use the following format: Don't confuse a child stack's name with its corresponding logical ID defined in the parent stack. For an example of a continue update rollback operation with nested stacks, see Using ResourcesToSkip to recover a nested stacks hierarchy. For stacks in the Retaining resources is useful when you cannot delete a resource, such as a non-empty S3 bucket, but you want to delete the stack. Removes the stack instances from the specified stack set, but doesn't delete the stacks. You can't reassociate a retained stack or add an existing, saved stack to a new stack set. For stack set operations of action type The stack that contains the exported output name and value. Unique identifier of the stack. The unique ID name of the instance of the stack. The ID of the stack instance. The ID of the stack instance. Unique identifier of the stack. Unique identifier of the stack. Unique stack identifier. Unique identifier of the stack. An AWS CloudFormation stack, in a specific account and region, that's part of a stack set operation. A stack instance is a reference to an attempted or actual stack in a given account within a given region. A stack instance can exist without a stack—for example, if the stack couldn't be created for some reason. A stack instance is associated with only one stack set. Each stack instance contains the ID of its associated stack set, as well as the ID of the actual stack and the stack status. The stack instance that matches the specified request parameters. The specified stack instance doesn't exist. The status of the stack instance, in terms of its synchronization with its associated stack set. The associated stack failed during a The stack was part of a The status of the stack instance, in terms of its synchronization with its associated stack set. The associated stack failed during a The stack was part of a A list of The structure that contains summary information about a stack instance. A list of A structure that contains information about a stack set. A stack set enables you to provision stacks into AWS accounts and across regions by using a single CloudFormation template. In the stack set, you specify the template to use, as well as any parameters and capabilities that the template requires. The specified stack set. The ID of the stack set that you're creating. The name or unique ID of the stack set that the stack instance is associated with. The name or unique ID of the stack set that the stack instance is associated with. The ID of the stack set. The ID of the stack set. The ID of the stack set. The name or unique ID of the stack set that you want to create stack instances from. The name to associate with the stack set. The name must be unique in the region where you create your stack set. A stack name can contain only alphanumeric characters (case-sensitive) and hyphens. It must start with an alphabetic character and can't be longer than 128 characters. The name or unique ID of the stack set that you want to delete stack instances for. The name or unique ID of the stack set that you're deleting. You can obtain this value by running ListStackSets. The name or the unique stack ID of the stack set that you want to get stack instance information for. The name or unique ID of the stack set whose description you want. The name or the unique stack ID of the stack set for the stack operation. The name or unique ID of the stack set that you want to list stack instances for. The name or unique ID of the stack set that you want to get operation results for. The name or unique ID of the stack set that you want to get operation summaries for. The name that's associated with the stack set. The name of the stack set. The name or unique ID of the stack set that you want to stop the operation for. The name or unique ID of the stack set that you want to update. The name or unique ID of the stack set from which the stack was created. You can't yet delete this stack set, because it still contains one or more stack instances. Delete all stack instances from the stack set before deleting the stack set. The specified stack set doesn't exist. The structure that contains information about a stack set operation. The specified stack set operation. The type of stack set operation: The type of operation: The user-specified preferences for how AWS CloudFormation performs a stack set operation. Preferences for how AWS CloudFormation performs this stack set operation. Preferences for how AWS CloudFormation performs this stack set operation. The preferences for how AWS CloudFormation performs this stack set operation. Preferences for how AWS CloudFormation performs this stack set operation. The result status of the stack set operation for the given account in the given region. If the stack set operation fails in enough accounts within a region, the failure tolerance for the stack set operation as a whole might be exceeded. A list of The structure that contains information about a specified operation's results for a given account in a given region. The status of the operation. The overall status of the operation. A list of The structures that contain summary information about the specified operation. The status of the stack sets that you want to get summary information about. The status of the stack set. The status of the stack set. A list of The structures that contain summary information about the specified stack set. The stage of the template that you can retrieve. For stacks, the Another operation has been performed on this stack set since the specified operation was performed. The Tag type enables you to specify a key-value pair that can be used to store information about an AWS CloudFormation stack. Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to resources in the stack. You can specify a maximum of 10 tags. Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to the resources created in the stack. A maximum number of 10 tags can be specified. Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to resources in the stack. You can specify a maximum of 50 tags. Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to the resources created in the stack. A maximum number of 50 tags can be specified. The key-value pairs to associate with this stack set and the stacks created from it. AWS CloudFormation also propagates these tags to supported resources that are created in the stacks. A maximum number of 50 tags can be specified. If you specify tags as part of a If you execute the change set, the tags that will be associated with the stack. A list of Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to supported resources in the stack. You can specify a maximum number of 10 tags. If you don't specify this parameter, AWS CloudFormation doesn't modify the stack's tags. If you specify an empty value, AWS CloudFormation removes all associated tags. A list of tags that specify information about the stack set. A maximum number of 50 tags can be specified. Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to supported resources in the stack. You can specify a maximum number of 50 tags. If you don't specify this parameter, AWS CloudFormation doesn't modify the stack's tags. If you specify an empty value, AWS CloudFormation removes all associated tags. The key-value pairs to associate with this stack set and the stacks created from it. AWS CloudFormation also propagates these tags to supported resources that are created in the stacks. You can specify a maximum number of 50 tags. If you specify tags for this parameter, those tags replace any list of tags that are currently associated with this stack set. This means: If you don't specify this parameter, AWS CloudFormation doesn't modify the stack's tags. If you specify any tags using this parameter, you must specify all the tags that you want associated with this stack set, even tags you've specifed before (for example, when creating the stack set or during a previous update of the stack set.). Any tags that you don't include in the updated list of tags are removed from the stack set, and therefore from the stacks and resources as well. If you specify an empty value, AWS CloudFormation removes all currently associated tags. If you specify new tags as part of an A structure that contains the body of the revised template, with a minimum length of 1 byte and a maximum length of 51,200 bytes. AWS CloudFormation generates the change set by comparing this template with the template of the stack that you specified. Conditional: You must specify only Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, go to Template Anatomy in the AWS CloudFormation User Guide. Conditional: You must specify either the The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, see Template Anatomy in the AWS CloudFormation User Guide. Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both. Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. (For more information, go to Template Anatomy in the AWS CloudFormation User Guide.) Conditional: You must pass Structure containing the template body. (For more information, go to Template Anatomy in the AWS CloudFormation User Guide.) AWS CloudFormation returns the same template that was used when the stack was created. Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information about templates, see Template Anatomy in the AWS CloudFormation User Guide. Conditional: You must specify only one of the following parameters: The structure that contains the body of the template that was used to create or update the stack set. Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. (For more information, go to Template Anatomy in the AWS CloudFormation User Guide.) Conditional: You must specify only one of the following parameters: The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, see Template Anatomy in the AWS CloudFormation User Guide. Conditional: You must specify only one of the following parameters: Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, go to Template Anatomy in the AWS CloudFormation User Guide. Conditional: You must pass The location of the file that contains the revised template. The URL must point to a template (max size: 460,800 bytes) that is located in an S3 bucket. AWS CloudFormation generates the change set by comparing this template with the stack that you specified. Conditional: You must specify only Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information, go to the Template Anatomy in the AWS CloudFormation User Guide. Conditional: You must specify either the The location of the file that contains the template body. The URL must point to a template (maximum size: 460,800 bytes) that's located in an Amazon S3 bucket. For more information, see Template Anatomy in the AWS CloudFormation User Guide. Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both. Location of file containing the template body. The URL must point to a template that is located in an Amazon S3 bucket. For more information, go to Template Anatomy in the AWS CloudFormation User Guide. Conditional: You must pass Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information about templates, see Template Anatomy in the AWS CloudFormation User Guide. Conditional: You must specify only one of the following parameters: Location of file containing the template body. The URL must point to a template that is located in an Amazon S3 bucket. For more information, go to Template Anatomy in the AWS CloudFormation User Guide. Conditional: You must specify only one of the following parameters: The location of the file that contains the template body. The URL must point to a template (maximum size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information, see Template Anatomy in the AWS CloudFormation User Guide. Conditional: You must specify only one of the following parameters: Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information, go to Template Anatomy in the AWS CloudFormation User Guide. Conditional: You must pass Time the status was updated. Time the status was updated. Time the status was updated. Time the status was updated. Time the status was updated. The time at which the operation was initiated. Note that the creation times for the stack set operation might differ from the creation time of the individual stacks themselves. This is because AWS CloudFormation needs to perform preparatory work for the operation, such as dispatching the work to the requested regions, before actually creating the first stacks. The time at which the stack set operation ended, across all accounts and regions specified. Note that this doesn't necessarily mean that the stack set operation was successful, or even attempted, in each account or region. The time at which the operation was initiated. Note that the creation times for the stack set operation might differ from the creation time of the individual stacks themselves. This is because AWS CloudFormation needs to perform preparatory work for the operation, such as dispatching the work to the requested regions, before actually creating the first stacks. The time at which the stack set operation ended, across all accounts and regions specified. Note that this doesn't necessarily mean that the stack set operation was successful, or even attempted, in each account or region. Whether to reuse the template that is associated with the stack to create the change set. Reuse the existing template that is associated with the stack that you are updating. Conditional: You must specify only one of the following parameters: Reuse the existing template that is associated with the stack that you are updating. Conditional: You must specify only one of the following parameters: Use the existing template that's associated with the stack set that you're updating. Conditional: You must specify only one of the following parameters: Contains the parameters for CreateNetworkInterfacePermission. Contains the output of CreateNetworkInterfacePermission. Contains the parameters for DeleteNetworkInterfacePermission. Contains the output for DeleteNetworkInterfacePermission. Contains the parameters for DescribeNetworkInterfacePermissions. Contains the output for DescribeNetworkInterfacePermissions. The type of resource. Currently, the only resource type that is supported is The resource type. The type of resource to tag. Currently, the resource types that support tagging on creation are Information about the configuration of your Spot fleet. The tags for a Spot fleet resource. The tags to apply during creation. Describes a Spot instance request. Any tags assigned to the route table. Any tags assigned to the security group. Any tags assigned to the snapshot. The tags. Any tags assigned to the resource. Any tags assigned to the subnet. The tags to apply to the resource. Provides the status of all clusters visible to this AWS account. Allows you to filter the list of clusters based on certain criteria; for example, filtering by cluster creation date and time or by status. This call returns a maximum of 50 clusters per call, but returns a marker to track the paging of the cluster list across multiple ListClusters calls. Lists all available details about the instance fleets in a cluster. The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions. Provides all available details about the instance groups in a cluster. Provides information about the cluster instances that Amazon EMR provisions on behalf of a user when it creates the cluster. For example, this operation indicates when the EC2 instances reach the Ready state, when instances become available to Amazon EMR to use for jobs, and the IP addresses for cluster instances, etc. Provides information for all active EC2 instances and EC2 instances terminated in the last 30 days, up to a maximum of 2,000. EC2 instances in any of the following states are considered active: AWAITING_FULFILLMENT, PROVISIONING, BOOTSTRAPPING, RUNNING. Lists all the security configurations visible to this account, providing their creation dates and times, and their names. This call returns a maximum of 50 clusters per call, but returns a marker to track the paging of the cluster list across multiple ListSecurityConfigurations calls. Provides a list of steps for the cluster in reverse order unless you specify stepIds with the request. Modifies the target On-Demand and target Spot capacities for the instance fleet with the specified InstanceFleetID within the cluster specified using ClusterID. The call either succeeds or fails atomically. The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions. An application is any Amazon or third-party software that you can add to the cluster. This structure contains a list of strings that indicates the software to use with the cluster and accepts a user argument list. Amazon EMR accepts and forwards the argument list to the corresponding installation script as bootstrap action argument. For more information, see Using the MapR Distribution for Hadoop. Currently supported values are: \"mapr-m3\" - launch the cluster using MapR M3 Edition. \"mapr-m5\" - launch the cluster using MapR M5 Edition. \"mapr\" with the user arguments specifying \"--edition,m3\" or \"--edition,m5\" - launch the cluster using MapR M3 or M5 Edition, respectively. In Amazon EMR releases 4.0 and greater, the only accepted parameter is the application name. To pass arguments to applications, you supply a configuration for each application. An application is any Amazon or third-party software that you can add to the cluster. This structure contains a list of strings that indicates the software to use with the cluster and accepts a user argument list. Amazon EMR accepts and forwards the argument list to the corresponding installation script as bootstrap action argument. For more information, see Using the MapR Distribution for Hadoop. Currently supported values are: \"mapr-m3\" - launch the cluster using MapR M3 Edition. \"mapr-m5\" - launch the cluster using MapR M5 Edition. \"mapr\" with the user arguments specifying \"--edition,m3\" or \"--edition,m5\" - launch the cluster using MapR M3 or M5 Edition, respectively. In Amazon EMR releases 4.x and later, the only accepted parameter is the application name. To pass arguments to applications, you supply a configuration for each application. The applications installed on this cluster. Amazon EMR releases 4.x or later. A list of applications for the cluster. Valid values are: \"Hadoop\", \"Hive\", \"Mahout\", \"Pig\", and \"Spark.\" They are case insensitive. For Amazon EMR releases 4.0 and later. A list of applications for the cluster. Valid values are: \"Hadoop\", \"Hive\", \"Mahout\", \"Pig\", and \"Spark.\" They are case insensitive. Amazon EMR releases 4.x or later. The list of Configurations supplied to the EMR cluster. Applies only to Amazon EMR releases 4.x and later. The list of Configurations supplied to the EMR cluster. A list of additional configurations to apply within a configuration object. Amazon EMR releases 4.x or later. The list of configurations supplied for an EMR cluster instance group. You can specify a separate configuration for each instance group (master, core, and task). Amazon EMR releases 4.x or later. The list of configurations supplied for an EMR cluster instance group. You can specify a separate configuration for each instance group (master, core, and task). A configuration classification that applies when provisioning cluster instances, which can include configurations for applications and software that run on the cluster. A configuration classification that applies when provisioning cluster instances, which can include configurations for applications and software bundled with Amazon EMR. Amazon EMR releases 4.x or later. The list of configurations supplied for the EMR cluster you are creating. For Amazon EMR releases 4.0 and later. The list of configurations supplied for the EMR cluster you are creating. The number of periods, expressed in seconds using The period, in seconds, over which the statistic is applied. EMR CloudWatch metrics are emitted every five minutes (300 seconds), so if an EMR CloudWatch metric is specified, specify An approximation of the cost of the cluster, represented in m1.small/hours. This value is incremented one time for every hour an m1.small instance runs. Larger instances are weighted more, so an EC2 instance that is roughly four times more expensive would result in the normalized instance hours being incremented by four. This result is only an approximation and does not reflect the actual billing rate. The size, in GiB, of the EBS root device volume of the Linux AMI that is used for each EC2 instance. Available in Amazon EMR version 4.x and later. An approximation of the cost of the cluster, represented in m1.small/hours. This value is incremented one time for every hour an m1.small instance runs. Larger instances are weighted more, so an EC2 instance that is roughly four times more expensive would result in the normalized instance hours being incremented by four. This result is only an approximation and does not reflect the actual billing rate. Number of EBS volumes with a specific volume configuration that will be associated with every instance in the instance group The target number of instances for the instance group. The number of EC2 instances in the cluster. The number of Amazon EC2 instances in the cluster. If the value is 1, the same instance serves as both the master and slave node. If the value is greater than 1, one instance is the master node and all others are slave nodes. An approximation of the cost of the cluster, represented in m1.small/hours. This value is incremented one time for every hour that an m1.small runs. Larger instances are weighted more, so an Amazon EC2 instance that is roughly four times more expensive would result in the normalized instance hours being incremented by four. This result is only an approximation and does not reflect the actual billing rate. The size, in GiB, of the EBS root device volume of the Linux AMI that is used for each EC2 instance. Available in Amazon EMR version 4.x and later. The lower boundary of EC2 instances in an instance group below which scaling activities are not allowed to shrink. Scale-in activities will not terminate instances below this boundary. The upper boundary of EC2 instances in an instance group beyond which scaling activities are not allowed to grow. Scale-out activities will not add instances beyond this boundary. The desired timeout for decommissioning an instance. Overrides the default YARN decommissioning timeout. For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and greater, use Applications. A list of strings that indicates third-party software to use with the job flow that accepts a user argument list. EMR accepts and forwards the argument list to the corresponding installation script as bootstrap action arguments. For more information, see \"Launch a Job Flow on the MapR Distribution for Hadoop\" in the Amazon EMR Developer Guide. Supported values are: \"mapr-m3\" - launch the cluster using MapR M3 Edition. \"mapr-m5\" - launch the cluster using MapR M5 Edition. \"mapr\" with the user arguments specifying \"--edition,m3\" or \"--edition,m5\" - launch the job flow using MapR M3 or M5 Edition respectively. \"mapr-m7\" - launch the cluster using MapR M7 Edition. \"hunk\" - launch the cluster with the Hunk Big Data Analtics Platform. \"hue\"- launch the cluster with Hue installed. \"spark\" - launch the cluster with Apache Spark installed. \"ganglia\" - launch the cluster with the Ganglia Monitoring System installed. For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and later, use Applications. A list of strings that indicates third-party software to use with the job flow that accepts a user argument list. EMR accepts and forwards the argument list to the corresponding installation script as bootstrap action arguments. For more information, see \"Launch a Job Flow on the MapR Distribution for Hadoop\" in the Amazon EMR Developer Guide. Supported values are: \"mapr-m3\" - launch the cluster using MapR M3 Edition. \"mapr-m5\" - launch the cluster using MapR M5 Edition. \"mapr\" with the user arguments specifying \"--edition,m3\" or \"--edition,m5\" - launch the job flow using MapR M3 or M5 Edition respectively. \"mapr-m7\" - launch the cluster using MapR M7 Edition. \"hunk\" - launch the cluster with the Hunk Big Data Analtics Platform. \"hue\"- launch the cluster with Hue installed. \"spark\" - launch the cluster with Apache Spark installed. \"ganglia\" - launch the cluster with the Ganglia Monitoring System installed. The value against which the specified statistic is compared. The bid price, as a percentage of On-Demand price, for each EC2 Spot instance as defined by The bid price, as a percentage of On-Demand price, for each EC2 Spot instance as defined by The bid price, as a percentage of On-Demand price, for each EC2 Spot instance as defined by Applies only when Applies only when The action to take when The action to take when The path to the Amazon S3 location where logs for this cluster are stored. The AMI version requested for this cluster. The AMI version running on this cluster. The release label for the Amazon EMR release. For Amazon EMR 3.x and 2.x AMIs, use amiVersion instead instead of ReleaseLabel. The release label for the Amazon EMR release. The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf. The public DNS name of the master EC2 instance. The descriptive message for the state change reason. A list of strings set by third party software when the job flow is launched. If you are not using third party software to manage the job flow this value is empty. For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and greater, use Applications. A list of strings that indicates third-party software to use. For more information, see Use Third Party Applications with Amazon EMR. Currently supported values are: \"mapr-m3\" - launch the job flow using MapR M3 Edition. \"mapr-m5\" - launch the job flow using MapR M5 Edition. For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and later, use Applications. A list of strings that indicates third-party software to use. For more information, see Use Third Party Applications with Amazon EMR. Currently supported values are: \"mapr-m3\" - launch the job flow using MapR M3 Edition. \"mapr-m5\" - launch the job flow using MapR M5 Edition. The target capacity of Spot units for the instance fleet, which determines how many Spot instances to provision. When the instance fleet launches, Amazon EMR tries to provision Spot instances as specified by InstanceTypeConfig. Each instance configuration has a specified If not specified or set to 0, only On-Demand instances are provisioned for the instance fleet. At least one of The target capacity of On-Demand units for the instance fleet. For more information see InstanceFleetConfig$TargetOnDemandCapacity. The target capacity of Spot units for the instance fleet. For more information, see InstanceFleetConfig$TargetSpotCapacity. The number of units that a provisioned instance of this type provides toward fulfilling the target capacities defined in InstanceFleetConfig. This value is 1 for a master instance fleet, and must be greater than 0 for core and task instance fleets. The number of units that a provisioned instance of this type provides toward fulfilling the target capacities defined in InstanceFleetConfig. This value is 1 for a master instance fleet, and must be 1 or greater for core and task instance fleets. Defaults to 1 if not specified. The number of units that a provisioned instance of this type provides toward fulfilling the target capacities defined in InstanceFleetConfig. Capacity values represent performance characteristics such as vCPUs, memory, or I/O. If not specified, the default value is 1. The spot provisioning timeout period in minutes. If Spot instances are not provisioned within this time period, the The defined duration for Spot instances (also known as Spot blocks) in minutes. When specified, the Spot instance does not terminate before the defined duration expires, and defined duration pricing for Spot instances applies. Valid values are 60, 120, 180, 240, 300, or 360. The duration period starts as soon as a Spot instance receives its instance ID. At the end of the duration, Amazon EC2 marks the Spot instance for termination and provides a Spot instance termination notice, which gives the instance a two-minute warning before it terminates. A string that uniquely identifies the job flow. This identifier is returned by RunJobFlow and can also be obtained from ListClusters. The name of the bootstrap action. The Available only in Amazon EMR version 5.7.0 and later. The ID of a custom Amazon EBS-backed Linux AMI if the cluster uses a custom AMI. A friendly name for the instance fleet. The friendly name of the instance fleet. Friendly name given to the instance group. The bid price for each EC2 Spot instance type as defined by The job flow identifier. The name of the job flow. The version of the AMI used to initialize Amazon EC2 instances in the job flow. For a list of AMI versions currently supported by Amazon EMR, see AMI Versions Supported in EMR in the Amazon EMR Developer Guide. Used only for version 2.x and 3.x of Amazon EMR. The version of the AMI used to initialize Amazon EC2 instances in the job flow. For a list of AMI versions supported by Amazon EMR, see AMI Versions Supported in EMR in the Amazon EMR Developer Guide. The name of the EC2 key pair that can be used to ssh to the master node as the user called \"hadoop.\" The Hadoop version for the cluster. Valid inputs are \"0.18\" (deprecated), \"0.20\" (deprecated), \"0.20.205\" (deprecated), \"1.0.3\", \"2.2.0\", or \"2.4.0\". If you do not set this value, the default of 0.18 is used, unless the AmiVersion parameter is set in the RunJobFlow call, in which case the default version of Hadoop for that AMI version is used. Applies to clusters that use the uniform instance group configuration. To launch the cluster in Amazon Virtual Private Cloud (Amazon VPC), set this parameter to the identifier of the Amazon VPC subnet where you want the cluster to launch. If you do not specify this value, the cluster launches in the normal Amazon Web Services cloud, outside of an Amazon VPC, if the account launching the cluster supports EC2 Classic networks in the region where the cluster launches. Amazon VPC currently does not support cluster compute quadruple extra large (cc1.4xlarge) instances. Thus you cannot specify the cc1.4xlarge instance type for clusters launched in an Amazon VPC. For clusters launched within Amazon Virtual Private Cloud, this is the identifier of the subnet where the cluster was launched. The Hadoop version for the cluster. The name of the job flow. For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and greater, use ReleaseLabel. The version of the Amazon Machine Image (AMI) to use when launching Amazon EC2 instances in the job flow. The following values are valid: The version number of the AMI to use, for example, \"2.0.\" If the AMI supports multiple versions of Hadoop (for example, AMI 1.0 supports both Hadoop 0.18 and 0.20) you can use the JobFlowInstancesConfig For details about the AMI versions currently supported by Amazon Elastic MapReduce, see AMI Versions Supported in Elastic MapReduce in the Amazon Elastic MapReduce Developer Guide. Previously, the EMR AMI version API parameter options allowed you to use latest for the latest AMI version rather than specify a numerical value. Some regions no longer support this deprecated option as they only have a newer release label version of EMR, which requires you to specify an EMR release label release (EMR 4.x or later). Amazon EMR releases 4.x or later. The release label for the Amazon EMR release. For Amazon EMR 3.x and 2.x AMIs, use amiVersion instead instead of ReleaseLabel. For Amazon EMR AMI versions 3.x and 2.x. For Amazon EMR releases 4.0 and later, the Linux AMI is determined by the If the AMI supports multiple versions of Hadoop (for example, AMI 1.0 supports both Hadoop 0.18 and 0.20), you can use the JobFlowInstancesConfig Previously, the EMR AMI version API parameter options allowed you to use latest for the latest AMI version rather than specify a numerical value. Some regions no longer support this deprecated option as they only have a newer release label version of EMR, which requires you to specify an EMR release label release (EMR 4.x or later). The release label for the Amazon EMR release. For Amazon EMR 3.x and 2.x AMIs, use Available only in Amazon EMR version 5.7.0 and later. The ID of a custom Amazon EBS-backed Linux AMI. If specified, Amazon EMR uses this AMI when it launches cluster EC2 instances. For more information about custom AMIs in Amazon EMR, see Using a Custom AMI in the Amazon EMR Management Guide. If omitted, the cluster uses the base Linux AMI for the For information about creating a custom AMI, see Creating an Amazon EBS-Backed Linux AMI in the Amazon Elastic Compute Cloud User Guide for Linux Instances. For information about finding an AMI ID, see Finding a Linux AMI. An unique identifier for the job flow. The name of the step. Applies to clusters configured with the instance fleets option. Specifies the unique identifier of one or more Amazon EC2 subnets in which to launch EC2 cluster instances. Amazon EMR chooses the EC2 subnet with the best performance and cost characteristics from among the list of RequestedEc2SubnetIds and launches all cluster instances within that subnet. If this value is not specified, and the account supports EC2-Classic networks, the cluster launches instances in the EC2-Classic network and uses Requested Applies to clusters configured with the The list of availability zones to choose from. The service will choose the availability zone with the best mix of available capacity and lowest cost to launch the cluster. If you do not specify this value, the cluster is launched in any availability zone that the customer account has access to. Applies to clusters configured with the instance fleets option. Specifies the unique identifier of one or more Amazon EC2 subnets in which to launch EC2 cluster instances. Subnets must exist within the same VPC. Amazon EMR chooses the EC2 subnet with the best fit from among the list of Applies to clusters configured with the instance fleets option. Specifies one or more Availability Zones in which to launch EC2 cluster instances when the EC2-Classic network configuration is supported. Amazon EMR chooses the Availability Zone with the best fit from among the list of Applies to clusters that use the instance fleet configuration. When multiple EC2 subnet IDs are specified, Amazon EMR evaluates them and launches instances in the optimal subnet. The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions. When multiple Availability Zones are specified, Amazon EMR evaluates them and launches instances in the optimal Availability Zone. The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.
+nextToken parameter in a subsequent call to this operation to retrieve the next set of items. If an authentication type is not provided, the operation defaults to users authenticated using a streaming URL.nextToken value in a subsequent call to this operation to retrieve the next set of items.nextToken parameter in a subsequent call to this operation. If an authentication type is not provided, the operation defaults to users authenticated using a streaming URL.nextToken value in a subsequent call to this operation.DisplayName and ComputeCapacity can be updated. A fleet cannot be updated in a status of STARTING or STOPPING.
",
"CreateStackRequest$Name": "
",
"UpdateStackRequest$Name": "AttachObject operation.AttachObject response operation.CreateObject operation.CreateObject response operation.DeleteObject operation.DeleteObject response operation.DetachObject operation.DetachObject response operation.ListObjectAttributes operation.ListObjectAttributes response operation.ListObjectChildren operation.ListObjectChildren response operation.ObjectIdentifiers to which a given policy is attached inside a BatchRead operation. For more information, see ListPolicyAttachments and BatchReadRequest$Operations.ObjectIdentifiers to which a given policy is attached.ObjectIdentifiers to which a given policy is attached.ObjectIdentifier for such objects. If policies are present, it returns ObjectIdentifier, policyId, and policyType. Paths that don't lead to the root from the target object are ignored. For more information, see Policies.ObjectIdentifier for such objects. If policies are present, it returns ObjectIdentifier, policyId, and policyType. Paths that don't lead to the root from the target object are ignored. For more information, see Policies.ObjectIdentifier, which is the child ObjectIdentifier.ObjectIdentifier of the object that was attached to the index.ObjectIdentifier of the object that has been attached.ObjectIdentifier of the object that was attached to the index.ObjectIdentifier of the index created by this operation.ObjectIdentifier of the object that was detached from the index.ObjectIdentifier of the detached object.ObjectIdentifier of the specified object.ObjectIdentifier of the index created by this operation.ObjectIdentifiers, that are attached to the object.ObjectIdentifiers to which the policy is attached.ObjectIdentifiers, that are attached to the object.ObjectIdentifiers to which the policy is attached.ObjectIdentifiers starting from directory root to the object in the request.ObjectIdentifiers that are associated with the directory.ObjectIdentifiers that are associated with the directory.PolicyId, ObjectIdentifier, and PolicyType. For more information, see Policies.PolicyId, ObjectIdentifier, and PolicyType. For more information, see Policies.FacetArns that will be associated with the object. For more information, see arns.SchemaArn and facet name. For more information, see arns.
",
"operations": {
"CancelUpdateStack": "UPDATE_ROLLBACK_FAILED state, continues rolling it back to the UPDATE_ROLLBACK_COMPLETE state. Depending on the cause of the failure, you can manually fix the error and continue the rollback. By continuing the rollback, you can return your stack to a working state (the UPDATE_ROLLBACK_COMPLETE state), and then try to update the stack again.UPDATE_ROLLBACK_FAILED state when AWS CloudFormation cannot roll back all changes after a failed stack update. For example, you might have a stack that is rolling back to an old database instance that was deleted outside of AWS CloudFormation. Because AWS CloudFormation doesn't know the database was deleted, it assumes that the database instance still exists and attempts to roll back to it, causing the update rollback to fail.ChangeSetType parameter, specify CREATE. To create a change set for an existing stack, specify UPDATE for the ChangeSetType parameter. After the CreateChangeSet call successfully completes, AWS CloudFormation starts creating the change set. To check the status of the change set or to review it, use the DescribeChangeSet action.Accounts and Regions are required parameters—you must specify at least one account and one region. StackName is specified, all the associated resources that are part of the stack are returned. If PhysicalResourceId is specified, the associated resources of the stack that the resource belongs to are returned.ListStackResources instead.DescribeStackResources returns resource information for up to 90 days after the stack has been deleted.StackName or PhysicalResourceId, but not both. In addition, you can specify LogicalResourceId to filter the returned result. For more information about resources, the LogicalResourceId and PhysicalResourceId, go to the AWS CloudFormation User Guide.ValidationError is returned if you specify both StackName and PhysicalResourceId in the same request.AmazonCloudFormationException is returned.CREATE_IN_PROGRESS or CREATE_PENDING state.Fn::ImportValue function. Fn::ImportValue function.
"
+ }
+ },
+ "AccountGateStatusReason": {
+ "base": null,
+ "refs": {
+ "AccountGateResult$StatusReason": "SUCCEEDED: The account gate function has determined that the account passes any requirements for stack set operations to occur. AWS CloudFormation proceeds with stack operations in the account. FAILED: The account gate function has determined that the account does not meet the requirements for stack set operations to occur. AWS CloudFormation cancels the stack set operations in that account, and the stack set operation status is set to FAILED.SKIPPED: An account gate function has not been specified for the account, or the AWSCloudFormationStackSetExecutionRole of the stack set adminstration account lacks permissions to invoke the function. AWS CloudFormation proceeds with stack set operations in the account. CAPABILITY_IAM and CAPABILITY_NAMED_IAM. The following resources require you to specify this parameter: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, and AWS::IAM::UserToGroupAddition. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.CAPABILITY_NAMED_IAM. If you don't specify this parameter, this action returns an InsufficientCapabilities error.CAPABILITY_IAM and CAPABILITY_NAMED_IAM. The following resources require you to specify this parameter: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, and AWS::IAM::UserToGroupAddition. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.CAPABILITY_NAMED_IAM. If you don't specify this parameter, this action returns an InsufficientCapabilities error.
InsufficientCapabilities error.CAPABILITY_IAM and CAPABILITY_NAMED_IAM. The following resources require you to specify this parameter: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, and AWS::IAM::UserToGroupAddition. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.CAPABILITY_NAMED_IAM. If you don't specify this parameter, this action returns an InsufficientCapabilities error.
InsufficientCapabilities error.CancelUpdateStack request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to cancel an update on a stack with the same name. You might retry CancelUpdateStack requests to ensure that AWS CloudFormation successfully received them.ContinueUpdateRollback request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to continue the rollback to a stack with the same name. You might retry ContinueUpdateRollback requests to ensure that AWS CloudFormation successfully received them.CreateStack request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to create a stack with the same name. You might retry CreateStack requests to ensure that AWS CloudFormation successfully received them.DeleteStack request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to delete a stack with the same name. You might retry DeleteStack requests to ensure that AWS CloudFormation successfully received them.CreateStack request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to create a stack with the same name. You might retry CreateStack requests to ensure that AWS CloudFormation successfully received them.CreateStack operation with the token token1, then all the StackEvents generated by that operation will have ClientRequestToken set as token1.Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002. OUTDATED. CreateStackSet request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to create another stack set with the same name. You might retry CreateStackSet requests to ensure that AWS CloudFormation successfully received them.DeleteStack request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to delete a stack with the same name. You might retry DeleteStack requests to ensure that AWS CloudFormation successfully received them.CreateStack operation with the token token1, then all the StackEvents generated by that operation will have ClientRequestToken set as token1.Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002. OUTDATED. ExecuteChangeSet request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to execute a change set to update a stack with the same name. You might retry ExecuteChangeSet requests to ensure that AWS CloudFormation successfully received them.CreateStack operation with the token token1, then all the StackEvents generated by that operation will have ClientRequestToken set as token1.UpdateStack request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to update a stack with the same name. You might retry UpdateStack requests to ensure that AWS CloudFormation successfully received them.CreateStack operation with the token token1, then all the StackEvents generated by that operation will have ClientRequestToken set as token1.Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002. UpdateStack request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to update a stack with the same name. You might retry UpdateStack requests to ensure that AWS CloudFormation successfully received them.CreateStack operation with the token token1, then all the StackEvents generated by that operation will have ClientRequestToken set as token1.Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002. OUTDATED. Description property of the template.Fn::ImportValue function to import the associated value into other stacks. The name is defined in the Export field in the associated stack's Outputs section.FailureToleranceCount or FailureTolerancePercentage (but not both).FailureToleranceCount or FailureTolerancePercentage, but not both.CREATE_IN_PROGRESS or the stack status might be UPDATE_IN_PROGRESS.CREATE_IN_PROGRESS, or the stack status might be UPDATE_IN_PROGRESS.FailureToleranceCount—MaxConcurrentCount is at most one more than the FailureToleranceCount .MaxConcurrentCount or MaxConcurrentPercentage, but not both.MaxConcurrentCount or MaxConcurrentPercentage, but not both.NextToken value that you can assign to the NextToken request parameter to get the next set of results.NextToken value that you can assign to the NextToken request parameter to get the next set of results.NextToken value that you can assign to the NextToken request parameter to get the next set of results.NextToken value that you can assign to the NextToken request parameter to get the next set of results.Metadata attribute declared for the resource. For more information, see Metadata Attribute in the AWS CloudFormation User Guide.NextToken parameter value is set to a token. To retrieve the next set of results, call ListStackInstances again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.NextToken is set to a token. To retrieve the next set of results, call ListStackInstances again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null.NextToken parameter value is set to a token. To retrieve the next set of results, call ListStackSetOperationResults again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.NextToken is set to a token. To retrieve the next set of results, call ListOperationResults again and assign that token to the request object's NextToken parameter. If there are no remaining results, NextToken is set to null.NextToken parameter value is set to a token. To retrieve the next set of results, call ListStackSetOperations again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.NextToken is set to a token. To retrieve the next set of results, call ListOperationResults again and assign that token to the request object's NextToken parameter. If there are no remaining results, NextToken is set to null.NextToken parameter value is set to a token. To retrieve the next set of results, call ListStackSets again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.NextToken is set to a token. To retrieve the next set of results, call ListStackInstances again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null.OnFailure or DisableRollback, but not both.ROLLBACK Parameter structures that specify input parameters for the change set. For more information, see the Parameter data type.Parameter structures that specify input parameters for the stack. For more information, see the Parameter data type.Parameter structures that describes the input parameters and their values used to create the change set. For more information, see the Parameter data type.Parameter structures that specify input parameters.Parameter structures.Parameter structures that specify input parameters for the stack. For more information, see the Parameter data type.Parameter structures that specify input parameters for the stack. For more information, see the Parameter data type.Attribute value is Properties, the name of the property. For all other attributes, the value is null.UPDATE_FAILED state because a rollback failed. You can't specify resources that are in the UPDATE_FAILED state for other reasons, for example, because an update was canceled. To check why a resource update failed, use the DescribeStackResources action, and view the resource status reason. UPDATE_COMPLETE and continues to roll back the stack. After the rollback is complete, the state of the skipped resources will be inconsistent with the state of the resources in the stack template. Before performing another stack update, you must update the stack or resources to be consistent with each other. If you don't, subsequent stack updates might fail, and the stack will become unrecoverable. NestedStackName.ResourceLogicalID. If the ResourceLogicalID is a stack resource (Type: AWS::CloudFormation::Stack), it must be in one of the following states: DELETE_IN_PROGRESS, DELETE_COMPLETE, or DELETE_FAILED. UPDATE_FAILED state because a rollback failed. You can't specify resources that are in the UPDATE_FAILED state for other reasons, for example, because an update was cancelled. To check why a resource update failed, use the DescribeStackResources action, and view the resource status reason. UPDATE_COMPLETE and continues to roll back the stack. After the rollback is complete, the state of the skipped resources will be inconsistent with the state of the resources in the stack template. Before performing another stack update, you must update the stack or resources to be consistent with each other. If you don't, subsequent stack updates might fail, and the stack will become unrecoverable. NestedStackName.ResourceLogicalID. If you want to specify the logical ID of a stack resource (Type: AWS::CloudFormation::Stack) in the ResourcesToSkip list, then its corresponding embedded stack must be in one of the following states: DELETE_IN_PROGRESS, DELETE_COMPLETE, or DELETE_FAILED. DELETE_FAILED state, a list of resource logical IDs that are associated with the resources you want to retain. During deletion, AWS CloudFormation deletes the stack but does not delete the retained resources.DELETE, specifies whether to remove the stack instances from the specified stack set, but doesn't delete the stacks. You can't reassociate a retained stack, or add an existing, saved stack to a new stack set.
",
+ "StackInstanceSummary$Status": "INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an unstable state. Stacks in this state are excluded from further UpdateStackSet and DeleteStackInstances operations. You might need to clean up the stack manually.OUTDATED: The stack isn't currently up to date with the stack set because:
CreateStackSet or UpdateStackSet operation. CreateStackSet or UpdateStackSet operation that failed or was stopped before the stack was created or updated. CURRENT: The stack is currently up to date with the stack set.
"
+ }
+ },
+ "StackInstanceSummaries": {
+ "base": null,
+ "refs": {
+ "ListStackInstancesOutput$Summaries": "INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an unstable state. Stacks in this state are excluded from further UpdateStackSet and DeleteStackInstances operations. You might need to clean up the stack manually.OUTDATED: The stack isn't currently up to date with the stack set because:
CreateStackSet or UpdateStackSet operation. CreateStackSet or UpdateStackSet operation that failed or was stopped before the stack was created or updated. CURRENT: The stack is currently up to date with the stack set.StackInstanceSummary structures that contain information about the specified stack instances.StackResource structures.CREATE, UPDATE, or DELETE. Create and delete operations affect only the specified stack set instances that are associated with the specified stack set. Update operations affect both the stack set itself, as well as all associated stack set instances.CREATE, UPDATE, or DELETE. Create and delete operations affect only the specified stack instances that are associated with the specified stack set. Update operations affect both the stack set itself as well as all associated stack set instances.
"
+ }
+ },
+ "StackSetOperationResultSummaries": {
+ "base": null,
+ "refs": {
+ "ListStackSetOperationResultsOutput$Summaries": "CANCELLED: The operation in the specified account and region has been cancelled. This is either because a user has stopped the stack set operation, or because the failure tolerance of the stack set operation has been exceeded.FAILED: The operation in the specified account and region failed. RUNNING: The operation in the specified account and region is currently in progress.PENDING: The operation in the specified account and region has yet to start. SUCCEEDED: The operation in the specified account and region completed successfully.StackSetOperationResultSummary structures that contain information about the specified operation results, for accounts and regions that are included in the operation.
",
+ "StackSetOperationSummary$Status": "FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that you've set for an operation is applied for each region during stack create and update operations. If the number of failed stacks within a region exceeds the failure tolerance, the status of the operation in the region is set to FAILED. This in turn sets the status of the operation as a whole to FAILED, and AWS CloudFormation cancels the operation in any remaining regions.RUNNING: The operation is currently being performed.STOPPED: The user has cancelled the operation.STOPPING: The operation is in the process of stopping, at user request. SUCCEEDED: The operation completed creating or updating all the specified stacks without exceeding the failure tolerance for the operation.
"
+ }
+ },
+ "StackSetOperationSummaries": {
+ "base": null,
+ "refs": {
+ "ListStackSetOperationsOutput$Summaries": "FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that you've set for an operation is applied for each region during stack create and update operations. If the number of failed stacks within a region exceeds the failure tolerance, the status of the operation in the region is set to FAILED. This in turn sets the status of the operation as a whole to FAILED, and AWS CloudFormation cancels the operation in any remaining regions.RUNNING: The operation is currently being performed.STOPPED: The user has cancelled the operation.STOPPING: The operation is in the process of stopping, at user request. SUCCEEDED: The operation completed creating or updating all the specified stacks without exceeding the failure tolerance for the operation.StackSetOperationSummary structures that contain summary information about operations for the specified stack set.StackSetSummary structures that contain information about the user's stack sets.Original and Processed templates are always available. For change sets, the Original template is always available. After AWS CloudFormation finishes creating the change set, the Processed template becomes available.CreateStackSet action, AWS CloudFormation checks to see if you have the required IAM permission to tag resources. If you don't, the entire CreateStackSet action fails with an access denied error, and the stack set is not created.Tags that specify information about the stack.
UpdateStackSet action, AWS CloudFormation checks to see if you have the required IAM permission to tag resources. If you omit tags that are currently associated with the stack set from the list of tags you specify, AWS CloudFormation assumes that you want to remove those tags from the stack set, and checks to see if you have permission to untag resources. If you don't have the necessary permission(s), the entire UpdateStackSet action fails with an access denied error, and the stack set is not updated.TemplateBody or TemplateURL.TemplateBody or the TemplateURL parameter, but not both.TemplateBody or TemplateURL. If both are passed, only TemplateBody is used.StackName, TemplateBody, or TemplateURL.TemplateBody, TemplateURL, or set the UsePreviousTemplate to true.TemplateBody or TemplateURL—or set UsePreviousTemplate to true.TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.TemplateBody or TemplateURL.TemplateBody or the TemplateURL parameter, but not both.TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.StackName, TemplateBody, or TemplateURL.TemplateBody, TemplateURL, or set the UsePreviousTemplate to true.TemplateBody or TemplateURL—or set UsePreviousTemplate to true. TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.TemplateBody, TemplateURL, or set the UsePreviousTemplate to true.TemplateBody, TemplateURL, or set the UsePreviousTemplate to true.TemplateBody or TemplateURL—or set UsePreviousTemplate to true. instance.instance and volume.
Period, during which the alarm condition must exist before the alarm triggers automatic scaling activity. The default value is 1.300.
"
+ "RunJobFlowInput$NewSupportedProducts": "
"
}
},
"NonNegativeDouble": {
"base": null,
"refs": {
"CloudWatchAlarmDefinition$Threshold": "InstanceType. Expressed as a number between 0 and 1000 (for example, 20 specifies 20%). If neither BidPrice nor BidPriceAsPercentageOfOnDemandPrice is provided, BidPriceAsPercentageOfOnDemandPrice defaults to 100%.InstanceType. Expressed as a number (for example, 20 specifies 20%). If neither BidPrice nor BidPriceAsPercentageOfOnDemandPrice is provided, BidPriceAsPercentageOfOnDemandPrice defaults to 100%.InstanceType. Expressed as a number (for example, 20 specifies 20%).CustomAmiID is used. Specifies the type of updates that are applied from the Amazon Linux AMI package repositories when an instance boots using the AMI.CustomAmiID is used. Specifies which updates from the Amazon Linux AMI package repositories to apply automatically when the instance boots using the AMI. If omitted, the default is SECURITY, which indicates that only security updates are applied. If NONE is specified, no updates are applied, and all updates must be applied manually.TargetSpotCapacity has not been fulfilled when the TimeoutDurationMinutes has expired. Spot instances are not uprovisioned within the Spot provisioining timeout. Valid values are TERMINATE_CLUSTER and SWITCH_TO_ON_DEMAND to fulfill the remaining capacity.TargetSpotCapacity has not been fulfilled when the TimeoutDurationMinutes has expired. Spot instances are not uprovisioned within the Spot provisioining timeout. Valid values are TERMINATE_CLUSTER and SWITCH_TO_ON_DEMAND. SWITCH_TO_ON_DEMAND specifies that if no Spot instances are available, On-Demand Instances should be provisioned to fulfill any remaining Spot capacity.
"
+ "RunJobFlowInput$SupportedProducts": "
"
}
},
"Tag": {
@@ -1474,7 +1483,7 @@
"InstanceFleetConfig$TargetSpotCapacity": "WeightedCapacity. When a Spot instance is provisioned, the WeightedCapacity units count toward the target capacity. Amazon EMR provisions instances until the target capacity is totally fulfilled, even if this results in an overage. For example, if there are 2 units remaining to fulfill capacity, and Amazon EMR can only provision an instance with a WeightedCapacity of 5 units, the instance is provisioned, and the target capacity is exceeded by 3 units.TargetSpotCapacity and TargetOnDemandCapacity should be greater than 0. For a master instance fleet, only one of TargetSpotCapacity and TargetOnDemandCapacity can be specified, and its value must be 1.TimeOutAction is taken. Minimum value is 5 and maximum value is 1440. The timeout applies only during initial provisioning, when the cluster is first created.ClusterID for which specified steps will be canceled. Use RunJobFlow and ListClusters to get ClusterIDs. InstanceType. Expressed in USD.
HadoopVersion parameter to modify the version of Hadoop from the defaults shown above.ReleaseLabel specified or by CustomAmiID. The version of the Amazon Machine Image (AMI) to use when launching Amazon EC2 instances in the job flow. For details about the AMI versions currently supported in EMR version 3.x and 2.x, see AMI Versions Supported in EMR in the Amazon EMR Developer Guide. HadoopVersion parameter to modify the version of Hadoop from the defaults shown above.AmiVersion instead.ReleaseLabel specified. For Amazon EMR versions 2.x and 3.x, use AmiVersion instead.RequestedEc2SubnetIds, and then launches all cluster instances within that Subnet. If this value is not specified, and the account and region support EC2-Classic networks, the cluster launches instances in the EC2-Classic network and uses RequestedEc2AvailabilityZones instead of this setting. If EC2-Classic is not supported, and no Subnet is specified, Amazon EMR chooses the subnet for you. RequestedEc2SubnetIDs and RequestedEc2AvailabilityZones cannot be specified together.RequestedEc2AvailabilityZones, and then launches all cluster instances within that Availability Zone. If you do not specify this value, Amazon EMR chooses the Availability Zone for you. RequestedEc2SubnetIDs and RequestedEc2AvailabilityZones cannot be specified together.AvailabilityZones is used for instance fleets, while AvailabilityZone (singular) is used for uniform instance groups.
+{{range .}}
+
diff --git a/vendor/github.com/aws/aws-sdk-go/doc-src/aws-godoc/templates/dirlist.html b/vendor/github.com/aws/aws-sdk-go/doc-src/aws-godoc/templates/dirlist.html
new file mode 100644
index 000000000..a3e1a2fa8
--- /dev/null
+++ b/vendor/github.com/aws/aws-sdk-go/doc-src/aws-godoc/templates/dirlist.html
@@ -0,0 +1,31 @@
+
+
+
+ {{$name_html := html .Name}}
+
+{{end}}
+{{$name_html}}
+
+ {{html .Title}}
+
+
+
+
+File
+
+ Bytes
+
+ Modified
+
+
+{{range .}}
+..
+
+ {{$name_html := fileInfoName . | html}}
+
+{{end}}
+
+{{$name_html}}
+
+ {{html .Size}}
+
+ {{fileInfoTime . | html}}
+
+{{html .}} +
diff --git a/vendor/github.com/aws/aws-sdk-go/doc-src/aws-godoc/templates/example.html b/vendor/github.com/aws/aws-sdk-go/doc-src/aws-godoc/templates/example.html new file mode 100644 index 000000000..4f4e09e87 --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/doc-src/aws-godoc/templates/example.html @@ -0,0 +1,30 @@ +▹ Example{{example_suffix .Name}}
+'+ + 'Your download should begin shortly. '+ + 'If it does not, click this link.
'); + message.find('a').attr('href', download); + message.insertAfter('#nav'); + + window.location = download; +} + +$(document).ready(function() { + bindSearchEvents(); + generateTOC(); + bindToggles(".toggle"); + bindToggles(".toggleVisible"); + bindToggleLinks(".exampleLink", "example_"); + bindToggleLinks(".overviewLink", ""); + bindToggleLinks(".examplesLink", ""); + bindToggleLinks(".indexLink", ""); + setupDropdownPlayground(); + setupInlinePlayground(); + fixFocus(); + setupTypeInfo(); + setupCallgraphs(); + toggleHash(); + personalizeInstallInstructions(); + + // godoc.html defines window.initFuncs in the tag, and root.html and + // codewalk.js push their on-page-ready functions to the list. + // We execute those functions here, to avoid loading jQuery until the page + // content is loaded. + for (var i = 0; i < window.initFuncs.length; i++) window.initFuncs[i](); +}); + +// -- analysis --------------------------------------------------------- + +// escapeHTML returns HTML for s, with metacharacters quoted. +// It is safe for use in both elements and attributes +// (unlike the "set innerText, read innerHTML" trick). +function escapeHTML(s) { + return s.replace(/&/g, '&'). + replace(/\"/g, '"'). + replace(/\'/g, '''). + replace(//g, '>'); +} + +// makeAnchor returns HTML for an element, given an anchorJSON object. +function makeAnchor(json) { + var html = escapeHTML(json.Text); + if (json.Href != "") { + html = "" + html + ""; + } + return html; +} + +function showLowFrame(html) { + var lowframe = document.getElementById('lowframe'); + lowframe.style.height = "200px"; + lowframe.innerHTML = "" + html + "
\n" + + "" + escapeHTML(data.Callee) + ":" + escapeHTML(caller.Func) + "";
+ var sites = caller.Sites;
+ if (sites != null && sites.length > 0) {
+ html += " at line ";
+ for (var j = 0; j < sites.length; j++) {
+ if (j > 0) {
+ html += ", ";
+ }
+ html += "" + makeAnchor(sites[j]) + "";
+ }
+ }
+ html += "" + makeAnchor(data.Callees[i]) + "" + data.Name + ": " +
+ " (size=" + data.Size + ", align=" + data.Align + ")" + escapeHTML(group.Descr) + " ";
+ for (var j = 0; j < group.Facts.length; j++) {
+ var fact = group.Facts[j];
+ var y = "" + makeAnchor(fact.Other) + "";
+ if (fact.ByKind != null) {
+ html += escapeHTML(fact.ByKind) + " type " + y + " implements " + x;
+ } else {
+ html += x + " implements " + y;
+ }
+ html += "" + makeAnchor(info.Methods[i]) + "" + escapeHTML(ops[i].Fn) + "| t |
| {{$pkg_html}} |
| + | {{index . 0 | infoKind_html}} | ++ | + {{range .}} + {{$line := infoLine .}} + {{$line}} + {{end}} + | +
|---|
{{comment_html .Doc}}
+ {{else}} +No documentation available
+ {{end}} + {{end}} + {{end}} +{{end}} diff --git a/vendor/github.com/aws/aws-sdk-go/doc-src/aws-godoc/templates/searchtxt.html b/vendor/github.com/aws/aws-sdk-go/doc-src/aws-godoc/templates/searchtxt.html new file mode 100644 index 000000000..7e4a978c4 --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/doc-src/aws-godoc/templates/searchtxt.html @@ -0,0 +1,42 @@ + +{{$query_url := urlquery .Query}} +{{with .Textual}} + {{if $.Complete}} ++ Not all files or lines containing "{{html $.Query}}" are shown. +
+ {{end}} ++
| + {{$file}}: + | ++ | {{len .Lines}} | ++ | + {{range .Lines}} + {{html .}} + {{end}} + {{if not $.Complete}} + ... + {{end}} + | +
|---|---|---|---|---|
| ... |
+ aws-sdk-go is the official AWS SDK for the Go programming language. + + Checkout our release notes for information about the latest bug fixes, updates, and features added to the SDK. +
++ If you are using Go 1.5 with the GO15VENDOREXPERIMENT=1 vendoring flag you can use the following to get the SDK as the SDK's runtime dependencies are vendored in the vendor folder. +
+$ go get -u github.com/aws/aws-sdk-go+
+ Otherwise you'll need to tell Go to get the SDK and all of its dependencies. +
+$ go get -u github.com/aws/aws-sdk-go/...+
+ Before using the SDK, ensure that you've configured credentials. The best way to configure credentials on a development machine is to use the ~/.aws/credentials file, which might look like: +
++ [default] + aws_access_key_id = AKID1234567890 + aws_secret_access_key = MY-SECRET-KEY ++
+ You can learn more about the credentials file from this blog post. + + Alternatively, you can set the following environment variables: +
++ AWS_ACCESS_KEY_ID=AKID1234567890 + AWS_SECRET_ACCESS_KEY=MY-SECRET-KEY ++
+ The AWS SDK for Go does not support the AWS CLI's config file. The SDK will not use any contents from this file. The SDK only supports the shared credentials file (~/aws/credentials). #384 tracks this feature request discussion. +
++ To use a service in the SDK, create a service variable by calling the New() function. Once you have a service client, you can call API operations which each return response data and a possible error. + + To list a set of instance IDs from EC2, you could run: +
+
+ package main
+
+ import (
+ "fmt"
+
+ "github.com/aws/aws-sdk-go/aws"
+ "github.com/aws/aws-sdk-go/aws/session"
+ "github.com/aws/aws-sdk-go/service/ec2"
+ )
+
+ func main() {
+ // Create an EC2 service object in the "us-west-2" region
+ // Note that you can also configure your region globally by
+ // exporting the AWS_REGION environment variable
+ svc := ec2.New(session.New(), &aws.Config{Region: aws.String("us-west-2")})
+
+ // Call the DescribeInstances Operation
+ resp, err := svc.DescribeInstances(nil)
+ if err != nil {
+ panic(err)
+ }
+
+ // resp has all of the response data, pull out instance IDs:
+ fmt.Println("> Number of reservation sets: ", len(resp.Reservations))
+ for idx, res := range resp.Reservations {
+ fmt.Println(" > Number of instances: ", len(res.Instances))
+ for _, inst := range resp.Reservations[idx].Instances {
+ fmt.Println(" - Instance ID: ", *inst.InstanceId)
+ }
+ }
+ }
+
+
+
+
diff --git a/vendor/github.com/aws/aws-sdk-go/doc-src/plugin/plugin.rb b/vendor/github.com/aws/aws-sdk-go/doc-src/plugin/plugin.rb
new file mode 100644
index 000000000..988270747
--- /dev/null
+++ b/vendor/github.com/aws/aws-sdk-go/doc-src/plugin/plugin.rb
@@ -0,0 +1,187 @@
+require 'yard'
+require 'yard-go'
+
+module GoLinksHelper
+ def signature(obj, link = true, show_extras = true, full_attr_name = true)
+ case obj
+ when YARDGo::CodeObjects::FuncObject
+ if link && obj.has_tag?(:service_operation)
+ ret = signature_types(obj, !link)
+ args = obj.parameters.map {|m| m[0].split(/\s+/).last }.join(", ")
+ line = "#{obj.name}(#{args}) #{ret}"
+ return link ? linkify(obj, line) : line
+ end
+ end
+
+ super(obj, link, show_extras, full_attr_name)
+ end
+
+ def html_syntax_highlight(source, type = nil)
+ src = super(source, type || :go)
+ object.has_tag?(:service_operation) ? link_types(src) : src
+ end
+end
+
+YARD::Templates::Helpers::HtmlHelper.send(:prepend, GoLinksHelper)
+YARD::Templates::Engine.register_template_path(File.dirname(__FILE__) + '/templates')
+
+YARD::Parser::SourceParser.after_parse_list do
+ YARD::Registry.all(:struct).each do |obj|
+ if obj.file =~ /\/?service\/(.+?)\/(service|api)\.go$/
+ obj.add_tag YARD::Tags::Tag.new(:service, $1)
+ obj.groups = ["Constructor Functions", "Service Operations", "Request Methods", "Pagination Methods"]
+ end
+ end
+
+ YARD::Registry.all(:method).each do |obj|
+ if obj.file =~ /service\/.+?\/api\.go$/ && obj.scope == :instance
+ if obj.name.to_s =~ /Pages$/
+ obj.group = "Pagination Methods"
+ opname = obj.name.to_s.sub(/Pages$/, '')
+ obj.docstring = <<-eof
+#{obj.name} iterates over the pages of a {#{opname} #{opname}()} operation, calling the `fn`
+function callback with the response data in each page. To stop iterating, return `false` from
+the function callback.
+
+@note This operation can generate multiple requests to a service.
+@example Iterating over at most 3 pages of a #{opname} operation
+ pageNum := 0
+ err := client.#{obj.name}(params, func(page *#{obj.parent.parent.name}.#{obj.parameters[1][0].split("*").last}, lastPage bool) bool {
+ pageNum++
+ fmt.Println(page)
+ return pageNum <= 3
+ })
+@see #{opname}
+eof
+ obj.add_tag YARD::Tags::Tag.new(:paginator, '')
+ elsif obj.name.to_s =~ /Request$/
+ obj.group = "Request Methods"
+ obj.signature = obj.name.to_s
+ obj.parameters = []
+ opname = obj.name.to_s.sub(/Request$/, '')
+ obj.docstring = <<-eof
+#{obj.name} generates a {aws/request.Request} object representing the client request for
+the {#{opname} #{opname}()} operation. The `output` return value can be used to capture
+response data after {aws/request.Request.Send Request.Send()} is called.
+
+Creating a request object using this method should be used when you want to inject
+custom logic into the request lifecycle using a custom handler, or if you want to
+access properties on the request object before or after sending the request. If
+you just want the service response, call the {#{opname} service operation method}
+directly instead.
+
+@note You must call the {aws/request.Request.Send Send()} method on the returned
+ request object in order to execute the request.
+@example Sending a request using the #{obj.name}() method
+ req, resp := client.#{obj.name}(params)
+ err := req.Send()
+
+ if err == nil { // resp is now filled
+ fmt.Println(resp)
+ }
+eof
+ obj.add_tag YARD::Tags::Tag.new(:request_method, '')
+ else
+ obj.group = "Service Operations"
+ obj.add_tag YARD::Tags::Tag.new(:service_operation, '')
+ if ex = obj.tag(:example)
+ ex.name = "Calling the #{obj.name} operation"
+ end
+ end
+ end
+ end
+
+ apply_docs
+end
+
+def apply_docs
+ svc_pkg = YARD::Registry.at('service')
+ return if svc_pkg.nil?
+
+ pkgs = svc_pkg.children.select {|t| t.type == :package }
+ pkgs.each do |pkg|
+ svc = pkg.children.find {|t| t.has_tag?(:service) }
+ ctor = P(svc, ".New")
+ svc_name = ctor.source[/ServiceName:\s*"(.+?)",/, 1]
+ api_ver = ctor.source[/APIVersion:\s*"(.+?)",/, 1]
+ log.progress "Parsing service documentation for #{svc_name} (#{api_ver})"
+ file = Dir.glob("models/apis/#{svc_name}/#{api_ver}/docs-2.json").sort.last
+ next if file.nil?
+
+ next if svc.nil?
+ exmeth = svc.children.find {|s| s.has_tag?(:service_operation) }
+ pkg.docstring += <<-eof
+
+@example Sending a request using the {#{svc.name}} client
+ client := #{pkg.name}.New(nil)
+ params := {pkg.name}.#{exmeth.parameters.first[0].split("*").last}{...}
+ resp, err := client.#{exmeth.name}(params)
+@see #{svc.name}
+@version #{api_ver}
+eof
+
+ ctor.docstring += <<-eof
+
+@example Constructing a client using default configuration
+ client := #{pkg.name}.New(nil)
+
+@example Constructing a client with custom configuration
+ config := aws.NewConfig().WithRegion("us-west-2")
+ client := #{pkg.name}.New(config)
+eof
+
+ json = JSON.parse(File.read(file))
+ if svc
+ apply_doc(svc, json["service"])
+ end
+
+ json["operations"].each do |op, doc|
+ if doc && obj = svc.children.find {|t| t.name.to_s.downcase == op.downcase }
+ apply_doc(obj, doc)
+ end
+ end
+
+ json["shapes"].each do |shape, data|
+ shape = shape_name(shape)
+ if obj = pkg.children.find {|t| t.name.to_s.downcase == shape.downcase }
+ apply_doc(obj, data["base"])
+ end
+
+ data["refs"].each do |refname, doc|
+ refshape, member = *refname.split("$")
+ refshape = shape_name(refshape)
+ if refobj = pkg.children.find {|t| t.name.to_s.downcase == refshape.downcase }
+ if m = refobj.children.find {|t| t.name.to_s.downcase == member.downcase }
+ apply_doc(m, doc || data["base"])
+ end
+ end
+ end if data["refs"]
+ end
+ end
+end
+
+def apply_doc(obj, doc)
+ tags = obj.docstring.tags || []
+ obj.docstring = clean_docstring(doc)
+ tags.each {|t| obj.docstring.add_tag(t) }
+end
+
+def shape_name(shape)
+ shape.sub(/Request$/, "Input").sub(/Response$/, "Output")
+end
+
+def clean_docstring(docs)
+ return nil unless docs
+ docs = docs.gsub(//m, '')
+ docs = docs.gsub(/<%= @items.map {|pkg| link_object(pkg, pkg.name) }.join(" ") %>
+<%= @items.map {|pkg| link_object(pkg, pkg.name) }.join(" ") %>
+Amazon Kinesis Firehose is a fully-managed service that delivers real-time streaming data to destinations such as Amazon Simple Storage Service (Amazon S3), Amazon Elasticsearch Service (Amazon ES), and Amazon Redshift.
", + "operations": { + "CreateDeliveryStream": "Creates a delivery stream.
CreateDeliveryStream is an asynchronous operation that immediately returns. The initial status of the delivery stream is CREATING. After the delivery stream is created, its status is ACTIVE and it now accepts data. Attempts to send data to a delivery stream that is not in the ACTIVE state cause an exception. To check the state of a delivery stream, use DescribeDeliveryStream.
The name of a delivery stream identifies it. You can't have two delivery streams with the same name in the same region. Two delivery streams in different AWS accounts or different regions in the same AWS account can have the same name.
By default, you can create up to 20 delivery streams per region.
A delivery stream can only be configured with a single destination, Amazon S3, Amazon Elasticsearch Service, or Amazon Redshift. For correct CreateDeliveryStream request syntax, specify only one destination configuration parameter: either S3DestinationConfiguration, ElasticsearchDestinationConfiguration, or RedshiftDestinationConfiguration.
As part of S3DestinationConfiguration, optional values BufferingHints, EncryptionConfiguration, and CompressionFormat can be provided. By default, if no BufferingHints value is provided, Firehose buffers data up to 5 MB or for 5 minutes, whichever condition is satisfied first. Note that BufferingHints is a hint, so there are some cases where the service cannot adhere to these conditions strictly; for example, record boundaries are such that the size is a little over or under the configured buffering size. By default, no encryption is performed. We strongly recommend that you enable encryption to ensure secure data storage in Amazon S3.
A few notes about RedshiftDestinationConfiguration:
An Amazon Redshift destination requires an S3 bucket as intermediate location, as Firehose first delivers data to S3 and then uses COPY syntax to load data into an Amazon Redshift table. This is specified in the RedshiftDestinationConfiguration.S3Configuration parameter element.
The compression formats SNAPPY or ZIP cannot be specified in RedshiftDestinationConfiguration.S3Configuration because the Amazon Redshift COPY operation that reads from the S3 bucket doesn't support these compression formats.
We strongly recommend that the username and password provided is used exclusively for Firehose purposes, and that the permissions for the account are restricted for Amazon Redshift INSERT permissions.
Firehose assumes the IAM role that is configured as part of destinations. The IAM role should allow the Firehose principal to assume the role, and the role should have permissions that allows the service to deliver the data. For more information, see Amazon S3 Bucket Access in the Amazon Kinesis Firehose Developer Guide.
", + "DeleteDeliveryStream": "Deletes a delivery stream and its data.
You can delete a delivery stream only if it is in ACTIVE or DELETING state, and not in the CREATING state. While the deletion request is in process, the delivery stream is in the DELETING state.
To check the state of a delivery stream, use DescribeDeliveryStream.
While the delivery stream is DELETING state, the service may continue to accept the records, but the service doesn't make any guarantees with respect to delivering the data. Therefore, as a best practice, you should first stop any applications that are sending records before deleting a delivery stream.
Describes the specified delivery stream and gets the status. For example, after your delivery stream is created, call DescribeDeliveryStream to see if the delivery stream is ACTIVE and therefore ready for data to be sent to it.
Lists your delivery streams.
The number of delivery streams might be too large to return using a single call to ListDeliveryStreams. You can limit the number of delivery streams returned, using the Limit parameter. To determine whether there are more delivery streams to list, check the value of HasMoreDeliveryStreams in the output. If there are more delivery streams to list, you can request them by specifying the name of the last delivery stream returned in the call in the ExclusiveStartDeliveryStreamName parameter of a subsequent call.
", + "PutRecord": "Writes a single data record into an Amazon Kinesis Firehose delivery stream. To write multiple data records into a delivery stream, use PutRecordBatch. Applications using these operations are referred to as producers.
By default, each delivery stream can take in up to 2,000 transactions per second, 5,000 records per second, or 5 MB per second. Note that if you use PutRecord and PutRecordBatch, the limits are an aggregate across these two operations for each delivery stream. For more information about limits and how to request an increase, see Amazon Kinesis Firehose Limits.
You must specify the name of the delivery stream and the data record when using PutRecord. The data record consists of a data blob that can be up to 1,000 KB in size, and any kind of data, for example, a segment from a log file, geographic location data, web site clickstream data, etc.
Firehose buffers records before delivering them to the destination. To disambiguate the data blobs at the destination, a common solution is to use delimiters in the data, such as a newline (\\n) or some other character unique within the data. This allows the consumer application(s) to parse individual data items when reading the data from the destination.
The PutRecord operation returns a RecordId, which is a unique string assigned to each record. Producer applications can use this ID for purposes such as auditability and investigation.
If the PutRecord operation throws a ServiceUnavailableException, back off and retry. If the exception persists, it is possible that the throughput limits have been exceeded for the delivery stream.
Data records sent to Firehose are stored for 24 hours from the time they are added to a delivery stream as it attempts to send the records to the destination. If the destination is unreachable for more than 24 hours, the data is no longer available.
", + "PutRecordBatch": "Writes multiple data records into a delivery stream in a single call, which can achieve higher throughput per producer than when writing single records. To write single data records into a delivery stream, use PutRecord. Applications using these operations are referred to as producers.
Each PutRecordBatch request supports up to 500 records. Each record in the request can be as large as 1,000 KB (before 64-bit encoding), up to a limit of 4 MB for the entire request. By default, each delivery stream can take in up to 2,000 transactions per second, 5,000 records per second, or 5 MB per second. Note that if you use PutRecord and PutRecordBatch, the limits are an aggregate across these two operations for each delivery stream. For more information about limits and how to request an increase, see Amazon Kinesis Firehose Limits.
You must specify the name of the delivery stream and the data record when using PutRecord. The data record consists of a data blob that can be up to 1,000 KB in size, and any kind of data, for example, a segment from a log file, geographic location data, web site clickstream data, and so on.
Firehose buffers records before delivering them to the destination. To disambiguate the data blobs at the destination, a common solution is to use delimiters in the data, such as a newline (\\n) or some other character unique within the data. This allows the consumer application(s) to parse individual data items when reading the data from the destination.
The PutRecordBatch response includes a count of any failed records, FailedPutCount, and an array of responses, RequestResponses. The FailedPutCount value is a count of records that failed. Each entry in the RequestResponses array gives additional information of the processed record. Each entry in RequestResponses directly correlates with a record in the request array using the same ordering, from the top to the bottom of the request and response. RequestResponses always includes the same number of records as the request array. RequestResponses both successfully and unsuccessfully processed records. Firehose attempts to process all records in each PutRecordBatch request. A single record failure does not stop the processing of subsequent records.
A successfully processed record includes a RecordId value, which is a unique value identified for the record. An unsuccessfully processed record includes ErrorCode and ErrorMessage values. ErrorCode reflects the type of error and is one of the following values: ServiceUnavailable or InternalFailure. ErrorMessage provides more detailed information about the error.
If FailedPutCount is greater than 0 (zero), retry the request. A retry of the entire batch of records is possible; however, we strongly recommend that you inspect the entire response and resend only those records that failed processing. This minimizes duplicate records and also reduces the total bytes sent (and corresponding charges).
If the PutRecordBatch operation throws a ServiceUnavailableException, back off and retry. If the exception persists, it is possible that the throughput limits have been exceeded for the delivery stream.
Data records sent to Firehose are stored for 24 hours from the time they are added to a delivery stream as it attempts to send the records to the destination. If the destination is unreachable for more than 24 hours, the data is no longer available.
", + "UpdateDestination": "Updates the specified destination of the specified delivery stream. Note: Switching between Elasticsearch and other services is not supported. For Elasticsearch destination, you can only update an existing Elasticsearch destination with this operation.
This operation can be used to change the destination type (for example, to replace the Amazon S3 destination with Amazon Redshift) or change the parameters associated with a given destination (for example, to change the bucket name of the Amazon S3 destination). The update may not occur immediately. The target delivery stream remains active while the configurations are updated, so data writes to the delivery stream can continue during this process. The updated configurations are normally effective within a few minutes.
If the destination type is the same, Firehose merges the configuration parameters specified in the UpdateDestination request with the destination configuration that already exists on the delivery stream. If any of the parameters are not specified in the update request, then the existing configuration parameters are retained. For example, in the Amazon S3 destination, if EncryptionConfiguration is not specified then the existing EncryptionConfiguration is maintained on the destination.
If the destination type is not the same, for example, changing the destination from Amazon S3 to Amazon Redshift, Firehose does not merge any parameters. In this case, all parameters must be specified.
Firehose uses the CurrentDeliveryStreamVersionId to avoid race conditions and conflicting merges. This is a required field in every request and the service only updates the configuration if the existing configuration matches the VersionId. After the update is applied successfully, the VersionId is updated, which can be retrieved with the DescribeDeliveryStream operation. The new VersionId should be uses to set CurrentDeliveryStreamVersionId in the next UpdateDestination operation.
" + }, + "shapes": { + "AWSKMSKeyARN": { + "base": null, + "refs": { + "KMSEncryptionConfig$AWSKMSKeyARN": "The ARN of the encryption key. Must belong to the same region as the destination Amazon S3 bucket.
" + } + }, + "BooleanObject": { + "base": null, + "refs": { + "CloudWatchLoggingOptions$Enabled": "Enables or disables CloudWatch logging.
", + "DeliveryStreamDescription$HasMoreDestinations": "Indicates whether there are more destinations available to list.
", + "ListDeliveryStreamsOutput$HasMoreDeliveryStreams": "Indicates whether there are more delivery streams available to list.
" + } + }, + "BucketARN": { + "base": null, + "refs": { + "S3DestinationConfiguration$BucketARN": "The ARN of the S3 bucket.
", + "S3DestinationDescription$BucketARN": "The ARN of the S3 bucket.
", + "S3DestinationUpdate$BucketARN": "The ARN of the S3 bucket.
" + } + }, + "BufferingHints": { + "base": "Describes hints for the buffering to perform before delivering data to the destination. Please note that these options are treated as hints, and therefore Firehose may choose to use different values when it is optimal.
", + "refs": { + "S3DestinationConfiguration$BufferingHints": "The buffering option. If no value is specified, BufferingHints object default values are used.
", + "S3DestinationDescription$BufferingHints": "The buffering option. If no value is specified, BufferingHints object default values are used.
", + "S3DestinationUpdate$BufferingHints": "The buffering option. If no value is specified, BufferingHints object default values are used.
" + } + }, + "CloudWatchLoggingOptions": { + "base": "Describes CloudWatch logging options for your delivery stream.
", + "refs": { + "ElasticsearchDestinationConfiguration$CloudWatchLoggingOptions": "Describes CloudWatch logging options for your delivery stream.
", + "ElasticsearchDestinationDescription$CloudWatchLoggingOptions": "CloudWatch logging options.
", + "ElasticsearchDestinationUpdate$CloudWatchLoggingOptions": "Describes CloudWatch logging options for your delivery stream.
", + "RedshiftDestinationConfiguration$CloudWatchLoggingOptions": "Describes CloudWatch logging options for your delivery stream.
", + "RedshiftDestinationDescription$CloudWatchLoggingOptions": "Describes CloudWatch logging options for your delivery stream.
", + "RedshiftDestinationUpdate$CloudWatchLoggingOptions": "Describes CloudWatch logging options for your delivery stream.
", + "S3DestinationConfiguration$CloudWatchLoggingOptions": "Describes CloudWatch logging options for your delivery stream.
", + "S3DestinationDescription$CloudWatchLoggingOptions": "Describes CloudWatch logging options for your delivery stream.
", + "S3DestinationUpdate$CloudWatchLoggingOptions": "Describes CloudWatch logging options for your delivery stream.
" + } + }, + "ClusterJDBCURL": { + "base": null, + "refs": { + "RedshiftDestinationConfiguration$ClusterJDBCURL": "The database connection string.
", + "RedshiftDestinationDescription$ClusterJDBCURL": "The database connection string.
", + "RedshiftDestinationUpdate$ClusterJDBCURL": "The database connection string.
" + } + }, + "CompressionFormat": { + "base": null, + "refs": { + "S3DestinationConfiguration$CompressionFormat": "The compression format. If no value is specified, the default is UNCOMPRESSED.
The compression formats SNAPPY or ZIP cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon Redshift COPY operation that reads from the S3 bucket.
The compression format. If no value is specified, the default is NOCOMPRESSION.
The compression format. If no value is specified, the default is NOCOMPRESSION.
The compression formats SNAPPY or ZIP cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon Redshift COPY operation that reads from the S3 bucket.
Another modification has already happened. Fetch VersionId again and use it to update the destination.
", + "refs": { + } + }, + "CopyCommand": { + "base": "Describes a COPY command for Amazon Redshift.
The COPY command.
The COPY command.
The COPY command.
Optional parameters to use with the Amazon Redshift COPY command. For more information, see the \"Optional Parameters\" section of Amazon Redshift COPY command. Some possible examples that would apply to Firehose are as follows.
delimiter '\\t' lzop; - fields are delimited with \"\\t\" (TAB character) and compressed using lzop.
delimiter '| - fields are delimited with \"|\" (this is the default delimiter).
delimiter '|' escape - the delimiter should be escaped.
fixedwidth 'venueid:3,venuename:25,venuecity:12,venuestate:2,venueseats:6' - fields are fixed width in the source, with each width specified after every column in the table.
JSON 's3://mybucket/jsonpaths.txt' - data is in JSON format, and the path specified is the format of the data.
For more examples, see Amazon Redshift COPY command examples.
" + } + }, + "CreateDeliveryStreamInput": { + "base": "Contains the parameters for CreateDeliveryStream.
", + "refs": { + } + }, + "CreateDeliveryStreamOutput": { + "base": "Contains the output of CreateDeliveryStream.
", + "refs": { + } + }, + "Data": { + "base": null, + "refs": { + "Record$Data": "The data blob, which is base64-encoded when the blob is serialized. The maximum size of the data blob, before base64-encoding, is 1,000 KB.
" + } + }, + "DataTableColumns": { + "base": null, + "refs": { + "CopyCommand$DataTableColumns": "A comma-separated list of column names.
" + } + }, + "DataTableName": { + "base": null, + "refs": { + "CopyCommand$DataTableName": "The name of the target table. The table must already exist in the database.
" + } + }, + "DeleteDeliveryStreamInput": { + "base": "Contains the parameters for DeleteDeliveryStream.
", + "refs": { + } + }, + "DeleteDeliveryStreamOutput": { + "base": "Contains the output of DeleteDeliveryStream.
", + "refs": { + } + }, + "DeliveryStreamARN": { + "base": null, + "refs": { + "CreateDeliveryStreamOutput$DeliveryStreamARN": "The ARN of the delivery stream.
", + "DeliveryStreamDescription$DeliveryStreamARN": "The Amazon Resource Name (ARN) of the delivery stream.
" + } + }, + "DeliveryStreamDescription": { + "base": "Contains information about a delivery stream.
", + "refs": { + "DescribeDeliveryStreamOutput$DeliveryStreamDescription": "Information about the delivery stream.
" + } + }, + "DeliveryStreamName": { + "base": null, + "refs": { + "CreateDeliveryStreamInput$DeliveryStreamName": "The name of the delivery stream.
", + "DeleteDeliveryStreamInput$DeliveryStreamName": "The name of the delivery stream.
", + "DeliveryStreamDescription$DeliveryStreamName": "The name of the delivery stream.
", + "DeliveryStreamNameList$member": null, + "DescribeDeliveryStreamInput$DeliveryStreamName": "The name of the delivery stream.
", + "ListDeliveryStreamsInput$ExclusiveStartDeliveryStreamName": "The name of the delivery stream to start the list with.
", + "PutRecordBatchInput$DeliveryStreamName": "The name of the delivery stream.
", + "PutRecordInput$DeliveryStreamName": "The name of the delivery stream.
", + "UpdateDestinationInput$DeliveryStreamName": "The name of the delivery stream.
" + } + }, + "DeliveryStreamNameList": { + "base": null, + "refs": { + "ListDeliveryStreamsOutput$DeliveryStreamNames": "The names of the delivery streams.
" + } + }, + "DeliveryStreamStatus": { + "base": null, + "refs": { + "DeliveryStreamDescription$DeliveryStreamStatus": "The status of the delivery stream.
" + } + }, + "DeliveryStreamVersionId": { + "base": null, + "refs": { + "DeliveryStreamDescription$VersionId": "Used when calling the UpdateDestination operation. Each time the destination is updated for the delivery stream, the VersionId is changed, and the current VersionId is required when updating the destination. This is so that the service knows it is applying the changes to the correct version of the delivery stream.
", + "UpdateDestinationInput$CurrentDeliveryStreamVersionId": "Obtain this value from the VersionId result of the DeliveryStreamDescription operation. This value is required, and helps the service to perform conditional operations. For example, if there is a interleaving update and this value is null, then the update destination fails. After the update is successful, the VersionId value is updated. The service then performs a merge of the old configuration with the new configuration.
" + } + }, + "DescribeDeliveryStreamInput": { + "base": "Contains the parameters for DescribeDeliveryStream.
", + "refs": { + } + }, + "DescribeDeliveryStreamInputLimit": { + "base": null, + "refs": { + "DescribeDeliveryStreamInput$Limit": "The limit on the number of destinations to return. Currently, you can have one destination per delivery stream.
" + } + }, + "DescribeDeliveryStreamOutput": { + "base": "Contains the output of DescribeDeliveryStream.
", + "refs": { + } + }, + "DestinationDescription": { + "base": "Describes the destination for a delivery stream.
", + "refs": { + "DestinationDescriptionList$member": null + } + }, + "DestinationDescriptionList": { + "base": null, + "refs": { + "DeliveryStreamDescription$Destinations": "The destinations.
" + } + }, + "DestinationId": { + "base": null, + "refs": { + "DescribeDeliveryStreamInput$ExclusiveStartDestinationId": "Specifies the destination ID to start returning the destination information. Currently Firehose supports one destination per delivery stream.
", + "DestinationDescription$DestinationId": "The ID of the destination.
", + "UpdateDestinationInput$DestinationId": "The ID of the destination.
" + } + }, + "ElasticsearchBufferingHints": { + "base": "Describes the buffering to perform before delivering data to the Amazon ES destination.
", + "refs": { + "ElasticsearchDestinationConfiguration$BufferingHints": "Buffering options. If no value is specified, ElasticsearchBufferingHints object default values are used.
", + "ElasticsearchDestinationDescription$BufferingHints": "Buffering options.
", + "ElasticsearchDestinationUpdate$BufferingHints": "Buffering options. If no value is specified, ElasticsearchBufferingHints object default values are used.
" + } + }, + "ElasticsearchBufferingIntervalInSeconds": { + "base": null, + "refs": { + "ElasticsearchBufferingHints$IntervalInSeconds": "Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300 (5 minutes).
" + } + }, + "ElasticsearchBufferingSizeInMBs": { + "base": null, + "refs": { + "ElasticsearchBufferingHints$SizeInMBs": "Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.
We recommend setting SizeInMBs to a value greater than the amount of data you typically ingest into the delivery stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec, set SizeInMBs to be 10 MB or higher.
" + } + }, + "ElasticsearchDestinationConfiguration": { + "base": "Describes the configuration of a destination in Amazon ES.
", + "refs": { + "CreateDeliveryStreamInput$ElasticsearchDestinationConfiguration": "The destination in Amazon ES. This value cannot be specified if Amazon S3 or Amazon Redshift is the desired destination (see restrictions listed above).
" + } + }, + "ElasticsearchDestinationDescription": { + "base": "The destination description in Amazon ES.
", + "refs": { + "DestinationDescription$ElasticsearchDestinationDescription": "The destination in Amazon ES.
" + } + }, + "ElasticsearchDestinationUpdate": { + "base": "Describes an update for a destination in Amazon ES.
", + "refs": { + "UpdateDestinationInput$ElasticsearchDestinationUpdate": "Describes an update for a destination in Amazon ES.
" + } + }, + "ElasticsearchDomainARN": { + "base": null, + "refs": { + "ElasticsearchDestinationConfiguration$DomainARN": "The ARN of the Amazon ES domain. The IAM role must have permission for DescribeElasticsearchDomain, DescribeElasticsearchDomains , and DescribeElasticsearchDomainConfig after assuming RoleARN.
The ARN of the Amazon ES domain.
", + "ElasticsearchDestinationUpdate$DomainARN": "The ARN of the Amazon ES domain. The IAM role must have permission for DescribeElasticsearchDomain, DescribeElasticsearchDomains , and DescribeElasticsearchDomainConfig after assuming RoleARN.
" + } + }, + "ElasticsearchIndexName": { + "base": null, + "refs": { + "ElasticsearchDestinationConfiguration$IndexName": "The Elasticsearch index name.
", + "ElasticsearchDestinationDescription$IndexName": "The Elasticsearch index name.
", + "ElasticsearchDestinationUpdate$IndexName": "The Elasticsearch index name.
" + } + }, + "ElasticsearchIndexRotationPeriod": { + "base": null, + "refs": { + "ElasticsearchDestinationConfiguration$IndexRotationPeriod": "The Elasticsearch index rotation period. Index rotation appends a timestamp to the IndexName to facilitate expiration of old data. For more information, see Index Rotation for Amazon Elasticsearch Service Destination. Default value is OneDay.
The Elasticsearch index rotation period
", + "ElasticsearchDestinationUpdate$IndexRotationPeriod": "The Elasticsearch index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data. For more information, see Index Rotation for Amazon Elasticsearch Service Destination. Default value is OneDay.
After an initial failure to deliver to Amazon ES, the total amount of time during which Firehose re-attempts delivery (including the first attempt). After this time has elapsed, the failed documents are written to Amazon S3. Default value is 300 seconds (5 minutes). A value of 0 (zero) results in no retries.
" + } + }, + "ElasticsearchRetryOptions": { + "base": "Configures retry behavior in the event that Firehose is unable to deliver documents to Amazon ES.
", + "refs": { + "ElasticsearchDestinationConfiguration$RetryOptions": "Configures retry behavior in the event that Firehose is unable to deliver documents to Amazon ES. Default value is 300 (5 minutes).
", + "ElasticsearchDestinationDescription$RetryOptions": "Elasticsearch retry options.
", + "ElasticsearchDestinationUpdate$RetryOptions": "Configures retry behavior in the event that Firehose is unable to deliver documents to Amazon ES. Default value is 300 (5 minutes).
" + } + }, + "ElasticsearchS3BackupMode": { + "base": null, + "refs": { + "ElasticsearchDestinationConfiguration$S3BackupMode": "Defines how documents should be delivered to Amazon S3. When set to FailedDocumentsOnly, Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with elasticsearch-failed/ appended to the key prefix. When set to AllDocuments, Firehose delivers all incoming records to Amazon S3, and also writes failed documents with elasticsearch-failed/ appended to the prefix. For more information, see Amazon S3 Backup for Amazon Elasticsearch Service Destination. Default value is FailedDocumentsOnly.
", + "ElasticsearchDestinationDescription$S3BackupMode": "Amazon S3 backup mode.
" + } + }, + "ElasticsearchTypeName": { + "base": null, + "refs": { + "ElasticsearchDestinationConfiguration$TypeName": "The Elasticsearch type name.
", + "ElasticsearchDestinationDescription$TypeName": "The Elasticsearch type name.
", + "ElasticsearchDestinationUpdate$TypeName": "The Elasticsearch type name.
" + } + }, + "EncryptionConfiguration": { + "base": "Describes the encryption for a destination in Amazon S3.
", + "refs": { + "S3DestinationConfiguration$EncryptionConfiguration": "The encryption configuration. If no value is specified, the default is no encryption.
", + "S3DestinationDescription$EncryptionConfiguration": "The encryption configuration. If no value is specified, the default is no encryption.
", + "S3DestinationUpdate$EncryptionConfiguration": "The encryption configuration. If no value is specified, the default is no encryption.
" + } + }, + "ErrorCode": { + "base": null, + "refs": { + "PutRecordBatchResponseEntry$ErrorCode": "The error code for an individual record result.
" + } + }, + "ErrorMessage": { + "base": null, + "refs": { + "ConcurrentModificationException$message": "A message that provides information about the error.
", + "InvalidArgumentException$message": "A message that provides information about the error.
", + "LimitExceededException$message": "A message that provides information about the error.
", + "PutRecordBatchResponseEntry$ErrorMessage": "The error message for an individual record result.
", + "ResourceInUseException$message": "A message that provides information about the error.
", + "ResourceNotFoundException$message": "A message that provides information about the error.
", + "ServiceUnavailableException$message": "A message that provides information about the error.
" + } + }, + "IntervalInSeconds": { + "base": null, + "refs": { + "BufferingHints$IntervalInSeconds": "Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300.
" + } + }, + "InvalidArgumentException": { + "base": "The specified input parameter has an value that is not valid.
", + "refs": { + } + }, + "KMSEncryptionConfig": { + "base": "Describes an encryption key for a destination in Amazon S3.
", + "refs": { + "EncryptionConfiguration$KMSEncryptionConfig": "The encryption key.
" + } + }, + "LimitExceededException": { + "base": "You have already reached the limit for a requested resource.
", + "refs": { + } + }, + "ListDeliveryStreamsInput": { + "base": "Contains the parameters for ListDeliveryStreams.
", + "refs": { + } + }, + "ListDeliveryStreamsInputLimit": { + "base": null, + "refs": { + "ListDeliveryStreamsInput$Limit": "The maximum number of delivery streams to list.
" + } + }, + "ListDeliveryStreamsOutput": { + "base": "Contains the output of ListDeliveryStreams.
", + "refs": { + } + }, + "LogGroupName": { + "base": null, + "refs": { + "CloudWatchLoggingOptions$LogGroupName": "The CloudWatch group name for logging. This value is required if Enabled is true.
" + } + }, + "LogStreamName": { + "base": null, + "refs": { + "CloudWatchLoggingOptions$LogStreamName": "The CloudWatch log stream name for logging. This value is required if Enabled is true.
" + } + }, + "NoEncryptionConfig": { + "base": null, + "refs": { + "EncryptionConfiguration$NoEncryptionConfig": "Specifically override existing encryption information to ensure no encryption is used.
" + } + }, + "NonNegativeIntegerObject": { + "base": null, + "refs": { + "PutRecordBatchOutput$FailedPutCount": "The number of unsuccessfully written records.
" + } + }, + "Password": { + "base": null, + "refs": { + "RedshiftDestinationConfiguration$Password": "The user password.
", + "RedshiftDestinationUpdate$Password": "The user password.
" + } + }, + "Prefix": { + "base": null, + "refs": { + "S3DestinationConfiguration$Prefix": "The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. Note that if the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see Amazon S3 Object Name Format in the Amazon Kinesis Firehose Developer Guide.
", + "S3DestinationDescription$Prefix": "The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. Note that if the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see Amazon S3 Object Name Format in the Amazon Kinesis Firehose Developer Guide.
", + "S3DestinationUpdate$Prefix": "The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. Note that if the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see Amazon S3 Object Name Format in the Amazon Kinesis Firehose Developer Guide.
" + } + }, + "PutRecordBatchInput": { + "base": "Contains the parameters for PutRecordBatch.
", + "refs": { + } + }, + "PutRecordBatchOutput": { + "base": "Contains the output of PutRecordBatch.
", + "refs": { + } + }, + "PutRecordBatchRequestEntryList": { + "base": null, + "refs": { + "PutRecordBatchInput$Records": "One or more records.
" + } + }, + "PutRecordBatchResponseEntry": { + "base": "Contains the result for an individual record from a PutRecordBatch request. If the record is successfully added to your delivery stream, it receives a record ID. If the record fails to be added to your delivery stream, the result includes an error code and an error message.
", + "refs": { + "PutRecordBatchResponseEntryList$member": null + } + }, + "PutRecordBatchResponseEntryList": { + "base": null, + "refs": { + "PutRecordBatchOutput$RequestResponses": "The results for the individual records. The index of each element matches the same index in which records were sent.
" + } + }, + "PutRecordInput": { + "base": "Contains the parameters for PutRecord.
", + "refs": { + } + }, + "PutRecordOutput": { + "base": "Contains the output of PutRecord.
", + "refs": { + } + }, + "PutResponseRecordId": { + "base": null, + "refs": { + "PutRecordBatchResponseEntry$RecordId": "The ID of the record.
", + "PutRecordOutput$RecordId": "The ID of the record.
" + } + }, + "Record": { + "base": "The unit of data in a delivery stream.
", + "refs": { + "PutRecordBatchRequestEntryList$member": null, + "PutRecordInput$Record": "The record.
" + } + }, + "RedshiftDestinationConfiguration": { + "base": "Describes the configuration of a destination in Amazon Redshift.
", + "refs": { + "CreateDeliveryStreamInput$RedshiftDestinationConfiguration": "The destination in Amazon Redshift. This value cannot be specified if Amazon S3 or Amazon Elasticsearch is the desired destination (see restrictions listed above).
" + } + }, + "RedshiftDestinationDescription": { + "base": "Describes a destination in Amazon Redshift.
", + "refs": { + "DestinationDescription$RedshiftDestinationDescription": "The destination in Amazon Redshift.
" + } + }, + "RedshiftDestinationUpdate": { + "base": "Describes an update for a destination in Amazon Redshift.
", + "refs": { + "UpdateDestinationInput$RedshiftDestinationUpdate": "Describes an update for a destination in Amazon Redshift.
" + } + }, + "RedshiftRetryDurationInSeconds": { + "base": null, + "refs": { + "RedshiftRetryOptions$DurationInSeconds": "The length of time during which Firehose retries delivery after a failure, starting from the initial request and including the first attempt. The default value is 3600 seconds (60 minutes). Firehose does not retry if the value of DurationInSeconds is 0 (zero) or if the first delivery attempt takes longer than the current value.
Configures retry behavior in the event that Firehose is unable to deliver documents to Amazon Redshift.
", + "refs": { + "RedshiftDestinationConfiguration$RetryOptions": "Configures retry behavior in the event that Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).
", + "RedshiftDestinationDescription$RetryOptions": "Configures retry behavior in the event that Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).
", + "RedshiftDestinationUpdate$RetryOptions": "Configures retry behavior in the event that Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).
" + } + }, + "ResourceInUseException": { + "base": "The resource is already in use and not available for this operation.
", + "refs": { + } + }, + "ResourceNotFoundException": { + "base": "The specified resource could not be found.
", + "refs": { + } + }, + "RoleARN": { + "base": null, + "refs": { + "ElasticsearchDestinationConfiguration$RoleARN": "The ARN of the IAM role to be assumed by Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Amazon S3 Bucket Access.
", + "ElasticsearchDestinationDescription$RoleARN": "The ARN of the AWS credentials.
", + "ElasticsearchDestinationUpdate$RoleARN": "The ARN of the IAM role to be assumed by Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Amazon S3 Bucket Access.
", + "RedshiftDestinationConfiguration$RoleARN": "The ARN of the AWS credentials.
", + "RedshiftDestinationDescription$RoleARN": "The ARN of the AWS credentials.
", + "RedshiftDestinationUpdate$RoleARN": "The ARN of the AWS credentials.
", + "S3DestinationConfiguration$RoleARN": "The ARN of the AWS credentials.
", + "S3DestinationDescription$RoleARN": "The ARN of the AWS credentials.
", + "S3DestinationUpdate$RoleARN": "The ARN of the AWS credentials.
" + } + }, + "S3DestinationConfiguration": { + "base": "Describes the configuration of a destination in Amazon S3.
", + "refs": { + "CreateDeliveryStreamInput$S3DestinationConfiguration": "The destination in Amazon S3. This value must be specified if ElasticsearchDestinationConfiguration or RedshiftDestinationConfiguration is specified (see restrictions listed above).
", + "ElasticsearchDestinationConfiguration$S3Configuration": null, + "RedshiftDestinationConfiguration$S3Configuration": "The S3 configuration for the intermediate location from which Amazon Redshift obtains data. Restrictions are described in the topic for CreateDeliveryStream.
The compression formats SNAPPY or ZIP cannot be specified in RedshiftDestinationConfiguration.S3Configuration because the Amazon Redshift COPY operation that reads from the S3 bucket doesn't support these compression formats.
Describes a destination in Amazon S3.
", + "refs": { + "DestinationDescription$S3DestinationDescription": "The Amazon S3 destination.
", + "ElasticsearchDestinationDescription$S3DestinationDescription": null, + "RedshiftDestinationDescription$S3DestinationDescription": "The Amazon S3 destination.
" + } + }, + "S3DestinationUpdate": { + "base": "Describes an update for a destination in Amazon S3.
", + "refs": { + "ElasticsearchDestinationUpdate$S3Update": null, + "RedshiftDestinationUpdate$S3Update": "The Amazon S3 destination.
The compression formats SNAPPY or ZIP cannot be specified in RedshiftDestinationUpdate.S3Update because the Amazon Redshift COPY operation that reads from the S3 bucket doesn't support these compression formats.
Describes an update for a destination in Amazon S3.
" + } + }, + "ServiceUnavailableException": { + "base": "The service is unavailable, back off and retry the operation. If you continue to see the exception, throughput limits for the delivery stream may have been exceeded. For more information about limits and how to request an increase, see Amazon Kinesis Firehose Limits.
", + "refs": { + } + }, + "SizeInMBs": { + "base": null, + "refs": { + "BufferingHints$SizeInMBs": "Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.
We recommend setting SizeInMBs to a value greater than the amount of data you typically ingest into the delivery stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec set SizeInMBs to be 10 MB or higher.
" + } + }, + "Timestamp": { + "base": null, + "refs": { + "DeliveryStreamDescription$CreateTimestamp": "The date and time that the delivery stream was created.
", + "DeliveryStreamDescription$LastUpdateTimestamp": "The date and time that the delivery stream was last updated.
" + } + }, + "UpdateDestinationInput": { + "base": "Contains the parameters for UpdateDestination.
", + "refs": { + } + }, + "UpdateDestinationOutput": { + "base": "Contains the output of UpdateDestination.
", + "refs": { + } + }, + "Username": { + "base": null, + "refs": { + "RedshiftDestinationConfiguration$Username": "The name of the user.
", + "RedshiftDestinationDescription$Username": "The name of the user.
", + "RedshiftDestinationUpdate$Username": "The name of the user.
" + } + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/gamelift/2015-10-01/api-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/gamelift/2015-10-01/api-2.json new file mode 100644 index 000000000..2ec85341b --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/gamelift/2015-10-01/api-2.json @@ -0,0 +1,2307 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2015-10-01", + "endpointPrefix":"gamelift", + "jsonVersion":"1.1", + "serviceFullName":"Amazon GameLift", + "signatureVersion":"v4", + "targetPrefix":"GameLift", + "protocol":"json" + }, + "operations":{ + "CreateAlias":{ + "name":"CreateAlias", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateAliasInput"}, + "output":{"shape":"CreateAliasOutput"}, + "errors":[ + { + "shape":"UnauthorizedException", + "exception":true + }, + { + "shape":"InvalidRequestException", + "exception":true + }, + { + "shape":"ConflictException", + "exception":true + }, + { + "shape":"InternalServiceException", + "exception":true, + "fault":true + }, + { + "shape":"LimitExceededException", + "exception":true + } + ] + }, + "CreateBuild":{ + "name":"CreateBuild", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateBuildInput"}, + "output":{"shape":"CreateBuildOutput"}, + "errors":[ + { + "shape":"UnauthorizedException", + "exception":true + }, + { + "shape":"InvalidRequestException", + "exception":true + }, + { + "shape":"ConflictException", + "exception":true + }, + { + "shape":"InternalServiceException", + "exception":true, + "fault":true + } + ] + }, + "CreateFleet":{ + "name":"CreateFleet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateFleetInput"}, + "output":{"shape":"CreateFleetOutput"}, + "errors":[ + { + "shape":"InternalServiceException", + "exception":true, + "fault":true + }, + { + "shape":"NotFoundException", + "exception":true + }, + { + "shape":"ConflictException", + "exception":true + }, + { + "shape":"LimitExceededException", + "exception":true + }, + { + "shape":"InvalidRequestException", + "exception":true + }, + { + "shape":"UnauthorizedException", + "exception":true + } + ] + }, + "CreateGameSession":{ + "name":"CreateGameSession", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateGameSessionInput"}, + "output":{"shape":"CreateGameSessionOutput"}, + "errors":[ + { + "shape":"ConflictException", + "exception":true + }, + { + "shape":"InternalServiceException", + "exception":true, + "fault":true + }, + { + "shape":"UnauthorizedException", + "exception":true + }, + { + "shape":"InvalidFleetStatusException", + "exception":true + }, + { + "shape":"TerminalRoutingStrategyException", + "exception":true + }, + { + "shape":"InvalidRequestException", + "exception":true + }, + { + "shape":"NotFoundException", + "exception":true + }, + { + "shape":"FleetCapacityExceededException", + "exception":true + } + ] + }, + "CreatePlayerSession":{ + "name":"CreatePlayerSession", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreatePlayerSessionInput"}, + "output":{"shape":"CreatePlayerSessionOutput"}, + "errors":[ + { + "shape":"InternalServiceException", + "exception":true, + "fault":true + }, + { + "shape":"UnauthorizedException", + "exception":true + }, + { + "shape":"InvalidGameSessionStatusException", + "exception":true + }, + { + "shape":"GameSessionFullException", + "exception":true + }, + { + "shape":"TerminalRoutingStrategyException", + "exception":true + }, + { + "shape":"InvalidRequestException", + "exception":true + }, + { + "shape":"NotFoundException", + "exception":true + } + ] + }, + "CreatePlayerSessions":{ + "name":"CreatePlayerSessions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreatePlayerSessionsInput"}, + "output":{"shape":"CreatePlayerSessionsOutput"}, + "errors":[ + { + "shape":"InternalServiceException", + "exception":true, + "fault":true + }, + { + "shape":"UnauthorizedException", + "exception":true + }, + { + "shape":"InvalidGameSessionStatusException", + "exception":true + }, + { + "shape":"GameSessionFullException", + "exception":true + }, + { + "shape":"TerminalRoutingStrategyException", + "exception":true + }, + { + "shape":"InvalidRequestException", + "exception":true + }, + { + "shape":"NotFoundException", + "exception":true + } + ] + }, + "DeleteAlias":{ + "name":"DeleteAlias", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteAliasInput"}, + "errors":[ + { + "shape":"UnauthorizedException", + "exception":true + }, + { + "shape":"NotFoundException", + "exception":true + }, + { + "shape":"InvalidRequestException", + "exception":true + }, + { + "shape":"InternalServiceException", + "exception":true, + "fault":true + } + ] + }, + "DeleteBuild":{ + "name":"DeleteBuild", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteBuildInput"}, + "errors":[ + { + "shape":"UnauthorizedException", + "exception":true + }, + { + "shape":"NotFoundException", + "exception":true + }, + { + "shape":"InternalServiceException", + "exception":true, + "fault":true + }, + { + "shape":"InvalidRequestException", + "exception":true + } + ] + }, + "DeleteFleet":{ + "name":"DeleteFleet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteFleetInput"}, + "errors":[ + { + "shape":"NotFoundException", + "exception":true + }, + { + "shape":"InternalServiceException", + "exception":true, + "fault":true + }, + { + "shape":"InvalidFleetStatusException", + "exception":true + }, + { + "shape":"UnauthorizedException", + "exception":true + }, + { + "shape":"InvalidRequestException", + "exception":true + } + ] + }, + "DeleteScalingPolicy":{ + "name":"DeleteScalingPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteScalingPolicyInput"}, + "errors":[ + { + "shape":"InternalServiceException", + "exception":true, + "fault":true + }, + { + "shape":"InvalidRequestException", + "exception":true + }, + { + "shape":"UnauthorizedException", + "exception":true + }, + { + "shape":"NotFoundException", + "exception":true + } + ] + }, + "DescribeAlias":{ + "name":"DescribeAlias", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAliasInput"}, + "output":{"shape":"DescribeAliasOutput"}, + "errors":[ + { + "shape":"UnauthorizedException", + "exception":true + }, + { + "shape":"InvalidRequestException", + "exception":true + }, + { + "shape":"NotFoundException", + "exception":true + }, + { + "shape":"InternalServiceException", + "exception":true, + "fault":true + } + ] + }, + "DescribeBuild":{ + "name":"DescribeBuild", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeBuildInput"}, + "output":{"shape":"DescribeBuildOutput"}, + "errors":[ + { + "shape":"UnauthorizedException", + "exception":true + }, + { + "shape":"InvalidRequestException", + "exception":true + }, + { + "shape":"NotFoundException", + "exception":true + }, + { + "shape":"InternalServiceException", + "exception":true, + "fault":true + } + ] + }, + "DescribeEC2InstanceLimits":{ + "name":"DescribeEC2InstanceLimits", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEC2InstanceLimitsInput"}, + "output":{"shape":"DescribeEC2InstanceLimitsOutput"}, + "errors":[ + { + "shape":"InvalidRequestException", + "exception":true + }, + { + "shape":"InternalServiceException", + "exception":true, + "fault":true + }, + { + "shape":"UnauthorizedException", + "exception":true + } + ] + }, + "DescribeFleetAttributes":{ + "name":"DescribeFleetAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeFleetAttributesInput"}, + "output":{"shape":"DescribeFleetAttributesOutput"}, + "errors":[ + { + "shape":"InternalServiceException", + "exception":true, + "fault":true + }, + { + "shape":"NotFoundException", + "exception":true + }, + { + "shape":"InvalidRequestException", + "exception":true + }, + { + "shape":"UnauthorizedException", + "exception":true + } + ] + }, + "DescribeFleetCapacity":{ + "name":"DescribeFleetCapacity", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeFleetCapacityInput"}, + "output":{"shape":"DescribeFleetCapacityOutput"}, + "errors":[ + { + "shape":"InternalServiceException", + "exception":true, + "fault":true + }, + { + "shape":"NotFoundException", + "exception":true + }, + { + "shape":"InvalidRequestException", + "exception":true + }, + { + "shape":"UnauthorizedException", + "exception":true + } + ] + }, + "DescribeFleetEvents":{ + "name":"DescribeFleetEvents", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeFleetEventsInput"}, + "output":{"shape":"DescribeFleetEventsOutput"}, + "errors":[ + { + "shape":"NotFoundException", + "exception":true + }, + { + "shape":"InternalServiceException", + "exception":true, + "fault":true + }, + { + "shape":"UnauthorizedException", + "exception":true + }, + { + "shape":"InvalidRequestException", + "exception":true + } + ] + }, + "DescribeFleetPortSettings":{ + "name":"DescribeFleetPortSettings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeFleetPortSettingsInput"}, + "output":{"shape":"DescribeFleetPortSettingsOutput"}, + "errors":[ + { + "shape":"InternalServiceException", + "exception":true, + "fault":true + }, + { + "shape":"NotFoundException", + "exception":true + }, + { + "shape":"InvalidRequestException", + "exception":true + }, + { + "shape":"UnauthorizedException", + "exception":true + } + ] + }, + "DescribeFleetUtilization":{ + "name":"DescribeFleetUtilization", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeFleetUtilizationInput"}, + "output":{"shape":"DescribeFleetUtilizationOutput"}, + "errors":[ + { + "shape":"InternalServiceException", + "exception":true, + "fault":true + }, + { + "shape":"NotFoundException", + "exception":true + }, + { + "shape":"InvalidRequestException", + "exception":true + }, + { + "shape":"UnauthorizedException", + "exception":true + } + ] + }, + "DescribeGameSessionDetails":{ + "name":"DescribeGameSessionDetails", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeGameSessionDetailsInput"}, + "output":{"shape":"DescribeGameSessionDetailsOutput"}, + "errors":[ + { + "shape":"InternalServiceException", + "exception":true, + "fault":true + }, + { + "shape":"NotFoundException", + "exception":true + }, + { + "shape":"InvalidRequestException", + "exception":true + }, + { + "shape":"UnauthorizedException", + "exception":true + }, + { + "shape":"TerminalRoutingStrategyException", + "exception":true + } + ] + }, + "DescribeGameSessions":{ + "name":"DescribeGameSessions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeGameSessionsInput"}, + "output":{"shape":"DescribeGameSessionsOutput"}, + "errors":[ + { + "shape":"InternalServiceException", + "exception":true, + "fault":true + }, + { + "shape":"NotFoundException", + "exception":true + }, + { + "shape":"InvalidRequestException", + "exception":true + }, + { + "shape":"UnauthorizedException", + "exception":true + }, + { + "shape":"TerminalRoutingStrategyException", + "exception":true + } + ] + }, + "DescribePlayerSessions":{ + "name":"DescribePlayerSessions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribePlayerSessionsInput"}, + "output":{"shape":"DescribePlayerSessionsOutput"}, + "errors":[ + { + "shape":"InternalServiceException", + "exception":true, + "fault":true + }, + { + "shape":"NotFoundException", + "exception":true + }, + { + "shape":"InvalidRequestException", + "exception":true + }, + { + "shape":"UnauthorizedException", + "exception":true + } + ] + }, + "DescribeRuntimeConfiguration":{ + "name":"DescribeRuntimeConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeRuntimeConfigurationInput"}, + "output":{"shape":"DescribeRuntimeConfigurationOutput"}, + "errors":[ + { + "shape":"UnauthorizedException", + "exception":true + }, + { + "shape":"NotFoundException", + "exception":true + }, + { + "shape":"InternalServiceException", + "exception":true, + "fault":true + }, + { + "shape":"InvalidRequestException", + "exception":true + } + ] + }, + "DescribeScalingPolicies":{ + "name":"DescribeScalingPolicies", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeScalingPoliciesInput"}, + "output":{"shape":"DescribeScalingPoliciesOutput"}, + "errors":[ + { + "shape":"InternalServiceException", + "exception":true, + "fault":true + }, + { + "shape":"InvalidRequestException", + "exception":true + }, + { + "shape":"UnauthorizedException", + "exception":true + }, + { + "shape":"NotFoundException", + "exception":true + } + ] + }, + "GetGameSessionLogUrl":{ + "name":"GetGameSessionLogUrl", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetGameSessionLogUrlInput"}, + "output":{"shape":"GetGameSessionLogUrlOutput"}, + "errors":[ + { + "shape":"InternalServiceException", + "exception":true, + "fault":true + }, + { + "shape":"NotFoundException", + "exception":true + }, + { + "shape":"UnauthorizedException", + "exception":true + }, + { + "shape":"InvalidRequestException", + "exception":true + } + ] + }, + "ListAliases":{ + "name":"ListAliases", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAliasesInput"}, + "output":{"shape":"ListAliasesOutput"}, + "errors":[ + { + "shape":"UnauthorizedException", + "exception":true + }, + { + "shape":"InvalidRequestException", + "exception":true + }, + { + "shape":"InternalServiceException", + "exception":true, + "fault":true + } + ] + }, + "ListBuilds":{ + "name":"ListBuilds", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListBuildsInput"}, + "output":{"shape":"ListBuildsOutput"}, + "errors":[ + { + "shape":"UnauthorizedException", + "exception":true + }, + { + "shape":"InvalidRequestException", + "exception":true + }, + { + "shape":"InternalServiceException", + "exception":true, + "fault":true + } + ] + }, + "ListFleets":{ + "name":"ListFleets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListFleetsInput"}, + "output":{"shape":"ListFleetsOutput"}, + "errors":[ + { + "shape":"InternalServiceException", + "exception":true, + "fault":true + }, + { + "shape":"NotFoundException", + "exception":true + }, + { + "shape":"InvalidRequestException", + "exception":true + }, + { + "shape":"UnauthorizedException", + "exception":true + } + ] + }, + "PutScalingPolicy":{ + "name":"PutScalingPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutScalingPolicyInput"}, + "output":{"shape":"PutScalingPolicyOutput"}, + "errors":[ + { + "shape":"InternalServiceException", + "exception":true, + "fault":true + }, + { + "shape":"InvalidRequestException", + "exception":true + }, + { + "shape":"UnauthorizedException", + "exception":true + }, + { + "shape":"NotFoundException", + "exception":true + } + ] + }, + "RequestUploadCredentials":{ + "name":"RequestUploadCredentials", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RequestUploadCredentialsInput"}, + "output":{"shape":"RequestUploadCredentialsOutput"}, + "errors":[ + { + "shape":"UnauthorizedException", + "exception":true + }, + { + "shape":"InvalidRequestException", + "exception":true + }, + { + "shape":"NotFoundException", + "exception":true + }, + { + "shape":"InternalServiceException", + "exception":true, + "fault":true + } + ] + }, + "ResolveAlias":{ + "name":"ResolveAlias", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResolveAliasInput"}, + "output":{"shape":"ResolveAliasOutput"}, + "errors":[ + { + "shape":"UnauthorizedException", + "exception":true + }, + { + "shape":"InvalidRequestException", + "exception":true + }, + { + "shape":"NotFoundException", + "exception":true + }, + { + "shape":"TerminalRoutingStrategyException", + "exception":true + }, + { + "shape":"InternalServiceException", + "exception":true, + "fault":true + } + ] + }, + "UpdateAlias":{ + "name":"UpdateAlias", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateAliasInput"}, + "output":{"shape":"UpdateAliasOutput"}, + "errors":[ + { + "shape":"UnauthorizedException", + "exception":true + }, + { + "shape":"InvalidRequestException", + "exception":true + }, + { + "shape":"NotFoundException", + "exception":true + }, + { + "shape":"InternalServiceException", + "exception":true, + "fault":true + } + ] + }, + "UpdateBuild":{ + "name":"UpdateBuild", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateBuildInput"}, + "output":{"shape":"UpdateBuildOutput"}, + "errors":[ + { + "shape":"UnauthorizedException", + "exception":true + }, + { + "shape":"InvalidRequestException", + "exception":true + }, + { + "shape":"NotFoundException", + "exception":true + }, + { + "shape":"InternalServiceException", + "exception":true, + "fault":true + } + ] + }, + "UpdateFleetAttributes":{ + "name":"UpdateFleetAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateFleetAttributesInput"}, + "output":{"shape":"UpdateFleetAttributesOutput"}, + "errors":[ + { + "shape":"NotFoundException", + "exception":true + }, + { + "shape":"ConflictException", + "exception":true + }, + { + "shape":"InvalidFleetStatusException", + "exception":true + }, + { + "shape":"LimitExceededException", + "exception":true + }, + { + "shape":"InternalServiceException", + "exception":true, + "fault":true + }, + { + "shape":"InvalidRequestException", + "exception":true + }, + { + "shape":"UnauthorizedException", + "exception":true + } + ] + }, + "UpdateFleetCapacity":{ + "name":"UpdateFleetCapacity", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateFleetCapacityInput"}, + "output":{"shape":"UpdateFleetCapacityOutput"}, + "errors":[ + { + "shape":"NotFoundException", + "exception":true + }, + { + "shape":"ConflictException", + "exception":true + }, + { + "shape":"LimitExceededException", + "exception":true + }, + { + "shape":"InvalidFleetStatusException", + "exception":true + }, + { + "shape":"InternalServiceException", + "exception":true, + "fault":true + }, + { + "shape":"InvalidRequestException", + "exception":true + }, + { + "shape":"UnauthorizedException", + "exception":true + } + ] + }, + "UpdateFleetPortSettings":{ + "name":"UpdateFleetPortSettings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateFleetPortSettingsInput"}, + "output":{"shape":"UpdateFleetPortSettingsOutput"}, + "errors":[ + { + "shape":"NotFoundException", + "exception":true + }, + { + "shape":"ConflictException", + "exception":true + }, + { + "shape":"InvalidFleetStatusException", + "exception":true + }, + { + "shape":"LimitExceededException", + "exception":true + }, + { + "shape":"InternalServiceException", + "exception":true, + "fault":true + }, + { + "shape":"InvalidRequestException", + "exception":true + }, + { + "shape":"UnauthorizedException", + "exception":true + } + ] + }, + "UpdateGameSession":{ + "name":"UpdateGameSession", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateGameSessionInput"}, + "output":{"shape":"UpdateGameSessionOutput"}, + "errors":[ + { + "shape":"NotFoundException", + "exception":true + }, + { + "shape":"ConflictException", + "exception":true + }, + { + "shape":"InternalServiceException", + "exception":true, + "fault":true + }, + { + "shape":"UnauthorizedException", + "exception":true + }, + { + "shape":"InvalidGameSessionStatusException", + "exception":true + }, + { + "shape":"InvalidRequestException", + "exception":true + } + ] + }, + "UpdateRuntimeConfiguration":{ + "name":"UpdateRuntimeConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateRuntimeConfigurationInput"}, + "output":{"shape":"UpdateRuntimeConfigurationOutput"}, + "errors":[ + { + "shape":"UnauthorizedException", + "exception":true + }, + { + "shape":"NotFoundException", + "exception":true + }, + { + "shape":"InternalServiceException", + "exception":true, + "fault":true + }, + { + "shape":"InvalidRequestException", + "exception":true + }, + { + "shape":"InvalidFleetStatusException", + "exception":true + } + ] + } + }, + "shapes":{ + "Alias":{ + "type":"structure", + "members":{ + "AliasId":{"shape":"AliasId"}, + "Name":{"shape":"FreeText"}, + "Description":{"shape":"FreeText"}, + "RoutingStrategy":{"shape":"RoutingStrategy"}, + "CreationTime":{"shape":"Timestamp"}, + "LastUpdatedTime":{"shape":"Timestamp"} + } + }, + "AliasId":{ + "type":"string", + "pattern":"^alias-\\S+" + }, + "AliasList":{ + "type":"list", + "member":{"shape":"Alias"} + }, + "AwsCredentials":{ + "type":"structure", + "members":{ + "AccessKeyId":{"shape":"NonEmptyString"}, + "SecretAccessKey":{"shape":"NonEmptyString"}, + "SessionToken":{"shape":"NonEmptyString"} + }, + "sensitive":true + }, + "Build":{ + "type":"structure", + "members":{ + "BuildId":{"shape":"BuildId"}, + "Name":{"shape":"FreeText"}, + "Version":{"shape":"FreeText"}, + "Status":{"shape":"BuildStatus"}, + "SizeOnDisk":{"shape":"PositiveLong"}, + "CreationTime":{"shape":"Timestamp"} + } + }, + "BuildId":{ + "type":"string", + "pattern":"^build-\\S+" + }, + "BuildList":{ + "type":"list", + "member":{"shape":"Build"} + }, + "BuildStatus":{ + "type":"string", + "enum":[ + "INITIALIZED", + "READY", + "FAILED" + ] + }, + "ComparisonOperatorType":{ + "type":"string", + "enum":[ + "GreaterThanOrEqualToThreshold", + "GreaterThanThreshold", + "LessThanThreshold", + "LessThanOrEqualToThreshold" + ] + }, + "ConflictException":{ + "type":"structure", + "members":{ + "Message":{"shape":"NonEmptyString"} + }, + "exception":true + }, + "CreateAliasInput":{ + "type":"structure", + "required":[ + "Name", + "RoutingStrategy" + ], + "members":{ + "Name":{"shape":"NonZeroAndMaxString"}, + "Description":{"shape":"NonZeroAndMaxString"}, + "RoutingStrategy":{"shape":"RoutingStrategy"} + } + }, + "CreateAliasOutput":{ + "type":"structure", + "members":{ + "Alias":{"shape":"Alias"} + } + }, + "CreateBuildInput":{ + "type":"structure", + "members":{ + "Name":{"shape":"NonZeroAndMaxString"}, + "Version":{"shape":"NonZeroAndMaxString"}, + "StorageLocation":{"shape":"S3Location"} + } + }, + "CreateBuildOutput":{ + "type":"structure", + "members":{ + "Build":{"shape":"Build"}, + "UploadCredentials":{"shape":"AwsCredentials"}, + "StorageLocation":{"shape":"S3Location"} + } + }, + "CreateFleetInput":{ + "type":"structure", + "required":[ + "Name", + "BuildId", + "EC2InstanceType" + ], + "members":{ + "Name":{"shape":"NonZeroAndMaxString"}, + "Description":{"shape":"NonZeroAndMaxString"}, + "BuildId":{"shape":"BuildId"}, + "ServerLaunchPath":{"shape":"NonZeroAndMaxString"}, + "ServerLaunchParameters":{"shape":"NonZeroAndMaxString"}, + "LogPaths":{"shape":"StringList"}, + "EC2InstanceType":{"shape":"EC2InstanceType"}, + "EC2InboundPermissions":{"shape":"IpPermissionsList"}, + "NewGameSessionProtectionPolicy":{"shape":"ProtectionPolicy"}, + "RuntimeConfiguration":{"shape":"RuntimeConfiguration"} + } + }, + "CreateFleetOutput":{ + "type":"structure", + "members":{ + "FleetAttributes":{"shape":"FleetAttributes"} + } + }, + "CreateGameSessionInput":{ + "type":"structure", + "required":["MaximumPlayerSessionCount"], + "members":{ + "FleetId":{"shape":"FleetId"}, + "AliasId":{"shape":"AliasId"}, + "MaximumPlayerSessionCount":{"shape":"WholeNumber"}, + "Name":{"shape":"NonZeroAndMaxString"}, + "GameProperties":{"shape":"GamePropertyList"} + } + }, + "CreateGameSessionOutput":{ + "type":"structure", + "members":{ + "GameSession":{"shape":"GameSession"} + } + }, + "CreatePlayerSessionInput":{ + "type":"structure", + "required":[ + "GameSessionId", + "PlayerId" + ], + "members":{ + "GameSessionId":{"shape":"GameSessionId"}, + "PlayerId":{"shape":"NonZeroAndMaxString"} + } + }, + "CreatePlayerSessionOutput":{ + "type":"structure", + "members":{ + "PlayerSession":{"shape":"PlayerSession"} + } + }, + "CreatePlayerSessionsInput":{ + "type":"structure", + "required":[ + "GameSessionId", + "PlayerIds" + ], + "members":{ + "GameSessionId":{"shape":"GameSessionId"}, + "PlayerIds":{"shape":"PlayerIdList"} + } + }, + "CreatePlayerSessionsOutput":{ + "type":"structure", + "members":{ + "PlayerSessions":{"shape":"PlayerSessionList"} + } + }, + "DeleteAliasInput":{ + "type":"structure", + "required":["AliasId"], + "members":{ + "AliasId":{"shape":"AliasId"} + } + }, + "DeleteBuildInput":{ + "type":"structure", + "required":["BuildId"], + "members":{ + "BuildId":{"shape":"BuildId"} + } + }, + "DeleteFleetInput":{ + "type":"structure", + "required":["FleetId"], + "members":{ + "FleetId":{"shape":"FleetId"} + } + }, + "DeleteScalingPolicyInput":{ + "type":"structure", + "required":[ + "Name", + "FleetId" + ], + "members":{ + "Name":{"shape":"NonZeroAndMaxString"}, + "FleetId":{"shape":"FleetId"} + } + }, + "DescribeAliasInput":{ + "type":"structure", + "required":["AliasId"], + "members":{ + "AliasId":{"shape":"AliasId"} + } + }, + "DescribeAliasOutput":{ + "type":"structure", + "members":{ + "Alias":{"shape":"Alias"} + } + }, + "DescribeBuildInput":{ + "type":"structure", + "required":["BuildId"], + "members":{ + "BuildId":{"shape":"BuildId"} + } + }, + "DescribeBuildOutput":{ + "type":"structure", + "members":{ + "Build":{"shape":"Build"} + } + }, + "DescribeEC2InstanceLimitsInput":{ + "type":"structure", + "members":{ + "EC2InstanceType":{"shape":"EC2InstanceType"} + } + }, + "DescribeEC2InstanceLimitsOutput":{ + "type":"structure", + "members":{ + "EC2InstanceLimits":{"shape":"EC2InstanceLimitList"} + } + }, + "DescribeFleetAttributesInput":{ + "type":"structure", + "members":{ + "FleetIds":{"shape":"FleetIdList"}, + "Limit":{"shape":"PositiveInteger"}, + "NextToken":{"shape":"NonZeroAndMaxString"} + } + }, + "DescribeFleetAttributesOutput":{ + "type":"structure", + "members":{ + "FleetAttributes":{"shape":"FleetAttributesList"}, + "NextToken":{"shape":"NonZeroAndMaxString"} + } + }, + "DescribeFleetCapacityInput":{ + "type":"structure", + "members":{ + "FleetIds":{"shape":"FleetIdList"}, + "Limit":{"shape":"PositiveInteger"}, + "NextToken":{"shape":"NonZeroAndMaxString"} + } + }, + "DescribeFleetCapacityOutput":{ + "type":"structure", + "members":{ + "FleetCapacity":{"shape":"FleetCapacityList"}, + "NextToken":{"shape":"NonZeroAndMaxString"} + } + }, + "DescribeFleetEventsInput":{ + "type":"structure", + "required":["FleetId"], + "members":{ + "FleetId":{"shape":"FleetId"}, + "StartTime":{"shape":"Timestamp"}, + "EndTime":{"shape":"Timestamp"}, + "Limit":{"shape":"PositiveInteger"}, + "NextToken":{"shape":"NonZeroAndMaxString"} + } + }, + "DescribeFleetEventsOutput":{ + "type":"structure", + "members":{ + "Events":{"shape":"EventList"}, + "NextToken":{"shape":"NonZeroAndMaxString"} + } + }, + "DescribeFleetPortSettingsInput":{ + "type":"structure", + "required":["FleetId"], + "members":{ + "FleetId":{"shape":"FleetId"} + } + }, + "DescribeFleetPortSettingsOutput":{ + "type":"structure", + "members":{ + "InboundPermissions":{"shape":"IpPermissionsList"} + } + }, + "DescribeFleetUtilizationInput":{ + "type":"structure", + "members":{ + "FleetIds":{"shape":"FleetIdList"}, + "Limit":{"shape":"PositiveInteger"}, + "NextToken":{"shape":"NonZeroAndMaxString"} + } + }, + "DescribeFleetUtilizationOutput":{ + "type":"structure", + "members":{ + "FleetUtilization":{"shape":"FleetUtilizationList"}, + "NextToken":{"shape":"NonZeroAndMaxString"} + } + }, + "DescribeGameSessionDetailsInput":{ + "type":"structure", + "members":{ + "FleetId":{"shape":"FleetId"}, + "GameSessionId":{"shape":"GameSessionId"}, + "AliasId":{"shape":"AliasId"}, + "StatusFilter":{"shape":"NonZeroAndMaxString"}, + "Limit":{"shape":"PositiveInteger"}, + "NextToken":{"shape":"NonZeroAndMaxString"} + } + }, + "DescribeGameSessionDetailsOutput":{ + "type":"structure", + "members":{ + "GameSessionDetails":{"shape":"GameSessionDetailList"}, + "NextToken":{"shape":"NonZeroAndMaxString"} + } + }, + "DescribeGameSessionsInput":{ + "type":"structure", + "members":{ + "FleetId":{"shape":"FleetId"}, + "GameSessionId":{"shape":"GameSessionId"}, + "AliasId":{"shape":"AliasId"}, + "StatusFilter":{"shape":"NonZeroAndMaxString"}, + "Limit":{"shape":"PositiveInteger"}, + "NextToken":{"shape":"NonZeroAndMaxString"} + } + }, + "DescribeGameSessionsOutput":{ + "type":"structure", + "members":{ + "GameSessions":{"shape":"GameSessionList"}, + "NextToken":{"shape":"NonZeroAndMaxString"} + } + }, + "DescribePlayerSessionsInput":{ + "type":"structure", + "members":{ + "GameSessionId":{"shape":"GameSessionId"}, + "PlayerId":{"shape":"NonZeroAndMaxString"}, + "PlayerSessionId":{"shape":"PlayerSessionId"}, + "PlayerSessionStatusFilter":{"shape":"NonZeroAndMaxString"}, + "Limit":{"shape":"PositiveInteger"}, + "NextToken":{"shape":"NonZeroAndMaxString"} + } + }, + "DescribePlayerSessionsOutput":{ + "type":"structure", + "members":{ + "PlayerSessions":{"shape":"PlayerSessionList"}, + "NextToken":{"shape":"NonZeroAndMaxString"} + } + }, + "DescribeRuntimeConfigurationInput":{ + "type":"structure", + "required":["FleetId"], + "members":{ + "FleetId":{"shape":"FleetId"} + } + }, + "DescribeRuntimeConfigurationOutput":{ + "type":"structure", + "members":{ + "RuntimeConfiguration":{"shape":"RuntimeConfiguration"} + } + }, + "DescribeScalingPoliciesInput":{ + "type":"structure", + "required":["FleetId"], + "members":{ + "FleetId":{"shape":"FleetId"}, + "StatusFilter":{"shape":"ScalingStatusType"}, + "Limit":{"shape":"PositiveInteger"}, + "NextToken":{"shape":"NonZeroAndMaxString"} + } + }, + "DescribeScalingPoliciesOutput":{ + "type":"structure", + "members":{ + "ScalingPolicies":{"shape":"ScalingPolicyList"}, + "NextToken":{"shape":"NonZeroAndMaxString"} + } + }, + "Double":{"type":"double"}, + "EC2InstanceCounts":{ + "type":"structure", + "members":{ + "DESIRED":{"shape":"WholeNumber"}, + "MINIMUM":{"shape":"WholeNumber"}, + "MAXIMUM":{"shape":"WholeNumber"}, + "PENDING":{"shape":"WholeNumber"}, + "ACTIVE":{"shape":"WholeNumber"}, + "IDLE":{"shape":"WholeNumber"}, + "TERMINATING":{"shape":"WholeNumber"} + } + }, + "EC2InstanceLimit":{ + "type":"structure", + "members":{ + "EC2InstanceType":{"shape":"EC2InstanceType"}, + "CurrentInstances":{"shape":"WholeNumber"}, + "InstanceLimit":{"shape":"WholeNumber"} + } + }, + "EC2InstanceLimitList":{ + "type":"list", + "member":{"shape":"EC2InstanceLimit"} + }, + "EC2InstanceType":{ + "type":"string", + "enum":[ + "t2.micro", + "t2.small", + "t2.medium", + "t2.large", + "c3.large", + "c3.xlarge", + "c3.2xlarge", + "c3.4xlarge", + "c3.8xlarge", + "c4.large", + "c4.xlarge", + "c4.2xlarge", + "c4.4xlarge", + "c4.8xlarge", + "r3.large", + "r3.xlarge", + "r3.2xlarge", + "r3.4xlarge", + "r3.8xlarge", + "m3.medium", + "m3.large", + "m3.xlarge", + "m3.2xlarge", + "m4.large", + "m4.xlarge", + "m4.2xlarge", + "m4.4xlarge", + "m4.10xlarge" + ] + }, + "Event":{ + "type":"structure", + "members":{ + "EventId":{"shape":"NonZeroAndMaxString"}, + "ResourceId":{"shape":"NonZeroAndMaxString"}, + "EventCode":{"shape":"EventCode"}, + "Message":{"shape":"NonEmptyString"}, + "EventTime":{"shape":"Timestamp"} + } + }, + "EventCode":{ + "type":"string", + "enum":[ + "GENERIC_EVENT", + "FLEET_CREATED", + "FLEET_DELETED", + "FLEET_SCALING_EVENT", + "FLEET_STATE_DOWNLOADING", + "FLEET_STATE_VALIDATING", + "FLEET_STATE_BUILDING", + "FLEET_STATE_ACTIVATING", + "FLEET_STATE_ACTIVE", + "FLEET_STATE_ERROR", + "FLEET_INITIALIZATION_FAILED", + "FLEET_BINARY_DOWNLOAD_FAILED", + "FLEET_VALIDATION_LAUNCH_PATH_NOT_FOUND", + "FLEET_VALIDATION_EXECUTABLE_RUNTIME_FAILURE", + "FLEET_VALIDATION_TIMED_OUT", + "FLEET_ACTIVATION_FAILED", + "FLEET_ACTIVATION_FAILED_NO_INSTANCES", + "FLEET_NEW_GAME_SESSION_PROTECTION_POLICY_UPDATED" + ] + }, + "EventList":{ + "type":"list", + "member":{"shape":"Event"} + }, + "FleetAttributes":{ + "type":"structure", + "members":{ + "FleetId":{"shape":"FleetId"}, + "Description":{"shape":"NonZeroAndMaxString"}, + "Name":{"shape":"NonZeroAndMaxString"}, + "CreationTime":{"shape":"Timestamp"}, + "TerminationTime":{"shape":"Timestamp"}, + "Status":{"shape":"FleetStatus"}, + "BuildId":{"shape":"BuildId"}, + "ServerLaunchPath":{"shape":"NonZeroAndMaxString"}, + "ServerLaunchParameters":{"shape":"NonZeroAndMaxString"}, + "LogPaths":{"shape":"StringList"}, + "NewGameSessionProtectionPolicy":{"shape":"ProtectionPolicy"} + } + }, + "FleetAttributesList":{ + "type":"list", + "member":{"shape":"FleetAttributes"} + }, + "FleetCapacity":{ + "type":"structure", + "members":{ + "FleetId":{"shape":"FleetId"}, + "InstanceType":{"shape":"EC2InstanceType"}, + "InstanceCounts":{"shape":"EC2InstanceCounts"} + } + }, + "FleetCapacityExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"NonEmptyString"} + }, + "exception":true + }, + "FleetCapacityList":{ + "type":"list", + "member":{"shape":"FleetCapacity"} + }, + "FleetId":{ + "type":"string", + "pattern":"^fleet-\\S+" + }, + "FleetIdList":{ + "type":"list", + "member":{"shape":"FleetId"}, + "min":1 + }, + "FleetStatus":{ + "type":"string", + "enum":[ + "NEW", + "DOWNLOADING", + "VALIDATING", + "BUILDING", + "ACTIVATING", + "ACTIVE", + "DELETING", + "ERROR", + "TERMINATED" + ] + }, + "FleetUtilization":{ + "type":"structure", + "members":{ + "FleetId":{"shape":"FleetId"}, + "ActiveServerProcessCount":{"shape":"WholeNumber"}, + "ActiveGameSessionCount":{"shape":"WholeNumber"}, + "CurrentPlayerSessionCount":{"shape":"WholeNumber"}, + "MaximumPlayerSessionCount":{"shape":"WholeNumber"} + } + }, + "FleetUtilizationList":{ + "type":"list", + "member":{"shape":"FleetUtilization"} + }, + "FreeText":{"type":"string"}, + "GameProperty":{ + "type":"structure", + "required":[ + "Key", + "Value" + ], + "members":{ + "Key":{"shape":"GamePropertyKey"}, + "Value":{"shape":"GamePropertyValue"} + } + }, + "GamePropertyKey":{ + "type":"string", + "max":32 + }, + "GamePropertyList":{ + "type":"list", + "member":{"shape":"GameProperty"}, + "max":16 + }, + "GamePropertyValue":{ + "type":"string", + "max":96 + }, + "GameSession":{ + "type":"structure", + "members":{ + "GameSessionId":{"shape":"GameSessionId"}, + "Name":{"shape":"NonZeroAndMaxString"}, + "FleetId":{"shape":"FleetId"}, + "CreationTime":{"shape":"Timestamp"}, + "TerminationTime":{"shape":"Timestamp"}, + "CurrentPlayerSessionCount":{"shape":"WholeNumber"}, + "MaximumPlayerSessionCount":{"shape":"WholeNumber"}, + "Status":{"shape":"GameSessionStatus"}, + "GameProperties":{"shape":"GamePropertyList"}, + "IpAddress":{"shape":"IpAddress"}, + "Port":{"shape":"PortNumber"}, + "PlayerSessionCreationPolicy":{"shape":"PlayerSessionCreationPolicy"} + } + }, + "GameSessionDetail":{ + "type":"structure", + "members":{ + "GameSession":{"shape":"GameSession"}, + "ProtectionPolicy":{"shape":"ProtectionPolicy"} + } + }, + "GameSessionDetailList":{ + "type":"list", + "member":{"shape":"GameSessionDetail"} + }, + "GameSessionFullException":{ + "type":"structure", + "members":{ + "Message":{"shape":"NonEmptyString"} + }, + "exception":true + }, + "GameSessionId":{ + "type":"string", + "pattern":"^(gamei-|gsess-)\\S+" + }, + "GameSessionList":{ + "type":"list", + "member":{"shape":"GameSession"} + }, + "GameSessionStatus":{ + "type":"string", + "enum":[ + "ACTIVE", + "ACTIVATING", + "TERMINATED", + "TERMINATING" + ] + }, + "GetGameSessionLogUrlInput":{ + "type":"structure", + "required":["GameSessionId"], + "members":{ + "GameSessionId":{"shape":"GameSessionId"} + } + }, + "GetGameSessionLogUrlOutput":{ + "type":"structure", + "members":{ + "PreSignedUrl":{"shape":"NonZeroAndMaxString"} + } + }, + "Integer":{"type":"integer"}, + "InternalServiceException":{ + "type":"structure", + "members":{ + "Message":{"shape":"NonEmptyString"} + }, + "exception":true, + "fault":true + }, + "InvalidFleetStatusException":{ + "type":"structure", + "members":{ + "Message":{"shape":"NonEmptyString"} + }, + "exception":true + }, + "InvalidGameSessionStatusException":{ + "type":"structure", + "members":{ + "Message":{"shape":"NonEmptyString"} + }, + "exception":true + }, + "InvalidRequestException":{ + "type":"structure", + "members":{ + "Message":{"shape":"NonEmptyString"} + }, + "exception":true + }, + "IpAddress":{"type":"string"}, + "IpPermission":{ + "type":"structure", + "required":[ + "FromPort", + "ToPort", + "IpRange", + "Protocol" + ], + "members":{ + "FromPort":{"shape":"PortNumber"}, + "ToPort":{"shape":"PortNumber"}, + "IpRange":{"shape":"NonBlankString"}, + "Protocol":{"shape":"IpProtocol"} + } + }, + "IpPermissionsList":{ + "type":"list", + "member":{"shape":"IpPermission"}, + "max":50 + }, + "IpProtocol":{ + "type":"string", + "enum":[ + "TCP", + "UDP" + ] + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"NonEmptyString"} + }, + "exception":true + }, + "ListAliasesInput":{ + "type":"structure", + "members":{ + "RoutingStrategyType":{"shape":"RoutingStrategyType"}, + "Name":{"shape":"NonEmptyString"}, + "Limit":{"shape":"PositiveInteger"}, + "NextToken":{"shape":"NonEmptyString"} + } + }, + "ListAliasesOutput":{ + "type":"structure", + "members":{ + "Aliases":{"shape":"AliasList"}, + "NextToken":{"shape":"NonEmptyString"} + } + }, + "ListBuildsInput":{ + "type":"structure", + "members":{ + "Status":{"shape":"BuildStatus"}, + "Limit":{"shape":"PositiveInteger"}, + "NextToken":{"shape":"NonEmptyString"} + } + }, + "ListBuildsOutput":{ + "type":"structure", + "members":{ + "Builds":{"shape":"BuildList"}, + "NextToken":{"shape":"NonEmptyString"} + } + }, + "ListFleetsInput":{ + "type":"structure", + "members":{ + "BuildId":{"shape":"BuildId"}, + "Limit":{"shape":"PositiveInteger"}, + "NextToken":{"shape":"NonZeroAndMaxString"} + } + }, + "ListFleetsOutput":{ + "type":"structure", + "members":{ + "FleetIds":{"shape":"FleetIdList"}, + "NextToken":{"shape":"NonZeroAndMaxString"} + } + }, + "MetricName":{ + "type":"string", + "enum":[ + "ActivatingGameSessions", + "ActiveGameSessions", + "ActiveInstances", + "AvailablePlayerSessions", + "CurrentPlayerSessions", + "IdleInstances" + ] + }, + "NonBlankString":{ + "type":"string", + "pattern":"[^\\s]+" + }, + "NonEmptyString":{ + "type":"string", + "min":1 + }, + "NonZeroAndMaxString":{ + "type":"string", + "min":1, + "max":1024 + }, + "NotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"NonEmptyString"} + }, + "exception":true + }, + "PlayerIdList":{ + "type":"list", + "member":{"shape":"NonZeroAndMaxString"}, + "min":1, + "max":25 + }, + "PlayerSession":{ + "type":"structure", + "members":{ + "PlayerSessionId":{"shape":"PlayerSessionId"}, + "PlayerId":{"shape":"NonZeroAndMaxString"}, + "GameSessionId":{"shape":"GameSessionId"}, + "FleetId":{"shape":"FleetId"}, + "CreationTime":{"shape":"Timestamp"}, + "TerminationTime":{"shape":"Timestamp"}, + "Status":{"shape":"PlayerSessionStatus"}, + "IpAddress":{"shape":"IpAddress"}, + "Port":{"shape":"PortNumber"} + } + }, + "PlayerSessionCreationPolicy":{ + "type":"string", + "enum":[ + "ACCEPT_ALL", + "DENY_ALL" + ] + }, + "PlayerSessionId":{ + "type":"string", + "pattern":"^psess-\\S+" + }, + "PlayerSessionList":{ + "type":"list", + "member":{"shape":"PlayerSession"} + }, + "PlayerSessionStatus":{ + "type":"string", + "enum":[ + "RESERVED", + "ACTIVE", + "COMPLETED", + "TIMEDOUT" + ] + }, + "PortNumber":{ + "type":"integer", + "min":1025, + "max":60000 + }, + "PositiveInteger":{ + "type":"integer", + "min":1 + }, + "PositiveLong":{ + "type":"long", + "min":1 + }, + "ProtectionPolicy":{ + "type":"string", + "enum":[ + "NoProtection", + "FullProtection" + ] + }, + "PutScalingPolicyInput":{ + "type":"structure", + "required":[ + "Name", + "FleetId", + "ScalingAdjustment", + "ScalingAdjustmentType", + "Threshold", + "ComparisonOperator", + "EvaluationPeriods", + "MetricName" + ], + "members":{ + "Name":{"shape":"NonZeroAndMaxString"}, + "FleetId":{"shape":"FleetId"}, + "ScalingAdjustment":{"shape":"Integer"}, + "ScalingAdjustmentType":{"shape":"ScalingAdjustmentType"}, + "Threshold":{"shape":"Double"}, + "ComparisonOperator":{"shape":"ComparisonOperatorType"}, + "EvaluationPeriods":{"shape":"PositiveInteger"}, + "MetricName":{"shape":"MetricName"} + } + }, + "PutScalingPolicyOutput":{ + "type":"structure", + "members":{ + "Name":{"shape":"NonZeroAndMaxString"} + } + }, + "RequestUploadCredentialsInput":{ + "type":"structure", + "required":["BuildId"], + "members":{ + "BuildId":{"shape":"BuildId"} + } + }, + "RequestUploadCredentialsOutput":{ + "type":"structure", + "members":{ + "UploadCredentials":{"shape":"AwsCredentials"}, + "StorageLocation":{"shape":"S3Location"} + } + }, + "ResolveAliasInput":{ + "type":"structure", + "required":["AliasId"], + "members":{ + "AliasId":{"shape":"AliasId"} + } + }, + "ResolveAliasOutput":{ + "type":"structure", + "members":{ + "FleetId":{"shape":"FleetId"} + } + }, + "RoutingStrategy":{ + "type":"structure", + "members":{ + "Type":{"shape":"RoutingStrategyType"}, + "FleetId":{"shape":"FleetId"}, + "Message":{"shape":"FreeText"} + } + }, + "RoutingStrategyType":{ + "type":"string", + "enum":[ + "SIMPLE", + "TERMINAL" + ] + }, + "RuntimeConfiguration":{ + "type":"structure", + "members":{ + "ServerProcesses":{"shape":"ServerProcessList"} + } + }, + "S3Location":{ + "type":"structure", + "members":{ + "Bucket":{"shape":"NonEmptyString"}, + "Key":{"shape":"NonEmptyString"}, + "RoleArn":{"shape":"NonEmptyString"} + } + }, + "ScalingAdjustmentType":{ + "type":"string", + "enum":[ + "ChangeInCapacity", + "ExactCapacity", + "PercentChangeInCapacity" + ] + }, + "ScalingPolicy":{ + "type":"structure", + "members":{ + "FleetId":{"shape":"FleetId"}, + "Name":{"shape":"NonZeroAndMaxString"}, + "Status":{"shape":"ScalingStatusType"}, + "ScalingAdjustment":{"shape":"Integer"}, + "ScalingAdjustmentType":{"shape":"ScalingAdjustmentType"}, + "ComparisonOperator":{"shape":"ComparisonOperatorType"}, + "Threshold":{"shape":"Double"}, + "EvaluationPeriods":{"shape":"PositiveInteger"}, + "MetricName":{"shape":"MetricName"} + } + }, + "ScalingPolicyList":{ + "type":"list", + "member":{"shape":"ScalingPolicy"} + }, + "ScalingStatusType":{ + "type":"string", + "enum":[ + "ACTIVE", + "UPDATE_REQUESTED", + "UPDATING", + "DELETE_REQUESTED", + "DELETING", + "DELETED", + "ERROR" + ] + }, + "ServerProcess":{ + "type":"structure", + "required":[ + "LaunchPath", + "ConcurrentExecutions" + ], + "members":{ + "LaunchPath":{"shape":"NonZeroAndMaxString"}, + "Parameters":{"shape":"NonZeroAndMaxString"}, + "ConcurrentExecutions":{"shape":"PositiveInteger"} + } + }, + "ServerProcessList":{ + "type":"list", + "member":{"shape":"ServerProcess"}, + "min":1, + "max":50 + }, + "StringList":{ + "type":"list", + "member":{"shape":"NonZeroAndMaxString"} + }, + "TerminalRoutingStrategyException":{ + "type":"structure", + "members":{ + "Message":{"shape":"NonEmptyString"} + }, + "exception":true + }, + "Timestamp":{"type":"timestamp"}, + "UnauthorizedException":{ + "type":"structure", + "members":{ + "Message":{"shape":"NonEmptyString"} + }, + "exception":true + }, + "UpdateAliasInput":{ + "type":"structure", + "required":["AliasId"], + "members":{ + "AliasId":{"shape":"AliasId"}, + "Name":{"shape":"NonZeroAndMaxString"}, + "Description":{"shape":"NonZeroAndMaxString"}, + "RoutingStrategy":{"shape":"RoutingStrategy"} + } + }, + "UpdateAliasOutput":{ + "type":"structure", + "members":{ + "Alias":{"shape":"Alias"} + } + }, + "UpdateBuildInput":{ + "type":"structure", + "required":["BuildId"], + "members":{ + "BuildId":{"shape":"BuildId"}, + "Name":{"shape":"NonZeroAndMaxString"}, + "Version":{"shape":"NonZeroAndMaxString"} + } + }, + "UpdateBuildOutput":{ + "type":"structure", + "members":{ + "Build":{"shape":"Build"} + } + }, + "UpdateFleetAttributesInput":{ + "type":"structure", + "required":["FleetId"], + "members":{ + "FleetId":{"shape":"FleetId"}, + "Name":{"shape":"NonZeroAndMaxString"}, + "Description":{"shape":"NonZeroAndMaxString"}, + "NewGameSessionProtectionPolicy":{"shape":"ProtectionPolicy"} + } + }, + "UpdateFleetAttributesOutput":{ + "type":"structure", + "members":{ + "FleetId":{"shape":"FleetId"} + } + }, + "UpdateFleetCapacityInput":{ + "type":"structure", + "required":["FleetId"], + "members":{ + "FleetId":{"shape":"FleetId"}, + "DesiredInstances":{"shape":"WholeNumber"}, + "MinSize":{"shape":"WholeNumber"}, + "MaxSize":{"shape":"WholeNumber"} + } + }, + "UpdateFleetCapacityOutput":{ + "type":"structure", + "members":{ + "FleetId":{"shape":"FleetId"} + } + }, + "UpdateFleetPortSettingsInput":{ + "type":"structure", + "required":["FleetId"], + "members":{ + "FleetId":{"shape":"FleetId"}, + "InboundPermissionAuthorizations":{"shape":"IpPermissionsList"}, + "InboundPermissionRevocations":{"shape":"IpPermissionsList"} + } + }, + "UpdateFleetPortSettingsOutput":{ + "type":"structure", + "members":{ + "FleetId":{"shape":"FleetId"} + } + }, + "UpdateGameSessionInput":{ + "type":"structure", + "required":["GameSessionId"], + "members":{ + "GameSessionId":{"shape":"GameSessionId"}, + "MaximumPlayerSessionCount":{"shape":"WholeNumber"}, + "Name":{"shape":"NonZeroAndMaxString"}, + "PlayerSessionCreationPolicy":{"shape":"PlayerSessionCreationPolicy"}, + "ProtectionPolicy":{"shape":"ProtectionPolicy"} + } + }, + "UpdateGameSessionOutput":{ + "type":"structure", + "members":{ + "GameSession":{"shape":"GameSession"} + } + }, + "UpdateRuntimeConfigurationInput":{ + "type":"structure", + "required":[ + "FleetId", + "RuntimeConfiguration" + ], + "members":{ + "FleetId":{"shape":"FleetId"}, + "RuntimeConfiguration":{"shape":"RuntimeConfiguration"} + } + }, + "UpdateRuntimeConfigurationOutput":{ + "type":"structure", + "members":{ + "RuntimeConfiguration":{"shape":"RuntimeConfiguration"} + } + }, + "WholeNumber":{ + "type":"integer", + "min":0 + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/gamelift/2015-10-01/docs-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/gamelift/2015-10-01/docs-2.json new file mode 100644 index 000000000..56a26bc13 --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/gamelift/2015-10-01/docs-2.json @@ -0,0 +1,1084 @@ +{ + "version": "2.0", + "operations": { + "CreateAlias": "Creates an alias for a fleet. You can use an alias to anonymize your fleet by referencing an alias instead of a specific fleet when you create game sessions. Amazon GameLift supports two types of routing strategies for aliases: simple and terminal. Use a simple alias to point to an active fleet. Use a terminal alias to display a message to incoming traffic instead of routing players to an active fleet. This option is useful when a game server is no longer supported but you want to provide better messaging than a standard 404 error.
To create a fleet alias, specify an alias name, routing strategy, and optional description. If successful, a new alias record is returned, including an alias ID, which you can reference when creating a game session. To reassign the alias to another fleet ID, call UpdateAlias.
", + "CreateBuild": "Initializes a new build record and generates information required to upload a game build to Amazon GameLift. Once the build record has been created and is in an INITIALIZED state, you can upload your game build.
Do not use this API action unless you are using your own Amazon Simple Storage Service (Amazon S3) client and need to manually upload your build files. Instead, to create a build, use the CLI command upload-build, which creates a new build record and uploads the build files in one step. (See the Amazon GameLift Developer Guide for more details on the CLI and the upload process.)
To create a new build, optionally specify a build name and version. This metadata is stored with other properties in the build record and is displayed in the GameLift console (it is not visible to players). If successful, this action returns the newly created build record along with the Amazon S3 storage location and AWS account credentials. Use the location and credentials to upload your game build.
", + "CreateFleet": "Creates a new fleet to run your game servers. A fleet is a set of Amazon Elastic Compute Cloud (Amazon EC2) instances, each of which can run multiple server processes to host game sessions. You configure a fleet to create instances with certain hardware specifications (see Amazon EC2 Instance Types for more information), and deploy a specified game build to each instance. A newly created fleet passes through several states; once it reaches the ACTIVE state, it can begin hosting game sessions.
To create a new fleet, provide a fleet name, an EC2 instance type, and a build ID of the game build to deploy. You can also configure the new fleet with the following settings: (1) a runtime configuration describing what server processes to run on each instance in the fleet (required to create fleet), (2) access permissions for inbound traffic, (3) fleet-wide game session protection, and (4) the location of default log files for GameLift to upload and store.
If the CreateFleet call is successful, Amazon GameLift performs the following tasks:
NEW (followed by other states as the fleet is activated).ACTIVE once one server process in the fleet is ready to host a game session.After a fleet is created, use the following actions to change fleet properties and configuration:
Creates a multiplayer game session for players. This action creates a game session record and assigns the new session to an instance in the specified fleet, which initializes a new server process to host the game session. A fleet must be in an ACTIVE state before a game session can be created in it.
To create a game session, specify either a fleet ID or an alias ID and indicate the maximum number of players the game session allows. You can also provide a name and a set of properties for your game (optional). If successful, a GameSession object is returned containing session properties, including an IP address. By default, newly created game sessions are set to accept adding any new players to the game session. Use UpdateGameSession to change the creation policy.
", + "CreatePlayerSession": "Adds a player to a game session and creates a player session record. A game session must be in an ACTIVE state, have a creation policy of ALLOW_ALL, and have an open player slot before players can be added to the session.
To create a player session, specify a game session ID and player ID. If successful, the player is added to the game session and a new PlayerSession object is returned.
", + "CreatePlayerSessions": "Adds a group of players to a game session. Similar to CreatePlayerSession, this action allows you to add multiple players in a single call, which is useful for games that provide party and/or matchmaking features. A game session must be in an ACTIVE state, have a creation policy of ALLOW_ALL, and have an open player slot before players can be added to the session.
To create player sessions, specify a game session ID and a list of player IDs. If successful, the players are added to the game session and a set of new PlayerSession objects is returned.
", + "DeleteAlias": "Deletes an alias. This action removes all record of the alias; game clients attempting to access a server process using the deleted alias receive an error. To delete an alias, specify the alias ID to be deleted.
", + "DeleteBuild": "Deletes a build. This action permanently deletes the build record and any uploaded build files.
To delete a build, specify its ID. Deleting a build does not affect the status of any active fleets using the build, but you can no longer create new fleets with the deleted build.
", + "DeleteFleet": "Deletes everything related to a fleet. Before deleting a fleet, you must set the fleet's desired capacity to zero. See UpdateFleetCapacity.
This action removes the fleet's resources and the fleet record. Once a fleet is deleted, you can no longer use that fleet.
", + "DeleteScalingPolicy": "Deletes a fleet scaling policy. This action means that the policy is no longer in force and removes all record of it. To delete a scaling policy, specify both the scaling policy name and the fleet ID it is associated with.
", + "DescribeAlias": "Retrieves properties for a specified alias. To get the alias, specify an alias ID. If successful, an Alias object is returned.
", + "DescribeBuild": "Retrieves properties for a build. To get a build record, specify a build ID. If successful, an object containing the build properties is returned.
", + "DescribeEC2InstanceLimits": "Retrieves the following information for the specified EC2 instance type:
Service limits vary depending on region. Available regions for GameLift can be found in the AWS Management Console for GameLift (see the drop-down list in the upper right corner).
", + "DescribeFleetAttributes": "Retrieves fleet properties, including metadata, status, and configuration, for one or more fleets. You can request attributes for all fleets, or specify a list of one or more fleet IDs. When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a FleetAttributes object is returned for each requested fleet ID. When specifying a list of fleet IDs, attribute objects are returned only for fleets that currently exist.
Some API actions may limit the number of fleet IDs allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed.
Retrieves the current status of fleet capacity for one or more fleets. This information includes the number of instances that have been requested for the fleet and the number currently active. You can request capacity for all fleets, or specify a list of one or more fleet IDs. When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a FleetCapacity object is returned for each requested fleet ID. When specifying a list of fleet IDs, attribute objects are returned only for fleets that currently exist.
Some API actions may limit the number of fleet IDs allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed.
Retrieves entries from the specified fleet's event log. You can specify a time range to limit the result set. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a collection of event log entries matching the request are returned.
", + "DescribeFleetPortSettings": "Retrieves the inbound connection permissions for a fleet. Connection permissions include a range of IP addresses and port settings that incoming traffic can use to access server processes in the fleet. To get a fleet's inbound connection permissions, specify a fleet ID. If successful, a collection of IpPermission objects is returned for the requested fleet ID. If the requested fleet has been deleted, the result set is empty.
", + "DescribeFleetUtilization": "Retrieves utilization statistics for one or more fleets. You can request utilization data for all fleets, or specify a list of one or more fleet IDs. When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a FleetUtilization object is returned for each requested fleet ID. When specifying a list of fleet IDs, utilization objects are returned only for fleets that currently exist.
Some API actions may limit the number of fleet IDs allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed.
Retrieves properties, including the protection policy in force, for one or more game sessions. This action can be used in several ways: (1) provide a GameSessionId to request details for a specific game session; (2) provide either a FleetId or an AliasId to request properties for all game sessions running on a fleet.
To get game session record(s), specify just one of the following: game session ID, fleet ID, or alias ID. You can filter this request by game session status. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a GameSessionDetail object is returned for each session matching the request.
", + "DescribeGameSessions": "Retrieves properties for one or more game sessions. This action can be used in several ways: (1) provide a GameSessionId to request properties for a specific game session; (2) provide a FleetId or an AliasId to request properties for all game sessions running on a fleet.
To get game session record(s), specify just one of the following: game session ID, fleet ID, or alias ID. You can filter this request by game session status. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a GameSession object is returned for each session matching the request.
", + "DescribePlayerSessions": "Retrieves properties for one or more player sessions. This action can be used in several ways: (1) provide a PlayerSessionId parameter to request properties for a specific player session; (2) provide a GameSessionId parameter to request properties for all player sessions in the specified game session; (3) provide a PlayerId parameter to request properties for all player sessions of a specified player.
To get game session record(s), specify only one of the following: a player session ID, a game session ID, or a player ID. You can filter this request by player session status. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a PlayerSession object is returned for each session matching the request.
", + "DescribeRuntimeConfiguration": "Retrieves the current runtime configuration for the specified fleet. The runtime configuration tells GameLift how to launch server processes on instances in the fleet.
", + "DescribeScalingPolicies": "Retrieves all scaling policies applied to a fleet.
To get a fleet's scaling policies, specify the fleet ID. You can filter this request by policy status, such as to retrieve only active scaling policies. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, set of ScalingPolicy objects is returned for the fleet.
", + "GetGameSessionLogUrl": "Retrieves the location of stored game session logs for a specified game session. When a game session is terminated, Amazon GameLift automatically stores the logs in Amazon S3. Use this URL to download the logs.
See the AWS Service Limits page for maximum log file sizes. Log files that exceed this limit are not saved.
Retrieves a collection of alias records for this AWS account. You can filter the result set by alias name and/or routing strategy type. Use the pagination parameters to retrieve results in sequential pages.
Aliases are not listed in any particular order.
Retrieves build records for all builds associated with the AWS account in use. You can limit results to builds in a specific state using the Status parameter. Use the pagination parameters to retrieve results in a set of sequential pages.
Build records are not listed in any particular order.
Retrieves a collection of fleet records for this AWS account. You can filter the result set by build ID. Use the pagination parameters to retrieve results in sequential pages.
Fleet records are not listed in any particular order.
Creates or updates a scaling policy for a fleet. An active scaling policy prompts Amazon GameLift to track a certain metric for a fleet and automatically change the fleet's capacity in specific circumstances. Each scaling policy contains one rule statement. Fleets can have multiple scaling policies in force simultaneously.
A scaling policy rule statement has the following structure:
If [MetricName] is [ComparisonOperator] [Threshold] for [EvaluationPeriods] minutes, then [ScalingAdjustmentType] to/by [ScalingAdjustment].
For example, this policy: \"If the number of idle instances exceeds 20 for more than 15 minutes, then reduce the fleet capacity by 10 instances\" could be implemented as the following rule statement:
If [IdleInstances] is [GreaterThanOrEqualToThreshold] [20] for [15] minutes, then [ChangeInCapacity] by [-10].
To create or update a scaling policy, specify a unique combination of name and fleet ID, and set the rule values. All parameters for this action are required. If successful, the policy name is returned. Scaling policies cannot be suspended or made inactive. To stop enforcing a scaling policy, call DeleteScalingPolicy.
", + "RequestUploadCredentials": "Retrieves a fresh set of upload credentials and the assigned Amazon S3 storage location for a specific build. Valid credentials are required to upload your game build files to Amazon S3.
Call this action only if you need credentials for a build created with CreateBuild. This is a rare situation; in most cases, builds are created using the CLI command upload-build, which creates a build record and also uploads build files.
Upload credentials are returned when you create the build, but they have a limited lifespan. You can get fresh credentials and use them to re-upload game files until the state of that build changes to READY. Once this happens, you must create a brand new build.
Retrieves the fleet ID that a specified alias is currently pointing to.
", + "UpdateAlias": "Updates properties for an alias. To update properties, specify the alias ID to be updated and provide the information to be changed. To reassign an alias to another fleet, provide an updated routing strategy. If successful, the updated alias record is returned.
", + "UpdateBuild": "Updates metadata in a build record, including the build name and version. To update the metadata, specify the build ID to update and provide the new values. If successful, a build object containing the updated metadata is returned.
", + "UpdateFleetAttributes": "Updates fleet properties, including name and description, for a fleet. To update metadata, specify the fleet ID and the property values you want to change. If successful, the fleet ID for the updated fleet is returned.
", + "UpdateFleetCapacity": "Updates capacity settings for a fleet. Use this action to specify the number of EC2 instances (hosts) that you want this fleet to contain. Before calling this action, you may want to call DescribeEC2InstanceLimits to get the maximum capacity based on the fleet's EC2 instance type.
If you're using autoscaling (see PutScalingPolicy), you may want to specify a minimum and/or maximum capacity. If you don't provide these, autoscaling can set capacity anywhere between zero and the service limits.
To update fleet capacity, specify the fleet ID and the number of instances you want the fleet to host. If successful, Amazon GameLift starts or terminates instances so that the fleet's active instance count matches the desired instance count. You can view a fleet's current capacity information by calling DescribeFleetCapacity. If the desired instance count is higher than the instance type's limit, the \"Limit Exceeded\" exception occurs.
", + "UpdateFleetPortSettings": "Updates port settings for a fleet. To update settings, specify the fleet ID to be updated and list the permissions you want to update. List the permissions you want to add in InboundPermissionAuthorizations, and permissions you want to remove in InboundPermissionRevocations. Permissions to be removed must match existing fleet permissions. If successful, the fleet ID for the updated fleet is returned.
Updates game session properties. This includes the session name, maximum player count, protection policy, which controls whether or not an active game session can be terminated during a scale-down event, and the player session creation policy, which controls whether or not new players can join the session. To update a game session, specify the game session ID and the values you want to change. If successful, an updated GameSession object is returned.
", + "UpdateRuntimeConfiguration": "Updates the current runtime configuration for the specified fleet, which tells GameLift how to launch server processes on instances in the fleet. You can update a fleet's runtime configuration at any time after the fleet is created; it does not need to be in an ACTIVE state.
To update runtime configuration, specify the fleet ID and provide a RuntimeConfiguration object with the updated collection of server process configurations.
Each instance in a GameLift fleet checks regularly for an updated runtime configuration and changes how it launches server processes to comply with the latest version. Existing server processes are not affected by the update; they continue to run until they end, while GameLift simply adds new server processes to fit the current runtime configuration. As a result, the runtime configuration changes are applied gradually as existing processes shut down and new processes are launched in GameLift's normal process recycling activity.
" + }, + "service": "Welcome to the Amazon GameLift API Reference. Amazon GameLift is a managed Amazon Web Services (AWS) service for developers who need a scalable, server-based solution for multiplayer games. Amazon GameLift provides setup and deployment of game servers, and handles infrastructure scaling and session management.
This reference describes the low-level service API for GameLift. You can call this API directly or use the AWS SDK for your preferred language. The AWS SDK includes a set of high-level GameLift actions multiplayer game sessions. Alternatively, you can use the AWS command-line interface (CLI) tool, which includes commands for GameLift. For administrative actions, you can also use the Amazon GameLift console.
More Resources
Manage Games and Players Through GameLift
Call these actions from your game clients and/or services to create and manage multiplayer game sessions and player sessions.
Set Up and Manage Game Servers
Use these administrative actions to configure GameLift to host your game servers. When setting up GameLift, you'll need to (1) configure a build for your game and upload build files, and (2) set up one or more fleets to host game sessions. Once you've created and activated a fleet, you can assign aliases to it, scale capacity, track performance and utilization, etc.
To view changes to the API, see the GameLift Document History page.
", + "shapes": { + "Alias": { + "base": "Properties describing a fleet alias.
", + "refs": { + "AliasList$member": null, + "CreateAliasOutput$Alias": "Object containing the newly created alias record.
", + "DescribeAliasOutput$Alias": "Object containing the requested alias.
", + "UpdateAliasOutput$Alias": "Object containing the updated alias configuration.
" + } + }, + "AliasId": { + "base": null, + "refs": { + "Alias$AliasId": "Unique identifier for a fleet alias.
", + "CreateGameSessionInput$AliasId": "Unique identifier for a fleet alias. Each request must reference either a fleet ID or alias ID, but not both.
", + "DeleteAliasInput$AliasId": "Unique identifier for a fleet alias. Specify the alias you want to delete.
", + "DescribeAliasInput$AliasId": "Unique identifier for a fleet alias. Specify the alias you want to retrieve.
", + "DescribeGameSessionDetailsInput$AliasId": "Unique identifier for a fleet alias. Specify an alias to retrieve information on all game sessions active on the fleet.
", + "DescribeGameSessionsInput$AliasId": "Unique identifier for a fleet alias. Specify an alias to retrieve information on all game sessions active on the fleet.
", + "ResolveAliasInput$AliasId": "Unique identifier for the alias you want to resolve.
", + "UpdateAliasInput$AliasId": "Unique identifier for a fleet alias. Specify the alias you want to update.
" + } + }, + "AliasList": { + "base": null, + "refs": { + "ListAliasesOutput$Aliases": "Collection of alias records that match the list request.
" + } + }, + "AwsCredentials": { + "base": "AWS access credentials required to upload game build files to Amazon GameLift. These credentials are generated with CreateBuild, and are valid for a limited time. If they expire before you upload your game build, get a new set by calling RequestUploadCredentials.
", + "refs": { + "CreateBuildOutput$UploadCredentials": "AWS credentials required when uploading a game build to the storage location. These credentials have a limited lifespan and are valid only for the build they were issued for. If you need to get fresh credentials, call RequestUploadCredentials.
AWS credentials required when uploading a game build to the storage location. These credentials have a limited lifespan and are valid only for the build they were issued for.
" + } + }, + "Build": { + "base": "Properties describing a game build.
", + "refs": { + "BuildList$member": null, + "CreateBuildOutput$Build": "Set of properties for the newly created build.
", + "DescribeBuildOutput$Build": "Set of properties describing the requested build.
", + "UpdateBuildOutput$Build": "Object containing the updated build record.
" + } + }, + "BuildId": { + "base": null, + "refs": { + "Build$BuildId": "Unique identifier for a build.
", + "CreateFleetInput$BuildId": "Unique identifier of the build to be deployed on the new fleet. The build must have been successfully uploaded to GameLift and be in a READY state. This fleet setting cannot be changed once the fleet is created.
Unique identifier for the build you want to delete.
", + "DescribeBuildInput$BuildId": "Unique identifier of the build that you want to retrieve properties for.
", + "FleetAttributes$BuildId": "Unique identifier for a build.
", + "ListFleetsInput$BuildId": "Unique identifier of the build to return fleets for. Use this parameter to return only fleets using the specified build. To retrieve all fleets, leave this parameter empty.
", + "RequestUploadCredentialsInput$BuildId": "Unique identifier for the build you want to get credentials for.
", + "UpdateBuildInput$BuildId": "Unique identifier of the build you want to update.
" + } + }, + "BuildList": { + "base": null, + "refs": { + "ListBuildsOutput$Builds": "Collection of build records that match the request.
" + } + }, + "BuildStatus": { + "base": null, + "refs": { + "Build$Status": "Current status of the build. Possible build states include the following:
Build state to filter results by. To retrieve all builds, leave this parameter empty. Possible build states include the following:
Comparison operator to use when measuring the metric against the threshold value.
", + "ScalingPolicy$ComparisonOperator": "Comparison operator to use when measuring a metric against the threshold value.
" + } + }, + "ConflictException": { + "base": "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": { + } + }, + "CreateAliasInput": { + "base": "Represents the input for a request action.
", + "refs": { + } + }, + "CreateAliasOutput": { + "base": "Represents the returned data in response to a request action.
", + "refs": { + } + }, + "CreateBuildInput": { + "base": "Represents the input for a request action.
", + "refs": { + } + }, + "CreateBuildOutput": { + "base": "Represents the returned data in response to a request action.
", + "refs": { + } + }, + "CreateFleetInput": { + "base": "Represents the input for a request action.
", + "refs": { + } + }, + "CreateFleetOutput": { + "base": "Represents the returned data in response to a request action.
", + "refs": { + } + }, + "CreateGameSessionInput": { + "base": "Represents the input for a request action.
", + "refs": { + } + }, + "CreateGameSessionOutput": { + "base": "Represents the returned data in response to a request action.
", + "refs": { + } + }, + "CreatePlayerSessionInput": { + "base": "Represents the input for a request action.
", + "refs": { + } + }, + "CreatePlayerSessionOutput": { + "base": "Represents the returned data in response to a request action.
", + "refs": { + } + }, + "CreatePlayerSessionsInput": { + "base": "Represents the input for a request action.
", + "refs": { + } + }, + "CreatePlayerSessionsOutput": { + "base": "Represents the returned data in response to a request action.
", + "refs": { + } + }, + "DeleteAliasInput": { + "base": "Represents the input for a request action.
", + "refs": { + } + }, + "DeleteBuildInput": { + "base": "Represents the input for a request action.
", + "refs": { + } + }, + "DeleteFleetInput": { + "base": "Represents the input for a request action.
", + "refs": { + } + }, + "DeleteScalingPolicyInput": { + "base": "Represents the input for a request action.
", + "refs": { + } + }, + "DescribeAliasInput": { + "base": "Represents the input for a request action.
", + "refs": { + } + }, + "DescribeAliasOutput": { + "base": "Represents the returned data in response to a request action.
", + "refs": { + } + }, + "DescribeBuildInput": { + "base": "Represents the input for a request action.
", + "refs": { + } + }, + "DescribeBuildOutput": { + "base": "Represents the returned data in response to a request action.
", + "refs": { + } + }, + "DescribeEC2InstanceLimitsInput": { + "base": "Represents the input for a request action.
", + "refs": { + } + }, + "DescribeEC2InstanceLimitsOutput": { + "base": "Represents the returned data in response to a request action.
", + "refs": { + } + }, + "DescribeFleetAttributesInput": { + "base": "Represents the input for a request action.
", + "refs": { + } + }, + "DescribeFleetAttributesOutput": { + "base": "Represents the returned data in response to a request action.
", + "refs": { + } + }, + "DescribeFleetCapacityInput": { + "base": "Represents the input for a request action.
", + "refs": { + } + }, + "DescribeFleetCapacityOutput": { + "base": "Represents the returned data in response to a request action.
", + "refs": { + } + }, + "DescribeFleetEventsInput": { + "base": "Represents the input for a request action.
", + "refs": { + } + }, + "DescribeFleetEventsOutput": { + "base": "Represents the returned data in response to a request action.
", + "refs": { + } + }, + "DescribeFleetPortSettingsInput": { + "base": "Represents the input for a request action.
", + "refs": { + } + }, + "DescribeFleetPortSettingsOutput": { + "base": "Represents the returned data in response to a request action.
", + "refs": { + } + }, + "DescribeFleetUtilizationInput": { + "base": "Represents the input for a request action.
", + "refs": { + } + }, + "DescribeFleetUtilizationOutput": { + "base": "Represents the returned data in response to a request action.
", + "refs": { + } + }, + "DescribeGameSessionDetailsInput": { + "base": "Represents the input for a request action.
", + "refs": { + } + }, + "DescribeGameSessionDetailsOutput": { + "base": "Represents the returned data in response to a request action.
", + "refs": { + } + }, + "DescribeGameSessionsInput": { + "base": "Represents the input for a request action.
", + "refs": { + } + }, + "DescribeGameSessionsOutput": { + "base": "Represents the returned data in response to a request action.
", + "refs": { + } + }, + "DescribePlayerSessionsInput": { + "base": "Represents the input for a request action.
", + "refs": { + } + }, + "DescribePlayerSessionsOutput": { + "base": "Represents the returned data in response to a request action.
", + "refs": { + } + }, + "DescribeRuntimeConfigurationInput": { + "base": "Represents the input for a request action.
", + "refs": { + } + }, + "DescribeRuntimeConfigurationOutput": { + "base": "Represents the returned data in response to a request action.
", + "refs": { + } + }, + "DescribeScalingPoliciesInput": { + "base": "Represents the input for a request action.
", + "refs": { + } + }, + "DescribeScalingPoliciesOutput": { + "base": "Represents the returned data in response to a request action.
", + "refs": { + } + }, + "Double": { + "base": null, + "refs": { + "PutScalingPolicyInput$Threshold": "Metric value used to trigger a scaling event.
", + "ScalingPolicy$Threshold": "Metric value used to trigger a scaling event.
" + } + }, + "EC2InstanceCounts": { + "base": "Current status of fleet capacity. The number of active instances should match or be in the process of matching the number of desired instances. Pending and terminating counts are non-zero only if fleet capacity is adjusting to an UpdateFleetCapacity request, or if access to resources is temporarily affected.
", + "refs": { + "FleetCapacity$InstanceCounts": "Current status of fleet capacity.
" + } + }, + "EC2InstanceLimit": { + "base": "Maximum number of instances allowed based on the Amazon Elastic Compute Cloud (Amazon EC2) instance type. Instance limits can be retrieved by calling DescribeEC2InstanceLimits.
", + "refs": { + "EC2InstanceLimitList$member": null + } + }, + "EC2InstanceLimitList": { + "base": null, + "refs": { + "DescribeEC2InstanceLimitsOutput$EC2InstanceLimits": "Object containing the maximum number of instances for the specified instance type.
" + } + }, + "EC2InstanceType": { + "base": null, + "refs": { + "CreateFleetInput$EC2InstanceType": "Name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions.
", + "DescribeEC2InstanceLimitsInput$EC2InstanceType": "Name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions. Leave this parameter blank to retrieve limits for all types.
", + "EC2InstanceLimit$EC2InstanceType": "Name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions.
", + "FleetCapacity$InstanceType": "Name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions.
" + } + }, + "Event": { + "base": "Log entry describing an event involving an Amazon GameLift resource (such as a fleet).
", + "refs": { + "EventList$member": null + } + }, + "EventCode": { + "base": null, + "refs": { + "Event$EventCode": "Type of event being logged.
" + } + }, + "EventList": { + "base": null, + "refs": { + "DescribeFleetEventsOutput$Events": "Collection of objects containing event log entries for the specified fleet.
" + } + }, + "FleetAttributes": { + "base": "General properties describing a fleet.
", + "refs": { + "CreateFleetOutput$FleetAttributes": "Properties for the newly created fleet.
", + "FleetAttributesList$member": null + } + }, + "FleetAttributesList": { + "base": null, + "refs": { + "DescribeFleetAttributesOutput$FleetAttributes": "Collection of objects containing attribute metadata for each requested fleet ID.
" + } + }, + "FleetCapacity": { + "base": "Information about the fleet's capacity. Fleet capacity is measured in EC2 instances. By default, new fleets have a capacity of one instance, but can be updated as needed. The maximum number of instances for a fleet is determined by the fleet's instance type.
", + "refs": { + "FleetCapacityList$member": null + } + }, + "FleetCapacityExceededException": { + "base": "The specified fleet has no available instances to fulfill a request to create a new game session. Such requests should only be retried once the fleet capacity has been increased.
", + "refs": { + } + }, + "FleetCapacityList": { + "base": null, + "refs": { + "DescribeFleetCapacityOutput$FleetCapacity": "Collection of objects containing capacity information for each requested fleet ID. Leave this parameter empty to retrieve capacity information for all fleets.
" + } + }, + "FleetId": { + "base": null, + "refs": { + "CreateGameSessionInput$FleetId": "Unique identifier for a fleet. Each request must reference either a fleet ID or alias ID, but not both.
", + "DeleteFleetInput$FleetId": "Unique identifier for the fleet you want to delete.
", + "DeleteScalingPolicyInput$FleetId": "Unique identifier for a fleet.
", + "DescribeFleetEventsInput$FleetId": "Unique identifier for the fleet to get event logs for.
", + "DescribeFleetPortSettingsInput$FleetId": "Unique identifier for the fleet you want to retrieve port settings for.
", + "DescribeGameSessionDetailsInput$FleetId": "Unique identifier for a fleet. Specify a fleet to retrieve information on all game sessions active on the fleet.
", + "DescribeGameSessionsInput$FleetId": "Unique identifier for a fleet. Specify a fleet to retrieve information on all game sessions active on the fleet.
", + "DescribeRuntimeConfigurationInput$FleetId": "Unique identifier of the fleet to get the runtime configuration for.
", + "DescribeScalingPoliciesInput$FleetId": "Unique identifier for a fleet. Specify the fleet to retrieve scaling policies for.
", + "FleetAttributes$FleetId": "Unique identifier for a fleet.
", + "FleetCapacity$FleetId": "Unique identifier for a fleet.
", + "FleetIdList$member": null, + "FleetUtilization$FleetId": "Unique identifier for a fleet.
", + "GameSession$FleetId": "Unique identifier for a fleet.
", + "PlayerSession$FleetId": "Unique identifier for a fleet.
", + "PutScalingPolicyInput$FleetId": "Unique identity for the fleet to scale with this policy.
", + "ResolveAliasOutput$FleetId": "Fleet ID associated with the requested alias.
", + "RoutingStrategy$FleetId": "Unique identifier for a fleet.
", + "ScalingPolicy$FleetId": "Unique identity for the fleet associated with this scaling policy.
", + "UpdateFleetAttributesInput$FleetId": "Unique identifier for the fleet you want to update attribute metadata for.
", + "UpdateFleetAttributesOutput$FleetId": "Unique identifier for the updated fleet.
", + "UpdateFleetCapacityInput$FleetId": "Unique identifier for the fleet you want to update capacity for.
", + "UpdateFleetCapacityOutput$FleetId": "Unique identifier for the updated fleet.
", + "UpdateFleetPortSettingsInput$FleetId": "Unique identifier for the fleet you want to update port settings for.
", + "UpdateFleetPortSettingsOutput$FleetId": "Unique identifier for the updated fleet.
", + "UpdateRuntimeConfigurationInput$FleetId": "Unique identifier of the fleet to update runtime configuration for.
" + } + }, + "FleetIdList": { + "base": null, + "refs": { + "DescribeFleetAttributesInput$FleetIds": "Unique identifiers for the fleet(s) that you want to retrieve attributes for. To request attributes for all fleets, leave this parameter empty.
", + "DescribeFleetCapacityInput$FleetIds": "Unique identifier for the fleet(s) you want to retrieve capacity information for. To request capacity information for all fleets, leave this parameter empty.
", + "DescribeFleetUtilizationInput$FleetIds": "Unique identifier for the fleet(s) you want to retrieve utilization data for. To request utilization data for all fleets, leave this parameter empty.
", + "ListFleetsOutput$FleetIds": "Set of fleet IDs matching the list request. You can retrieve additional information about all returned fleets by passing this result set to a call to DescribeFleetAttributes, DescribeFleetCapacity, and DescribeFleetUtilization.
" + } + }, + "FleetStatus": { + "base": null, + "refs": { + "FleetAttributes$Status": "Current status of the fleet. Possible fleet states include the following:
Current status of fleet utilization, including the number of game and player sessions being hosted.
", + "refs": { + "FleetUtilizationList$member": null + } + }, + "FleetUtilizationList": { + "base": null, + "refs": { + "DescribeFleetUtilizationOutput$FleetUtilization": "Collection of objects containing utilization information for each requested fleet ID.
" + } + }, + "FreeText": { + "base": null, + "refs": { + "Alias$Name": "Descriptive label associated with an alias. Alias names do not need to be unique.
", + "Alias$Description": "Human-readable description of an alias.
", + "Build$Name": "Descriptive label associated with a build. Build names do not need to be unique. It can be set using CreateBuild or UpdateBuild.
", + "Build$Version": "Version associated with this build. Version strings do not need to be unique to a build. This value can be set using CreateBuild or UpdateBuild.
", + "RoutingStrategy$Message": "Message text to be used with a terminal routing strategy.
" + } + }, + "GameProperty": { + "base": "Set of key-value pairs containing information a server process requires to set up a game session. This object allows you to pass in any set of data needed for your game. For more information, see the Amazon GameLift Developer Guide.
", + "refs": { + "GamePropertyList$member": null + } + }, + "GamePropertyKey": { + "base": null, + "refs": { + "GameProperty$Key": null + } + }, + "GamePropertyList": { + "base": null, + "refs": { + "CreateGameSessionInput$GameProperties": "Set of properties used to administer a game session. These properties are passed to the server process hosting it.
", + "GameSession$GameProperties": "Set of custom properties for the game session.
" + } + }, + "GamePropertyValue": { + "base": null, + "refs": { + "GameProperty$Value": null + } + }, + "GameSession": { + "base": "Properties describing a game session.
", + "refs": { + "CreateGameSessionOutput$GameSession": "Object containing the newly created game session record.
", + "GameSessionDetail$GameSession": null, + "GameSessionList$member": null, + "UpdateGameSessionOutput$GameSession": "Object containing the updated game session metadata.
" + } + }, + "GameSessionDetail": { + "base": "A game session's properties and the protection policy currently in force.
", + "refs": { + "GameSessionDetailList$member": null + } + }, + "GameSessionDetailList": { + "base": null, + "refs": { + "DescribeGameSessionDetailsOutput$GameSessionDetails": "Collection of objects containing game session properties and the protection policy currently in force for each session matching the request.
" + } + }, + "GameSessionFullException": { + "base": "The game instance is currently full and cannot allow the requested player(s) to join. This exception occurs in response to a CreatePlayerSession request.
", + "refs": { + } + }, + "GameSessionId": { + "base": null, + "refs": { + "CreatePlayerSessionInput$GameSessionId": "Unique identifier for a game session. Specify the game session you want to add a player to.
", + "CreatePlayerSessionsInput$GameSessionId": "Unique identifier for a game session.
", + "DescribeGameSessionDetailsInput$GameSessionId": "Unique identifier for a game session. Specify the game session to retrieve information on.
", + "DescribeGameSessionsInput$GameSessionId": "Unique identifier for a game session. Specify the game session to retrieve information on.
", + "DescribePlayerSessionsInput$GameSessionId": "Unique identifier for a game session.
", + "GameSession$GameSessionId": "Unique identifier for a game session.
", + "GetGameSessionLogUrlInput$GameSessionId": "Unique identifier for a game session. Specify the game session you want to get logs for.
", + "PlayerSession$GameSessionId": "Unique identifier for a game session.
", + "UpdateGameSessionInput$GameSessionId": "Unique identifier for a game session. Specify the game session you want to update.
" + } + }, + "GameSessionList": { + "base": null, + "refs": { + "DescribeGameSessionsOutput$GameSessions": "Collection of objects containing game session properties for each session matching the request.
" + } + }, + "GameSessionStatus": { + "base": null, + "refs": { + "GameSession$Status": "Current status of the game session. A game session must be in an ACTIVE state to have player sessions.
Represents the input for a request action.
", + "refs": { + } + }, + "GetGameSessionLogUrlOutput": { + "base": "Represents the returned data in response to a request action.
", + "refs": { + } + }, + "Integer": { + "base": null, + "refs": { + "PutScalingPolicyInput$ScalingAdjustment": "Amount of adjustment to make, based on the scaling adjustment type.
", + "ScalingPolicy$ScalingAdjustment": "Amount of adjustment to make, based on the scaling adjustment type.
" + } + }, + "InternalServiceException": { + "base": "The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.
", + "refs": { + } + }, + "InvalidFleetStatusException": { + "base": "The requested operation would cause a conflict with the current state of a resource associated with the request and/or the fleet. Resolve the conflict before retrying.
", + "refs": { + } + }, + "InvalidGameSessionStatusException": { + "base": "The requested operation would cause a conflict with the current state of a resource associated with the request and/or the game instance. Clients should not retry such requests without resolving the conflict.
", + "refs": { + } + }, + "InvalidRequestException": { + "base": "One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.
", + "refs": { + } + }, + "IpAddress": { + "base": null, + "refs": { + "GameSession$IpAddress": "IP address of the game session. To connect to a GameLift server process, an app needs both the IP address and port number.
", + "PlayerSession$IpAddress": "Game session IP address. All player sessions reference the game session location.
" + } + }, + "IpPermission": { + "base": "A range of IP addresses and port settings that allow inbound traffic to connect to server processes on GameLift. Each game session hosted on a fleet is assigned a unique combination of IP address and port number, which must fall into the fleet's allowed ranges. This combination is included in the GameSession object.
", + "refs": { + "IpPermissionsList$member": null + } + }, + "IpPermissionsList": { + "base": null, + "refs": { + "CreateFleetInput$EC2InboundPermissions": "Range of IP addresses and port settings that permit inbound traffic to access server processes running on the fleet. If no inbound permissions are set, including both IP address range and port range, the server processes in the fleet cannot accept connections. You can specify one or more sets of permissions for a fleet.
", + "DescribeFleetPortSettingsOutput$InboundPermissions": "Object containing port settings for the requested fleet ID.
", + "UpdateFleetPortSettingsInput$InboundPermissionAuthorizations": "Collection of port settings to be added to the fleet record.
", + "UpdateFleetPortSettingsInput$InboundPermissionRevocations": "Collection of port settings to be removed from the fleet record.
" + } + }, + "IpProtocol": { + "base": null, + "refs": { + "IpPermission$Protocol": "Network communication protocol used by the fleet.
" + } + }, + "LimitExceededException": { + "base": "The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.
", + "refs": { + } + }, + "ListAliasesInput": { + "base": "Represents the input for a request action.
", + "refs": { + } + }, + "ListAliasesOutput": { + "base": "Represents the returned data in response to a request action.
", + "refs": { + } + }, + "ListBuildsInput": { + "base": "Represents the input for a request action.
", + "refs": { + } + }, + "ListBuildsOutput": { + "base": "Represents the returned data in response to a request action.
", + "refs": { + } + }, + "ListFleetsInput": { + "base": "Represents the input for a request action.
", + "refs": { + } + }, + "ListFleetsOutput": { + "base": "Represents the returned data in response to a request action.
", + "refs": { + } + }, + "MetricName": { + "base": null, + "refs": { + "PutScalingPolicyInput$MetricName": "Name of the Amazon GameLift-defined metric that is used to trigger an adjustment.
ACTIVATING).ACTIVE).ACTIVE or RESERVED). PlayerSessionCreationPolicy = DENY_ALL).Name of the GameLift-defined metric that is used to trigger an adjustment.
ACTIVATING).ACTIVE).ACTIVE or RESERVED). PlayerSessionCreationPolicy = DENY_ALL).Range of allowed IP addresses. This value must be expressed in CIDR notation. Example: \"000.000.000.000/[subnet mask]\" or optionally the shortened version \"0.0.0.0/[subnet mask]\".
Access key for an AWS account.
", + "AwsCredentials$SecretAccessKey": "Secret key for an AWS account.
", + "AwsCredentials$SessionToken": "Token specific to a build ID.
", + "ConflictException$Message": null, + "Event$Message": "Additional information related to the event.
", + "FleetCapacityExceededException$Message": null, + "GameSessionFullException$Message": null, + "InternalServiceException$Message": null, + "InvalidFleetStatusException$Message": null, + "InvalidGameSessionStatusException$Message": null, + "InvalidRequestException$Message": null, + "LimitExceededException$Message": null, + "ListAliasesInput$Name": "Descriptive label associated with an alias. Alias names do not need to be unique.
", + "ListAliasesInput$NextToken": "Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value.
", + "ListAliasesOutput$NextToken": "Token indicating where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.
If a request has a limit that exactly matches the number of remaining results, a token is returned even though there are no more results to retrieve.
Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value.
", + "ListBuildsOutput$NextToken": "Token indicating where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.
If a request has a limit that exactly matches the number of remaining results, a token is returned even though there are no more results to retrieve.
Amazon S3 bucket identifier.
", + "S3Location$Key": "Amazon S3 bucket key.
", + "S3Location$RoleArn": "Amazon resource number for the cross-account access role that allows GameLift access to the S3 bucket.
", + "TerminalRoutingStrategyException$Message": null, + "UnauthorizedException$Message": null + } + }, + "NonZeroAndMaxString": { + "base": null, + "refs": { + "CreateAliasInput$Name": "Descriptive label associated with an alias. Alias names do not need to be unique.
", + "CreateAliasInput$Description": "Human-readable description of an alias.
", + "CreateBuildInput$Name": "Descriptive label associated with a build. Build names do not need to be unique. A build name can be changed later using UpdateBuild.
Version associated with this build. Version strings do not need to be unique to a build. A build version can be changed later using UpdateBuild.
Descriptive label associated with a fleet. Fleet names do not need to be unique.
", + "CreateFleetInput$Description": "Human-readable description of a fleet.
", + "CreateFleetInput$ServerLaunchPath": "This parameter is no longer used. Instead, specify a server launch path using the RuntimeConfiguration parameter. (Requests that specify a server launch path and launch parameters instead of a runtime configuration will continue to work.)
This parameter is no longer used. Instead, specify server launch parameters in the RuntimeConfiguration parameter. (Requests that specify a server launch path and launch parameters instead of a runtime configuration will continue to work.)
Descriptive label associated with a game session. Session names do not need to be unique.
", + "CreatePlayerSessionInput$PlayerId": "Unique identifier for the player to be added.
", + "DeleteScalingPolicyInput$Name": "Descriptive label associated with a scaling policy. Policy names do not need to be unique.
", + "DescribeFleetAttributesInput$NextToken": "Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value. This parameter is ignored when the request specifies one or a list of fleet IDs.
", + "DescribeFleetAttributesOutput$NextToken": "Token indicating where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.
If a request has a limit that exactly matches the number of remaining results, a token is returned even though there are no more results to retrieve.
Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value. This parameter is ignored when the request specifies one or a list of fleet IDs.
", + "DescribeFleetCapacityOutput$NextToken": "Token indicating where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.
If a request has a limit that exactly matches the number of remaining results, a token is returned even though there are no more results to retrieve.
Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value.
", + "DescribeFleetEventsOutput$NextToken": "Token indicating where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.
If a request has a limit that exactly matches the number of remaining results, a token is returned even though there are no more results to retrieve.
Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value. This parameter is ignored when the request specifies one or a list of fleet IDs.
", + "DescribeFleetUtilizationOutput$NextToken": "Token indicating where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.
If a request has a limit that exactly matches the number of remaining results, a token is returned even though there are no more results to retrieve.
Game session status to filter results on. Possible game session states include ACTIVE, TERMINATED, ACTIVATING and TERMINATING (the last two are transitory).
Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value.
", + "DescribeGameSessionDetailsOutput$NextToken": "Token indicating where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.
If a request has a limit that exactly matches the number of remaining results, a token is returned even though there are no more results to retrieve.
Game session status to filter results on. Possible game session states include ACTIVE, TERMINATED, ACTIVATING, and TERMINATING (the last two are transitory).
Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value.
", + "DescribeGameSessionsOutput$NextToken": "Token indicating where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.
If a request has a limit that exactly matches the number of remaining results, a token is returned even though there are no more results to retrieve.
Unique identifier for a player.
", + "DescribePlayerSessionsInput$PlayerSessionStatusFilter": "Player session status to filter results on. Possible player session states include the following:
Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value. If a player session ID is specified, this parameter is ignored.
", + "DescribePlayerSessionsOutput$NextToken": "Token indicating where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.
If a request has a limit that exactly matches the number of remaining results, a token is returned even though there are no more results to retrieve.
Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value.
", + "DescribeScalingPoliciesOutput$NextToken": "Token indicating where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.
If a request has a limit that exactly matches the number of remaining results, a token is returned even though there are no more results to retrieve.
Unique identifier for a fleet event.
", + "Event$ResourceId": "Unique identifier for the resource, such as a fleet ID.
", + "FleetAttributes$Description": "Human-readable description of the fleet.
", + "FleetAttributes$Name": "Descriptive label associated with a fleet. Fleet names do not need to be unique.
", + "FleetAttributes$ServerLaunchPath": "Deprecated. Server launch parameters are now set using a RuntimeConfiguration object.
Deprecated. Server launch parameters are now specified using a RuntimeConfiguration object.
Descriptive label associated with a game session. Session names do not need to be unique.
", + "GetGameSessionLogUrlOutput$PreSignedUrl": "Location of the requested game session logs, available for download.
", + "ListFleetsInput$NextToken": "Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value.
", + "ListFleetsOutput$NextToken": "Token indicating where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.
If a request has a limit that exactly matches the number of remaining results, a token is returned even though there are no more results to retrieve.
Unique identifier for a player.
", + "PutScalingPolicyInput$Name": "Descriptive label associated with a scaling policy. Policy names do not need to be unique. A fleet can have only one scaling policy with the same name.
", + "PutScalingPolicyOutput$Name": "Descriptive label associated with a scaling policy. Policy names do not need to be unique.
", + "ScalingPolicy$Name": "Descriptive label associated with a scaling policy. Policy names do not need to be unique.
", + "ServerProcess$LaunchPath": "Location in the game build of the server executable. All game builds are installed on instances at the root C:\\game\\..., so an executable file located at MyGame\\latest\\server.exe has a launch path of \"C:\\game\\MyGame\\latest\\server.exe\".
Optional list of parameters to pass to the server executable on launch.
", + "StringList$member": null, + "UpdateAliasInput$Name": "Descriptive label associated with an alias. Alias names do not need to be unique.
", + "UpdateAliasInput$Description": "Human-readable description of an alias.
", + "UpdateBuildInput$Name": "Descriptive label associated with a build. Build names do not need to be unique.
", + "UpdateBuildInput$Version": "Version associated with this build. Version strings do not need to be unique to a build.
", + "UpdateFleetAttributesInput$Name": "Descriptive label associated with a fleet. Fleet names do not need to be unique.
", + "UpdateFleetAttributesInput$Description": "Human-readable description of a fleet.
", + "UpdateGameSessionInput$Name": "Descriptive label associated with a game session. Session names do not need to be unique.
" + } + }, + "NotFoundException": { + "base": "A service resource associated with the request could not be found. Clients should not retry such requests
", + "refs": { + } + }, + "PlayerIdList": { + "base": null, + "refs": { + "CreatePlayerSessionsInput$PlayerIds": "List of unique identifiers for the players to be added.
" + } + }, + "PlayerSession": { + "base": "Properties describing a player session.
", + "refs": { + "CreatePlayerSessionOutput$PlayerSession": "Object containing the newly created player session record.
", + "PlayerSessionList$member": null + } + }, + "PlayerSessionCreationPolicy": { + "base": null, + "refs": { + "GameSession$PlayerSessionCreationPolicy": "Indicates whether or not the game session is accepting new players.
", + "UpdateGameSessionInput$PlayerSessionCreationPolicy": "Policy determining whether or not the game session accepts new players.
" + } + }, + "PlayerSessionId": { + "base": null, + "refs": { + "DescribePlayerSessionsInput$PlayerSessionId": "Unique identifier for a player session.
", + "PlayerSession$PlayerSessionId": "Unique identifier for a player session.
" + } + }, + "PlayerSessionList": { + "base": null, + "refs": { + "CreatePlayerSessionsOutput$PlayerSessions": "Collection of player session objects created for the added players.
", + "DescribePlayerSessionsOutput$PlayerSessions": "Collection of objects containing properties for each player session that matches the request.
" + } + }, + "PlayerSessionStatus": { + "base": null, + "refs": { + "PlayerSession$Status": "Current status of the player session. Possible player session states include the following:
Port number for the game session. To connect to a GameLift server process, an app needs both the IP address and port number.
", + "IpPermission$FromPort": "Starting value for a range of allowed port numbers.
", + "IpPermission$ToPort": "Ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort.
Port number for the game session. To connect to a GameLift server process, an app needs both the IP address and port number.
" + } + }, + "PositiveInteger": { + "base": null, + "refs": { + "DescribeFleetAttributesInput$Limit": "Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. This parameter is ignored when the request specifies one or a list of fleet IDs.
Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. This parameter is ignored when the request specifies one or a list of fleet IDs.
Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. This parameter is ignored when the request specifies one or a list of fleet IDs.
Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. If a player session ID is specified, this parameter is ignored.
Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.
", + "ScalingPolicy$EvaluationPeriods": "Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.
", + "ServerProcess$ConcurrentExecutions": "Number of server processes using this configuration to run concurrently on an instance.
" + } + }, + "PositiveLong": { + "base": null, + "refs": { + "Build$SizeOnDisk": "File size of the uploaded game build, expressed in bytes. When the build state is INITIALIZED, this value is 0.
Game session protection policy to apply to all instances in this fleet. If this parameter is not set, instances in this fleet default to no protection. You can change a fleet's protection policy using UpdateFleetAttributes, but this change will only affect sessions created after the policy change. You can also set protection for individual instances using UpdateGameSession.
ACTIVE status, it cannot be terminated during a scale-down event.Type of game session protection to set for all new instances started in the fleet.
ACTIVE status, it cannot be terminated during a scale-down event.Current status of protection for the game session.
ACTIVE status, it cannot be terminated during a scale-down event.Game session protection policy to apply to all new instances created in this fleet. Instances that already exist are not affected. You can set protection for individual instances using UpdateGameSession.
ACTIVE status, it cannot be terminated during a scale-down event.Game session protection policy to apply to this game session only.
ACTIVE status, it cannot be terminated during a scale-down event.Represents the input for a request action.
", + "refs": { + } + }, + "PutScalingPolicyOutput": { + "base": "Represents the returned data in response to a request action.
", + "refs": { + } + }, + "RequestUploadCredentialsInput": { + "base": "Represents the input for a request action.
", + "refs": { + } + }, + "RequestUploadCredentialsOutput": { + "base": "Represents the returned data in response to a request action.
", + "refs": { + } + }, + "ResolveAliasInput": { + "base": "Represents the input for a request action.
", + "refs": { + } + }, + "ResolveAliasOutput": { + "base": "Represents the returned data in response to a request action.
", + "refs": { + } + }, + "RoutingStrategy": { + "base": "Routing configuration for a fleet alias.
", + "refs": { + "Alias$RoutingStrategy": null, + "CreateAliasInput$RoutingStrategy": "Object specifying the fleet and routing type to use for the alias.
", + "UpdateAliasInput$RoutingStrategy": "Object specifying the fleet and routing type to use for the alias.
" + } + }, + "RoutingStrategyType": { + "base": null, + "refs": { + "ListAliasesInput$RoutingStrategyType": "Type of routing to filter results on. Use this parameter to retrieve only aliases of a certain type. To retrieve all aliases, leave this parameter empty. Possible routing types include the following:
Type of routing strategy. Possible routing types include the following:
Collection of server process configurations that describe what processes should be run on each instance in a fleet. An instance can launch and maintain multiple server processes based on the runtime configuration; it regularly checks for an updated runtime configuration and starts new server processes to match the latest version.
The key purpose of a a runtime configuration with multiple server process configurations is to be able to run more than one kind of game server in a single fleet. You can include configurations for more than one server executable in order to run two or more different programs to run on the same instance. This option might be useful, for example, to run more than one version of your game server on the same fleet. Another option is to specify configurations for the same server executable but with different launch parameters.
A GameLift instance is limited to 50 processes running simultaneously. To calculate the total number of processes specified in a runtime configuration, add the values of the ConcurrentExecutions parameter for each ServerProcess object in the runtime configuration.
Instructions for launching server processes on each instance in the fleet. The runtime configuration for a fleet has a collection of server process configurations, one for each type of server process to run on an instance. A server process configuration specifies the location of the server executable, launch parameters, and the number of concurrent processes with that configuration to maintain on each instance. A CreateFleet request must include a runtime configuration with at least one server process configuration; otherwise the request will fail with an invalid request exception. (This parameter replaces the parameters ServerLaunchPath and ServerLaunchParameters; requests that contain values for these parameters instead of a runtime configuration will continue to work.)
Instructions describing how server processes should be launched and maintained on each instance in the fleet.
", + "UpdateRuntimeConfigurationInput$RuntimeConfiguration": "Instructions for launching server processes on each instance in the fleet. The runtime configuration for a fleet has a collection of server process configurations, one for each type of server process to run on an instance. A server process configuration specifies the location of the server executable, launch parameters, and the number of concurrent processes with that configuration to maintain on each instance.
", + "UpdateRuntimeConfigurationOutput$RuntimeConfiguration": "The runtime configuration currently in force. If the update was successful, this object matches the one in the request.
" + } + }, + "S3Location": { + "base": "Location in Amazon Simple Storage Service (Amazon S3) where a build's files are stored. This location is assigned in response to a CreateBuild call, and is always in the same region as the service used to create the build. For more details see the Amazon S3 documentation.
", + "refs": { + "CreateBuildInput$StorageLocation": null, + "CreateBuildOutput$StorageLocation": "Amazon S3 path and key, identifying where the game build files are stored.
", + "RequestUploadCredentialsOutput$StorageLocation": "Amazon S3 path and key, identifying where the game build files are stored.
" + } + }, + "ScalingAdjustmentType": { + "base": null, + "refs": { + "PutScalingPolicyInput$ScalingAdjustmentType": "Type of adjustment to make to a fleet's instance count (see FleetCapacity):
Type of adjustment to make to a fleet's instance count (see FleetCapacity):
Rule that controls how a fleet is scaled. Scaling policies are uniquely identified by the combination of name and fleet ID.
", + "refs": { + "ScalingPolicyList$member": null + } + }, + "ScalingPolicyList": { + "base": null, + "refs": { + "DescribeScalingPoliciesOutput$ScalingPolicies": "Collection of objects containing the scaling policies matching the request.
" + } + }, + "ScalingStatusType": { + "base": null, + "refs": { + "DescribeScalingPoliciesInput$StatusFilter": "Game session status to filter results on. A scaling policy is only in force when in an Active state.
Current status of the scaling policy. The scaling policy is only in force when in an Active state.
A set of instructions for launching server processes on each instance in a fleet. Each instruction set identifies the location of the server executable, optional launch parameters, and the number of server processes with this configuration to maintain concurrently on the instance. Server process configurations make up a fleet's RuntimeConfiguration.
Collection of server process configurations describing what server processes to run on each instance in a fleet
" + } + }, + "StringList": { + "base": null, + "refs": { + "CreateFleetInput$LogPaths": "Location of default log files. When a server process is shut down, Amazon GameLift captures and stores any log files in this location. These logs are in addition to game session logs; see more on game session logs in the Amazon GameLift Developer Guide. If no default log path for a fleet is specified, GameLift will automatically upload logs stored on each instance at C:\\game\\logs. Use the GameLift console to access stored logs.
Location of default log files. When a server process is shut down, Amazon GameLift captures and stores any log files in this location. These logs are in addition to game session logs; see more on game session logs in the Amazon GameLift Developer Guide. If no default log path for a fleet is specified, GameLift will automatically upload logs stored on each instance at C:\\game\\logs. Use the GameLift console to access stored logs.
The service is unable to resolve the routing for a particular alias because it has a terminal RoutingStrategy associated with it. The message returned in this exception is the message defined in the TerminalRoutingStrategy itself. Such requests should only be retried if the routing strategy for the specified alias is modified.
", + "refs": { + } + }, + "Timestamp": { + "base": null, + "refs": { + "Alias$CreationTime": "Time stamp indicating when this object was created. Format is an integer representing the number of seconds since the Unix epoch (Unix time).
", + "Alias$LastUpdatedTime": "Time stamp indicating when this object was last modified. Format is an integer representing the number of seconds since the Unix epoch (Unix time).
", + "Build$CreationTime": "Time stamp indicating when this object was created. Format is an integer representing the number of seconds since the Unix epoch (Unix time).
", + "DescribeFleetEventsInput$StartTime": "Earliest date to retrieve event logs for. If no start time is specified, this call returns entries starting from when the fleet was created to the specified end time. Format is an integer representing the number of seconds since the Unix epoch (Unix time).
", + "DescribeFleetEventsInput$EndTime": "Most recent date to retrieve event logs for. If no end time is specified, this call returns entries from the specified start time up to the present. Format is an integer representing the number of seconds since the Unix epoch (Unix time).
", + "Event$EventTime": "Time stamp indicating when this event occurred. Format is an integer representing the number of seconds since the Unix epoch (Unix time).
", + "FleetAttributes$CreationTime": "Time stamp indicating when this object was created. Format is an integer representing the number of seconds since the Unix epoch (Unix time).
", + "FleetAttributes$TerminationTime": "Time stamp indicating when this fleet was terminated. Format is an integer representing the number of seconds since the Unix epoch (Unix time).
", + "GameSession$CreationTime": "Time stamp indicating when this object was created. Format is an integer representing the number of seconds since the Unix epoch (Unix time).
", + "GameSession$TerminationTime": "Time stamp indicating when this fleet was terminated. Format is an integer representing the number of seconds since the Unix epoch (Unix time).
", + "PlayerSession$CreationTime": "Time stamp indicating when this object was created. Format is an integer representing the number of seconds since the Unix epoch (Unix time).
", + "PlayerSession$TerminationTime": "Time stamp indicating when this fleet was terminated. Format is an integer representing the number of seconds since the Unix epoch (Unix time).
" + } + }, + "UnauthorizedException": { + "base": "The client failed authentication. Clients should not retry such requests
", + "refs": { + } + }, + "UpdateAliasInput": { + "base": "Represents the input for a request action.
", + "refs": { + } + }, + "UpdateAliasOutput": { + "base": "Represents the returned data in response to a request action.
", + "refs": { + } + }, + "UpdateBuildInput": { + "base": "Represents the input for a request action.
", + "refs": { + } + }, + "UpdateBuildOutput": { + "base": "Represents the returned data in response to a request action.
", + "refs": { + } + }, + "UpdateFleetAttributesInput": { + "base": "Represents the input for a request action.
", + "refs": { + } + }, + "UpdateFleetAttributesOutput": { + "base": "Represents the returned data in response to a request action.
", + "refs": { + } + }, + "UpdateFleetCapacityInput": { + "base": "Represents the input for a request action.
", + "refs": { + } + }, + "UpdateFleetCapacityOutput": { + "base": "Represents the returned data in response to a request action.
", + "refs": { + } + }, + "UpdateFleetPortSettingsInput": { + "base": "Represents the input for a request action.
", + "refs": { + } + }, + "UpdateFleetPortSettingsOutput": { + "base": "Represents the returned data in response to a request action.
", + "refs": { + } + }, + "UpdateGameSessionInput": { + "base": "Represents the input for a request action.
", + "refs": { + } + }, + "UpdateGameSessionOutput": { + "base": "Represents the returned data in response to a request action.
", + "refs": { + } + }, + "UpdateRuntimeConfigurationInput": { + "base": "Represents the input for a request action.
", + "refs": { + } + }, + "UpdateRuntimeConfigurationOutput": { + "base": "Represents the returned data in response to a request action.
", + "refs": { + } + }, + "WholeNumber": { + "base": null, + "refs": { + "CreateGameSessionInput$MaximumPlayerSessionCount": "Maximum number of players that can be connected simultaneously to the game session.
", + "EC2InstanceCounts$DESIRED": "Ideal number of active instances in the fleet.
", + "EC2InstanceCounts$MINIMUM": "Minimum value allowed for the fleet's instance count.
", + "EC2InstanceCounts$MAXIMUM": "Maximum value allowed for the fleet's instance count.
", + "EC2InstanceCounts$PENDING": "Number of instances in the fleet that are starting but not yet active.
", + "EC2InstanceCounts$ACTIVE": "Actual number of active instances in the fleet.
", + "EC2InstanceCounts$IDLE": "Number of active instances in the fleet that are not currently hosting a game session.
", + "EC2InstanceCounts$TERMINATING": "Number of instances in the fleet that are no longer active but haven't yet been terminated.
", + "EC2InstanceLimit$CurrentInstances": "Number of instances of the specified type that are currently in use by this AWS account.
", + "EC2InstanceLimit$InstanceLimit": "Number of instances allowed.
", + "FleetUtilization$ActiveServerProcessCount": "Number of server processes in an ACTIVE state currently running across all instances in the fleet
Number of active game sessions currently being hosted on all instances in the fleet.
", + "FleetUtilization$CurrentPlayerSessionCount": "Number of active player sessions currently being hosted on all instances in the fleet.
", + "FleetUtilization$MaximumPlayerSessionCount": "Maximum players allowed across all game sessions currently being hosted on all instances in the fleet.
", + "GameSession$CurrentPlayerSessionCount": "Number of players currently in the game session.
", + "GameSession$MaximumPlayerSessionCount": "Maximum number of players allowed in the game session.
", + "UpdateFleetCapacityInput$DesiredInstances": "Number of EC2 instances you want this fleet to host.
", + "UpdateFleetCapacityInput$MinSize": "Minimum value allowed for the fleet's instance count. Default if not set is 0.
", + "UpdateFleetCapacityInput$MaxSize": "Maximum value allowed for the fleet's instance count. Default if not set is 1.
", + "UpdateGameSessionInput$MaximumPlayerSessionCount": "Maximum number of players that can be simultaneously connected to the game session.
" + } + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/gamelift/2015-10-01/examples-1.json b/vendor/github.com/aws/aws-sdk-go/models/apis/gamelift/2015-10-01/examples-1.json new file mode 100644 index 000000000..faff76894 --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/gamelift/2015-10-01/examples-1.json @@ -0,0 +1,5 @@ +{ + "version":"1.0", + "examples":{ + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/glacier/2012-06-01/api-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/glacier/2012-06-01/api-2.json new file mode 100644 index 000000000..d7db69087 --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/glacier/2012-06-01/api-2.json @@ -0,0 +1,2144 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2012-06-01", + "checksumFormat":"sha256", + "endpointPrefix":"glacier", + "serviceFullName":"Amazon Glacier", + "signatureVersion":"v4", + "protocol":"rest-json" + }, + "operations":{ + "AbortMultipartUpload":{ + "name":"AbortMultipartUpload", + "http":{ + "method":"DELETE", + "requestUri":"/{accountId}/vaults/{vaultName}/multipart-uploads/{uploadId}", + "responseCode":204 + }, + "input":{"shape":"AbortMultipartUploadInput"}, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"MissingParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":500}, + "exception":true + } + ] + }, + "AbortVaultLock":{ + "name":"AbortVaultLock", + "http":{ + "method":"DELETE", + "requestUri":"/{accountId}/vaults/{vaultName}/lock-policy", + "responseCode":204 + }, + "input":{"shape":"AbortVaultLockInput"}, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"MissingParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":500}, + "exception":true + } + ] + }, + "AddTagsToVault":{ + "name":"AddTagsToVault", + "http":{ + "method":"POST", + "requestUri":"/{accountId}/vaults/{vaultName}/tags?operation=add", + "responseCode":204 + }, + "input":{"shape":"AddTagsToVaultInput"}, + "errors":[ + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"MissingParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"LimitExceededException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":500}, + "exception":true + } + ] + }, + "CompleteMultipartUpload":{ + "name":"CompleteMultipartUpload", + "http":{ + "method":"POST", + "requestUri":"/{accountId}/vaults/{vaultName}/multipart-uploads/{uploadId}", + "responseCode":201 + }, + "input":{"shape":"CompleteMultipartUploadInput"}, + "output":{"shape":"ArchiveCreationOutput"}, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"MissingParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":500}, + "exception":true + } + ] + }, + "CompleteVaultLock":{ + "name":"CompleteVaultLock", + "http":{ + "method":"POST", + "requestUri":"/{accountId}/vaults/{vaultName}/lock-policy/{lockId}", + "responseCode":204 + }, + "input":{"shape":"CompleteVaultLockInput"}, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"MissingParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":500}, + "exception":true + } + ] + }, + "CreateVault":{ + "name":"CreateVault", + "http":{ + "method":"PUT", + "requestUri":"/{accountId}/vaults/{vaultName}", + "responseCode":201 + }, + "input":{"shape":"CreateVaultInput"}, + "output":{"shape":"CreateVaultOutput"}, + "errors":[ + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"MissingParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":500}, + "exception":true + }, + { + "shape":"LimitExceededException", + "error":{"httpStatusCode":400}, + "exception":true + } + ] + }, + "DeleteArchive":{ + "name":"DeleteArchive", + "http":{ + "method":"DELETE", + "requestUri":"/{accountId}/vaults/{vaultName}/archives/{archiveId}", + "responseCode":204 + }, + "input":{"shape":"DeleteArchiveInput"}, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"MissingParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":500}, + "exception":true + } + ] + }, + "DeleteVault":{ + "name":"DeleteVault", + "http":{ + "method":"DELETE", + "requestUri":"/{accountId}/vaults/{vaultName}", + "responseCode":204 + }, + "input":{"shape":"DeleteVaultInput"}, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"MissingParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":500}, + "exception":true + } + ] + }, + "DeleteVaultAccessPolicy":{ + "name":"DeleteVaultAccessPolicy", + "http":{ + "method":"DELETE", + "requestUri":"/{accountId}/vaults/{vaultName}/access-policy", + "responseCode":204 + }, + "input":{"shape":"DeleteVaultAccessPolicyInput"}, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"MissingParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":500}, + "exception":true + } + ] + }, + "DeleteVaultNotifications":{ + "name":"DeleteVaultNotifications", + "http":{ + "method":"DELETE", + "requestUri":"/{accountId}/vaults/{vaultName}/notification-configuration", + "responseCode":204 + }, + "input":{"shape":"DeleteVaultNotificationsInput"}, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"MissingParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":500}, + "exception":true + } + ] + }, + "DescribeJob":{ + "name":"DescribeJob", + "http":{ + "method":"GET", + "requestUri":"/{accountId}/vaults/{vaultName}/jobs/{jobId}" + }, + "input":{"shape":"DescribeJobInput"}, + "output":{"shape":"GlacierJobDescription"}, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"MissingParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":500}, + "exception":true + } + ] + }, + "DescribeVault":{ + "name":"DescribeVault", + "http":{ + "method":"GET", + "requestUri":"/{accountId}/vaults/{vaultName}" + }, + "input":{"shape":"DescribeVaultInput"}, + "output":{"shape":"DescribeVaultOutput"}, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"MissingParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":500}, + "exception":true + } + ] + }, + "GetDataRetrievalPolicy":{ + "name":"GetDataRetrievalPolicy", + "http":{ + "method":"GET", + "requestUri":"/{accountId}/policies/data-retrieval" + }, + "input":{"shape":"GetDataRetrievalPolicyInput"}, + "output":{"shape":"GetDataRetrievalPolicyOutput"}, + "errors":[ + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"MissingParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":500}, + "exception":true + } + ] + }, + "GetJobOutput":{ + "name":"GetJobOutput", + "http":{ + "method":"GET", + "requestUri":"/{accountId}/vaults/{vaultName}/jobs/{jobId}/output" + }, + "input":{"shape":"GetJobOutputInput"}, + "output":{"shape":"GetJobOutputOutput"}, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"MissingParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":500}, + "exception":true + } + ] + }, + "GetVaultAccessPolicy":{ + "name":"GetVaultAccessPolicy", + "http":{ + "method":"GET", + "requestUri":"/{accountId}/vaults/{vaultName}/access-policy" + }, + "input":{"shape":"GetVaultAccessPolicyInput"}, + "output":{"shape":"GetVaultAccessPolicyOutput"}, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"MissingParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":500}, + "exception":true + } + ] + }, + "GetVaultLock":{ + "name":"GetVaultLock", + "http":{ + "method":"GET", + "requestUri":"/{accountId}/vaults/{vaultName}/lock-policy" + }, + "input":{"shape":"GetVaultLockInput"}, + "output":{"shape":"GetVaultLockOutput"}, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"MissingParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":500}, + "exception":true + } + ] + }, + "GetVaultNotifications":{ + "name":"GetVaultNotifications", + "http":{ + "method":"GET", + "requestUri":"/{accountId}/vaults/{vaultName}/notification-configuration" + }, + "input":{"shape":"GetVaultNotificationsInput"}, + "output":{"shape":"GetVaultNotificationsOutput"}, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"MissingParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":500}, + "exception":true + } + ] + }, + "InitiateJob":{ + "name":"InitiateJob", + "http":{ + "method":"POST", + "requestUri":"/{accountId}/vaults/{vaultName}/jobs", + "responseCode":202 + }, + "input":{"shape":"InitiateJobInput"}, + "output":{"shape":"InitiateJobOutput"}, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"PolicyEnforcedException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"MissingParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":500}, + "exception":true + } + ] + }, + "InitiateMultipartUpload":{ + "name":"InitiateMultipartUpload", + "http":{ + "method":"POST", + "requestUri":"/{accountId}/vaults/{vaultName}/multipart-uploads", + "responseCode":201 + }, + "input":{"shape":"InitiateMultipartUploadInput"}, + "output":{"shape":"InitiateMultipartUploadOutput"}, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"MissingParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":500}, + "exception":true + } + ] + }, + "InitiateVaultLock":{ + "name":"InitiateVaultLock", + "http":{ + "method":"POST", + "requestUri":"/{accountId}/vaults/{vaultName}/lock-policy", + "responseCode":201 + }, + "input":{"shape":"InitiateVaultLockInput"}, + "output":{"shape":"InitiateVaultLockOutput"}, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"MissingParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":500}, + "exception":true + } + ] + }, + "ListJobs":{ + "name":"ListJobs", + "http":{ + "method":"GET", + "requestUri":"/{accountId}/vaults/{vaultName}/jobs" + }, + "input":{"shape":"ListJobsInput"}, + "output":{"shape":"ListJobsOutput"}, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"MissingParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":500}, + "exception":true + } + ] + }, + "ListMultipartUploads":{ + "name":"ListMultipartUploads", + "http":{ + "method":"GET", + "requestUri":"/{accountId}/vaults/{vaultName}/multipart-uploads" + }, + "input":{"shape":"ListMultipartUploadsInput"}, + "output":{"shape":"ListMultipartUploadsOutput"}, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"MissingParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":500}, + "exception":true + } + ] + }, + "ListParts":{ + "name":"ListParts", + "http":{ + "method":"GET", + "requestUri":"/{accountId}/vaults/{vaultName}/multipart-uploads/{uploadId}" + }, + "input":{"shape":"ListPartsInput"}, + "output":{"shape":"ListPartsOutput"}, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"MissingParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":500}, + "exception":true + } + ] + }, + "ListTagsForVault":{ + "name":"ListTagsForVault", + "http":{ + "method":"GET", + "requestUri":"/{accountId}/vaults/{vaultName}/tags" + }, + "input":{"shape":"ListTagsForVaultInput"}, + "output":{"shape":"ListTagsForVaultOutput"}, + "errors":[ + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"MissingParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":500}, + "exception":true + } + ] + }, + "ListVaults":{ + "name":"ListVaults", + "http":{ + "method":"GET", + "requestUri":"/{accountId}/vaults" + }, + "input":{"shape":"ListVaultsInput"}, + "output":{"shape":"ListVaultsOutput"}, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"MissingParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":500}, + "exception":true + } + ] + }, + "RemoveTagsFromVault":{ + "name":"RemoveTagsFromVault", + "http":{ + "method":"POST", + "requestUri":"/{accountId}/vaults/{vaultName}/tags?operation=remove", + "responseCode":204 + }, + "input":{"shape":"RemoveTagsFromVaultInput"}, + "errors":[ + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"MissingParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":500}, + "exception":true + } + ] + }, + "SetDataRetrievalPolicy":{ + "name":"SetDataRetrievalPolicy", + "http":{ + "method":"PUT", + "requestUri":"/{accountId}/policies/data-retrieval", + "responseCode":204 + }, + "input":{"shape":"SetDataRetrievalPolicyInput"}, + "errors":[ + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"MissingParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":500}, + "exception":true + } + ] + }, + "SetVaultAccessPolicy":{ + "name":"SetVaultAccessPolicy", + "http":{ + "method":"PUT", + "requestUri":"/{accountId}/vaults/{vaultName}/access-policy", + "responseCode":204 + }, + "input":{"shape":"SetVaultAccessPolicyInput"}, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"MissingParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":500}, + "exception":true + } + ] + }, + "SetVaultNotifications":{ + "name":"SetVaultNotifications", + "http":{ + "method":"PUT", + "requestUri":"/{accountId}/vaults/{vaultName}/notification-configuration", + "responseCode":204 + }, + "input":{"shape":"SetVaultNotificationsInput"}, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"MissingParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":500}, + "exception":true + } + ] + }, + "UploadArchive":{ + "name":"UploadArchive", + "http":{ + "method":"POST", + "requestUri":"/{accountId}/vaults/{vaultName}/archives", + "responseCode":201 + }, + "input":{"shape":"UploadArchiveInput"}, + "output":{"shape":"ArchiveCreationOutput"}, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"MissingParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"RequestTimeoutException", + "error":{"httpStatusCode":408}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":500}, + "exception":true + } + ] + }, + "UploadMultipartPart":{ + "name":"UploadMultipartPart", + "http":{ + "method":"PUT", + "requestUri":"/{accountId}/vaults/{vaultName}/multipart-uploads/{uploadId}", + "responseCode":204 + }, + "input":{"shape":"UploadMultipartPartInput"}, + "output":{"shape":"UploadMultipartPartOutput"}, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"MissingParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"RequestTimeoutException", + "error":{"httpStatusCode":408}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":500}, + "exception":true + } + ] + } + }, + "shapes":{ + "AbortMultipartUploadInput":{ + "type":"structure", + "members":{ + "accountId":{ + "shape":"string", + "location":"uri", + "locationName":"accountId" + }, + "vaultName":{ + "shape":"string", + "location":"uri", + "locationName":"vaultName" + }, + "uploadId":{ + "shape":"string", + "location":"uri", + "locationName":"uploadId" + } + }, + "required":[ + "accountId", + "vaultName", + "uploadId" + ] + }, + "AbortVaultLockInput":{ + "type":"structure", + "members":{ + "accountId":{ + "shape":"string", + "location":"uri", + "locationName":"accountId" + }, + "vaultName":{ + "shape":"string", + "location":"uri", + "locationName":"vaultName" + } + }, + "required":[ + "accountId", + "vaultName" + ] + }, + "ActionCode":{ + "type":"string", + "enum":[ + "ArchiveRetrieval", + "InventoryRetrieval" + ] + }, + "AddTagsToVaultInput":{ + "type":"structure", + "members":{ + "accountId":{ + "shape":"string", + "location":"uri", + "locationName":"accountId" + }, + "vaultName":{ + "shape":"string", + "location":"uri", + "locationName":"vaultName" + }, + "Tags":{"shape":"TagMap"} + }, + "required":[ + "accountId", + "vaultName" + ] + }, + "ArchiveCreationOutput":{ + "type":"structure", + "members":{ + "location":{ + "shape":"string", + "location":"header", + "locationName":"Location" + }, + "checksum":{ + "shape":"string", + "location":"header", + "locationName":"x-amz-sha256-tree-hash" + }, + "archiveId":{ + "shape":"string", + "location":"header", + "locationName":"x-amz-archive-id" + } + } + }, + "CompleteMultipartUploadInput":{ + "type":"structure", + "members":{ + "accountId":{ + "shape":"string", + "location":"uri", + "locationName":"accountId" + }, + "vaultName":{ + "shape":"string", + "location":"uri", + "locationName":"vaultName" + }, + "uploadId":{ + "shape":"string", + "location":"uri", + "locationName":"uploadId" + }, + "archiveSize":{ + "shape":"string", + "location":"header", + "locationName":"x-amz-archive-size" + }, + "checksum":{ + "shape":"string", + "location":"header", + "locationName":"x-amz-sha256-tree-hash" + } + }, + "required":[ + "accountId", + "vaultName", + "uploadId" + ] + }, + "CompleteVaultLockInput":{ + "type":"structure", + "members":{ + "accountId":{ + "shape":"string", + "location":"uri", + "locationName":"accountId" + }, + "vaultName":{ + "shape":"string", + "location":"uri", + "locationName":"vaultName" + }, + "lockId":{ + "shape":"string", + "location":"uri", + "locationName":"lockId" + } + }, + "required":[ + "accountId", + "vaultName", + "lockId" + ] + }, + "CreateVaultInput":{ + "type":"structure", + "members":{ + "accountId":{ + "shape":"string", + "location":"uri", + "locationName":"accountId" + }, + "vaultName":{ + "shape":"string", + "location":"uri", + "locationName":"vaultName" + } + }, + "required":[ + "accountId", + "vaultName" + ] + }, + "CreateVaultOutput":{ + "type":"structure", + "members":{ + "location":{ + "shape":"string", + "location":"header", + "locationName":"Location" + } + } + }, + "DataRetrievalPolicy":{ + "type":"structure", + "members":{ + "Rules":{"shape":"DataRetrievalRulesList"} + } + }, + "DataRetrievalRule":{ + "type":"structure", + "members":{ + "Strategy":{"shape":"string"}, + "BytesPerHour":{"shape":"NullableLong"} + } + }, + "DataRetrievalRulesList":{ + "type":"list", + "member":{"shape":"DataRetrievalRule"} + }, + "DateTime":{"type":"string"}, + "DeleteArchiveInput":{ + "type":"structure", + "members":{ + "accountId":{ + "shape":"string", + "location":"uri", + "locationName":"accountId" + }, + "vaultName":{ + "shape":"string", + "location":"uri", + "locationName":"vaultName" + }, + "archiveId":{ + "shape":"string", + "location":"uri", + "locationName":"archiveId" + } + }, + "required":[ + "accountId", + "vaultName", + "archiveId" + ] + }, + "DeleteVaultAccessPolicyInput":{ + "type":"structure", + "members":{ + "accountId":{ + "shape":"string", + "location":"uri", + "locationName":"accountId" + }, + "vaultName":{ + "shape":"string", + "location":"uri", + "locationName":"vaultName" + } + }, + "required":[ + "accountId", + "vaultName" + ] + }, + "DeleteVaultInput":{ + "type":"structure", + "members":{ + "accountId":{ + "shape":"string", + "location":"uri", + "locationName":"accountId" + }, + "vaultName":{ + "shape":"string", + "location":"uri", + "locationName":"vaultName" + } + }, + "required":[ + "accountId", + "vaultName" + ] + }, + "DeleteVaultNotificationsInput":{ + "type":"structure", + "members":{ + "accountId":{ + "shape":"string", + "location":"uri", + "locationName":"accountId" + }, + "vaultName":{ + "shape":"string", + "location":"uri", + "locationName":"vaultName" + } + }, + "required":[ + "accountId", + "vaultName" + ] + }, + "DescribeJobInput":{ + "type":"structure", + "members":{ + "accountId":{ + "shape":"string", + "location":"uri", + "locationName":"accountId" + }, + "vaultName":{ + "shape":"string", + "location":"uri", + "locationName":"vaultName" + }, + "jobId":{ + "shape":"string", + "location":"uri", + "locationName":"jobId" + } + }, + "required":[ + "accountId", + "vaultName", + "jobId" + ] + }, + "DescribeVaultInput":{ + "type":"structure", + "members":{ + "accountId":{ + "shape":"string", + "location":"uri", + "locationName":"accountId" + }, + "vaultName":{ + "shape":"string", + "location":"uri", + "locationName":"vaultName" + } + }, + "required":[ + "accountId", + "vaultName" + ] + }, + "DescribeVaultOutput":{ + "type":"structure", + "members":{ + "VaultARN":{"shape":"string"}, + "VaultName":{"shape":"string"}, + "CreationDate":{"shape":"string"}, + "LastInventoryDate":{"shape":"string"}, + "NumberOfArchives":{"shape":"long"}, + "SizeInBytes":{"shape":"long"} + } + }, + "GetDataRetrievalPolicyInput":{ + "type":"structure", + "members":{ + "accountId":{ + "shape":"string", + "location":"uri", + "locationName":"accountId" + } + }, + "required":["accountId"] + }, + "GetDataRetrievalPolicyOutput":{ + "type":"structure", + "members":{ + "Policy":{"shape":"DataRetrievalPolicy"} + } + }, + "GetJobOutputInput":{ + "type":"structure", + "members":{ + "accountId":{ + "shape":"string", + "location":"uri", + "locationName":"accountId" + }, + "vaultName":{ + "shape":"string", + "location":"uri", + "locationName":"vaultName" + }, + "jobId":{ + "shape":"string", + "location":"uri", + "locationName":"jobId" + }, + "range":{ + "shape":"string", + "location":"header", + "locationName":"Range" + } + }, + "required":[ + "accountId", + "vaultName", + "jobId" + ] + }, + "GetJobOutputOutput":{ + "type":"structure", + "members":{ + "body":{"shape":"Stream"}, + "checksum":{ + "shape":"string", + "location":"header", + "locationName":"x-amz-sha256-tree-hash" + }, + "status":{ + "shape":"httpstatus", + "location":"statusCode" + }, + "contentRange":{ + "shape":"string", + "location":"header", + "locationName":"Content-Range" + }, + "acceptRanges":{ + "shape":"string", + "location":"header", + "locationName":"Accept-Ranges" + }, + "contentType":{ + "shape":"string", + "location":"header", + "locationName":"Content-Type" + }, + "archiveDescription":{ + "shape":"string", + "location":"header", + "locationName":"x-amz-archive-description" + } + }, + "payload":"body" + }, + "GetVaultAccessPolicyInput":{ + "type":"structure", + "members":{ + "accountId":{ + "shape":"string", + "location":"uri", + "locationName":"accountId" + }, + "vaultName":{ + "shape":"string", + "location":"uri", + "locationName":"vaultName" + } + }, + "required":[ + "accountId", + "vaultName" + ] + }, + "GetVaultAccessPolicyOutput":{ + "type":"structure", + "members":{ + "policy":{"shape":"VaultAccessPolicy"} + }, + "payload":"policy" + }, + "GetVaultLockInput":{ + "type":"structure", + "members":{ + "accountId":{ + "shape":"string", + "location":"uri", + "locationName":"accountId" + }, + "vaultName":{ + "shape":"string", + "location":"uri", + "locationName":"vaultName" + } + }, + "required":[ + "accountId", + "vaultName" + ] + }, + "GetVaultLockOutput":{ + "type":"structure", + "members":{ + "Policy":{"shape":"string"}, + "State":{"shape":"string"}, + "ExpirationDate":{"shape":"string"}, + "CreationDate":{"shape":"string"} + } + }, + "GetVaultNotificationsInput":{ + "type":"structure", + "members":{ + "accountId":{ + "shape":"string", + "location":"uri", + "locationName":"accountId" + }, + "vaultName":{ + "shape":"string", + "location":"uri", + "locationName":"vaultName" + } + }, + "required":[ + "accountId", + "vaultName" + ] + }, + "GetVaultNotificationsOutput":{ + "type":"structure", + "members":{ + "vaultNotificationConfig":{"shape":"VaultNotificationConfig"} + }, + "payload":"vaultNotificationConfig" + }, + "GlacierJobDescription":{ + "type":"structure", + "members":{ + "JobId":{"shape":"string"}, + "JobDescription":{"shape":"string"}, + "Action":{"shape":"ActionCode"}, + "ArchiveId":{"shape":"string"}, + "VaultARN":{"shape":"string"}, + "CreationDate":{"shape":"string"}, + "Completed":{"shape":"boolean"}, + "StatusCode":{"shape":"StatusCode"}, + "StatusMessage":{"shape":"string"}, + "ArchiveSizeInBytes":{"shape":"Size"}, + "InventorySizeInBytes":{"shape":"Size"}, + "SNSTopic":{"shape":"string"}, + "CompletionDate":{"shape":"string"}, + "SHA256TreeHash":{"shape":"string"}, + "ArchiveSHA256TreeHash":{"shape":"string"}, + "RetrievalByteRange":{"shape":"string"}, + "InventoryRetrievalParameters":{"shape":"InventoryRetrievalJobDescription"} + } + }, + "InitiateJobInput":{ + "type":"structure", + "members":{ + "accountId":{ + "shape":"string", + "location":"uri", + "locationName":"accountId" + }, + "vaultName":{ + "shape":"string", + "location":"uri", + "locationName":"vaultName" + }, + "jobParameters":{"shape":"JobParameters"} + }, + "required":[ + "accountId", + "vaultName" + ], + "payload":"jobParameters" + }, + "InitiateJobOutput":{ + "type":"structure", + "members":{ + "location":{ + "shape":"string", + "location":"header", + "locationName":"Location" + }, + "jobId":{ + "shape":"string", + "location":"header", + "locationName":"x-amz-job-id" + } + } + }, + "InitiateMultipartUploadInput":{ + "type":"structure", + "members":{ + "accountId":{ + "shape":"string", + "location":"uri", + "locationName":"accountId" + }, + "vaultName":{ + "shape":"string", + "location":"uri", + "locationName":"vaultName" + }, + "archiveDescription":{ + "shape":"string", + "location":"header", + "locationName":"x-amz-archive-description" + }, + "partSize":{ + "shape":"string", + "location":"header", + "locationName":"x-amz-part-size" + } + }, + "required":[ + "accountId", + "vaultName" + ] + }, + "InitiateMultipartUploadOutput":{ + "type":"structure", + "members":{ + "location":{ + "shape":"string", + "location":"header", + "locationName":"Location" + }, + "uploadId":{ + "shape":"string", + "location":"header", + "locationName":"x-amz-multipart-upload-id" + } + } + }, + "InitiateVaultLockInput":{ + "type":"structure", + "members":{ + "accountId":{ + "shape":"string", + "location":"uri", + "locationName":"accountId" + }, + "vaultName":{ + "shape":"string", + "location":"uri", + "locationName":"vaultName" + }, + "policy":{"shape":"VaultLockPolicy"} + }, + "required":[ + "accountId", + "vaultName" + ], + "payload":"policy" + }, + "InitiateVaultLockOutput":{ + "type":"structure", + "members":{ + "lockId":{ + "shape":"string", + "location":"header", + "locationName":"x-amz-lock-id" + } + } + }, + "InvalidParameterValueException":{ + "type":"structure", + "members":{ + "type":{"shape":"string"}, + "code":{"shape":"string"}, + "message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InventoryRetrievalJobDescription":{ + "type":"structure", + "members":{ + "Format":{"shape":"string"}, + "StartDate":{"shape":"DateTime"}, + "EndDate":{"shape":"DateTime"}, + "Limit":{"shape":"string"}, + "Marker":{"shape":"string"} + } + }, + "InventoryRetrievalJobInput":{ + "type":"structure", + "members":{ + "StartDate":{"shape":"string"}, + "EndDate":{"shape":"string"}, + "Limit":{"shape":"string"}, + "Marker":{"shape":"string"} + } + }, + "JobList":{ + "type":"list", + "member":{"shape":"GlacierJobDescription"} + }, + "JobParameters":{ + "type":"structure", + "members":{ + "Format":{"shape":"string"}, + "Type":{"shape":"string"}, + "ArchiveId":{"shape":"string"}, + "Description":{"shape":"string"}, + "SNSTopic":{"shape":"string"}, + "RetrievalByteRange":{"shape":"string"}, + "InventoryRetrievalParameters":{"shape":"InventoryRetrievalJobInput"} + } + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + "type":{"shape":"string"}, + "code":{"shape":"string"}, + "message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "ListJobsInput":{ + "type":"structure", + "members":{ + "accountId":{ + "shape":"string", + "location":"uri", + "locationName":"accountId" + }, + "vaultName":{ + "shape":"string", + "location":"uri", + "locationName":"vaultName" + }, + "limit":{ + "shape":"string", + "location":"querystring", + "locationName":"limit" + }, + "marker":{ + "shape":"string", + "location":"querystring", + "locationName":"marker" + }, + "statuscode":{ + "shape":"string", + "location":"querystring", + "locationName":"statuscode" + }, + "completed":{ + "shape":"string", + "location":"querystring", + "locationName":"completed" + } + }, + "required":[ + "accountId", + "vaultName" + ] + }, + "ListJobsOutput":{ + "type":"structure", + "members":{ + "JobList":{"shape":"JobList"}, + "Marker":{"shape":"string"} + } + }, + "ListMultipartUploadsInput":{ + "type":"structure", + "members":{ + "accountId":{ + "shape":"string", + "location":"uri", + "locationName":"accountId" + }, + "vaultName":{ + "shape":"string", + "location":"uri", + "locationName":"vaultName" + }, + "marker":{ + "shape":"string", + "location":"querystring", + "locationName":"marker" + }, + "limit":{ + "shape":"string", + "location":"querystring", + "locationName":"limit" + } + }, + "required":[ + "accountId", + "vaultName" + ] + }, + "ListMultipartUploadsOutput":{ + "type":"structure", + "members":{ + "UploadsList":{"shape":"UploadsList"}, + "Marker":{"shape":"string"} + } + }, + "ListPartsInput":{ + "type":"structure", + "members":{ + "accountId":{ + "shape":"string", + "location":"uri", + "locationName":"accountId" + }, + "vaultName":{ + "shape":"string", + "location":"uri", + "locationName":"vaultName" + }, + "uploadId":{ + "shape":"string", + "location":"uri", + "locationName":"uploadId" + }, + "marker":{ + "shape":"string", + "location":"querystring", + "locationName":"marker" + }, + "limit":{ + "shape":"string", + "location":"querystring", + "locationName":"limit" + } + }, + "required":[ + "accountId", + "vaultName", + "uploadId" + ] + }, + "ListPartsOutput":{ + "type":"structure", + "members":{ + "MultipartUploadId":{"shape":"string"}, + "VaultARN":{"shape":"string"}, + "ArchiveDescription":{"shape":"string"}, + "PartSizeInBytes":{"shape":"long"}, + "CreationDate":{"shape":"string"}, + "Parts":{"shape":"PartList"}, + "Marker":{"shape":"string"} + } + }, + "ListTagsForVaultInput":{ + "type":"structure", + "members":{ + "accountId":{ + "shape":"string", + "location":"uri", + "locationName":"accountId" + }, + "vaultName":{ + "shape":"string", + "location":"uri", + "locationName":"vaultName" + } + }, + "required":[ + "accountId", + "vaultName" + ] + }, + "ListTagsForVaultOutput":{ + "type":"structure", + "members":{ + "Tags":{"shape":"TagMap"} + } + }, + "ListVaultsInput":{ + "type":"structure", + "members":{ + "accountId":{ + "shape":"string", + "location":"uri", + "locationName":"accountId" + }, + "marker":{ + "shape":"string", + "location":"querystring", + "locationName":"marker" + }, + "limit":{ + "shape":"string", + "location":"querystring", + "locationName":"limit" + } + }, + "required":["accountId"] + }, + "ListVaultsOutput":{ + "type":"structure", + "members":{ + "VaultList":{"shape":"VaultList"}, + "Marker":{"shape":"string"} + } + }, + "MissingParameterValueException":{ + "type":"structure", + "members":{ + "type":{"shape":"string"}, + "code":{"shape":"string"}, + "message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "NotificationEventList":{ + "type":"list", + "member":{"shape":"string"} + }, + "NullableLong":{"type":"long"}, + "PartList":{ + "type":"list", + "member":{"shape":"PartListElement"} + }, + "PartListElement":{ + "type":"structure", + "members":{ + "RangeInBytes":{"shape":"string"}, + "SHA256TreeHash":{"shape":"string"} + } + }, + "PolicyEnforcedException":{ + "type":"structure", + "members":{ + "type":{"shape":"string"}, + "code":{"shape":"string"}, + "message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "RemoveTagsFromVaultInput":{ + "type":"structure", + "members":{ + "accountId":{ + "shape":"string", + "location":"uri", + "locationName":"accountId" + }, + "vaultName":{ + "shape":"string", + "location":"uri", + "locationName":"vaultName" + }, + "TagKeys":{"shape":"TagKeyList"} + }, + "required":[ + "accountId", + "vaultName" + ] + }, + "RequestTimeoutException":{ + "type":"structure", + "members":{ + "type":{"shape":"string"}, + "code":{"shape":"string"}, + "message":{"shape":"string"} + }, + "error":{"httpStatusCode":408}, + "exception":true + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "type":{"shape":"string"}, + "code":{"shape":"string"}, + "message":{"shape":"string"} + }, + "error":{"httpStatusCode":404}, + "exception":true + }, + "ServiceUnavailableException":{ + "type":"structure", + "members":{ + "type":{"shape":"string"}, + "code":{"shape":"string"}, + "message":{"shape":"string"} + }, + "error":{"httpStatusCode":500}, + "exception":true + }, + "SetDataRetrievalPolicyInput":{ + "type":"structure", + "members":{ + "accountId":{ + "shape":"string", + "location":"uri", + "locationName":"accountId" + }, + "Policy":{"shape":"DataRetrievalPolicy"} + }, + "required":["accountId"] + }, + "SetVaultAccessPolicyInput":{ + "type":"structure", + "members":{ + "accountId":{ + "shape":"string", + "location":"uri", + "locationName":"accountId" + }, + "vaultName":{ + "shape":"string", + "location":"uri", + "locationName":"vaultName" + }, + "policy":{"shape":"VaultAccessPolicy"} + }, + "required":[ + "accountId", + "vaultName" + ], + "payload":"policy" + }, + "SetVaultNotificationsInput":{ + "type":"structure", + "members":{ + "accountId":{ + "shape":"string", + "location":"uri", + "locationName":"accountId" + }, + "vaultName":{ + "shape":"string", + "location":"uri", + "locationName":"vaultName" + }, + "vaultNotificationConfig":{"shape":"VaultNotificationConfig"} + }, + "required":[ + "accountId", + "vaultName" + ], + "payload":"vaultNotificationConfig" + }, + "Size":{"type":"long"}, + "StatusCode":{ + "type":"string", + "enum":[ + "InProgress", + "Succeeded", + "Failed" + ] + }, + "Stream":{ + "type":"blob", + "streaming":true + }, + "TagKey":{"type":"string"}, + "TagKeyList":{ + "type":"list", + "member":{"shape":"string"} + }, + "TagMap":{ + "type":"map", + "key":{"shape":"TagKey"}, + "value":{"shape":"TagValue"} + }, + "TagValue":{"type":"string"}, + "UploadArchiveInput":{ + "type":"structure", + "members":{ + "vaultName":{ + "shape":"string", + "location":"uri", + "locationName":"vaultName" + }, + "accountId":{ + "shape":"string", + "location":"uri", + "locationName":"accountId" + }, + "archiveDescription":{ + "shape":"string", + "location":"header", + "locationName":"x-amz-archive-description" + }, + "checksum":{ + "shape":"string", + "location":"header", + "locationName":"x-amz-sha256-tree-hash" + }, + "body":{"shape":"Stream"} + }, + "required":[ + "vaultName", + "accountId" + ], + "payload":"body" + }, + "UploadListElement":{ + "type":"structure", + "members":{ + "MultipartUploadId":{"shape":"string"}, + "VaultARN":{"shape":"string"}, + "ArchiveDescription":{"shape":"string"}, + "PartSizeInBytes":{"shape":"long"}, + "CreationDate":{"shape":"string"} + } + }, + "UploadMultipartPartInput":{ + "type":"structure", + "members":{ + "accountId":{ + "shape":"string", + "location":"uri", + "locationName":"accountId" + }, + "vaultName":{ + "shape":"string", + "location":"uri", + "locationName":"vaultName" + }, + "uploadId":{ + "shape":"string", + "location":"uri", + "locationName":"uploadId" + }, + "checksum":{ + "shape":"string", + "location":"header", + "locationName":"x-amz-sha256-tree-hash" + }, + "range":{ + "shape":"string", + "location":"header", + "locationName":"Content-Range" + }, + "body":{"shape":"Stream"} + }, + "required":[ + "accountId", + "vaultName", + "uploadId" + ], + "payload":"body" + }, + "UploadMultipartPartOutput":{ + "type":"structure", + "members":{ + "checksum":{ + "shape":"string", + "location":"header", + "locationName":"x-amz-sha256-tree-hash" + } + } + }, + "UploadsList":{ + "type":"list", + "member":{"shape":"UploadListElement"} + }, + "VaultAccessPolicy":{ + "type":"structure", + "members":{ + "Policy":{"shape":"string"} + } + }, + "VaultList":{ + "type":"list", + "member":{"shape":"DescribeVaultOutput"} + }, + "VaultLockPolicy":{ + "type":"structure", + "members":{ + "Policy":{"shape":"string"} + } + }, + "VaultNotificationConfig":{ + "type":"structure", + "members":{ + "SNSTopic":{"shape":"string"}, + "Events":{"shape":"NotificationEventList"} + } + }, + "boolean":{"type":"boolean"}, + "httpstatus":{"type":"integer"}, + "long":{"type":"long"}, + "string":{"type":"string"} + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/glacier/2012-06-01/docs-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/glacier/2012-06-01/docs-2.json new file mode 100644 index 000000000..3138266c6 --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/glacier/2012-06-01/docs-2.json @@ -0,0 +1,685 @@ +{ + "version": "2.0", + "operations": { + "AbortMultipartUpload": "This operation aborts a multipart upload identified by the upload ID.
After the Abort Multipart Upload request succeeds, you cannot upload any more parts to the multipart upload or complete the multipart upload. Aborting a completed upload fails. However, aborting an already-aborted upload will succeed, for a short time. For more information about uploading a part and completing a multipart upload, see UploadMultipartPart and CompleteMultipartUpload.
This operation is idempotent.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and underlying REST API, go to Working with Archives in Amazon Glacier and Abort Multipart Upload in the Amazon Glacier Developer Guide.
", + "AbortVaultLock": "This operation aborts the vault locking process if the vault lock is not in the Locked state. If the vault lock is in the Locked state when this operation is requested, the operation returns an AccessDeniedException error. Aborting the vault locking process removes the vault lock policy from the specified vault.
A vault lock is put into the InProgress state by calling InitiateVaultLock. A vault lock is put into the Locked state by calling CompleteVaultLock. You can get the state of a vault lock by calling GetVaultLock. For more information about the vault locking process, see Amazon Glacier Vault Lock. For more information about vault lock policies, see Amazon Glacier Access Control with Vault Lock Policies.
This operation is idempotent. You can successfully invoke this operation multiple times, if the vault lock is in the InProgress state or if there is no policy associated with the vault.
This operation adds the specified tags to a vault. Each tag is composed of a key and a value. Each vault can have up to 10 tags. If your request would cause the tag limit for the vault to be exceeded, the operation throws the LimitExceededException error. If a tag already exists on the vault under a specified key, the existing key value will be overwritten. For more information about tags, see Tagging Amazon Glacier Resources.
You call this operation to inform Amazon Glacier that all the archive parts have been uploaded and that Amazon Glacier can now assemble the archive from the uploaded parts. After assembling and saving the archive to the vault, Amazon Glacier returns the URI path of the newly created archive resource. Using the URI path, you can then access the archive. After you upload an archive, you should save the archive ID returned to retrieve the archive at a later point. You can also get the vault inventory to obtain a list of archive IDs in a vault. For more information, see InitiateJob.
In the request, you must include the computed SHA256 tree hash of the entire archive you have uploaded. For information about computing a SHA256 tree hash, see Computing Checksums. On the server side, Amazon Glacier also constructs the SHA256 tree hash of the assembled archive. If the values match, Amazon Glacier saves the archive to the vault; otherwise, it returns an error, and the operation fails. The ListParts operation returns a list of parts uploaded for a specific multipart upload. It includes checksum information for each uploaded part that can be used to debug a bad checksum issue.
Additionally, Amazon Glacier also checks for any missing content ranges when assembling the archive, if missing content ranges are found, Amazon Glacier returns an error and the operation fails.
Complete Multipart Upload is an idempotent operation. After your first successful complete multipart upload, if you call the operation again within a short period, the operation will succeed and return the same archive ID. This is useful in the event you experience a network issue that causes an aborted connection or receive a 500 server error, in which case you can repeat your Complete Multipart Upload request and get the same archive ID without creating duplicate archives. Note, however, that after the multipart upload completes, you cannot call the List Parts operation and the multipart upload will not appear in List Multipart Uploads response, even if idempotent complete is possible.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and underlying REST API, go to Uploading Large Archives in Parts (Multipart Upload) and Complete Multipart Upload in the Amazon Glacier Developer Guide.
", + "CompleteVaultLock": "This operation completes the vault locking process by transitioning the vault lock from the InProgress state to the Locked state, which causes the vault lock policy to become unchangeable. A vault lock is put into the InProgress state by calling InitiateVaultLock. You can obtain the state of the vault lock by calling GetVaultLock. For more information about the vault locking process, Amazon Glacier Vault Lock.
This operation is idempotent. This request is always successful if the vault lock is in the Locked state and the provided lock ID matches the lock ID originally used to lock the vault.
If an invalid lock ID is passed in the request when the vault lock is in the Locked state, the operation returns an AccessDeniedException error. If an invalid lock ID is passed in the request when the vault lock is in the InProgress state, the operation throws an InvalidParameter error.
This operation creates a new vault with the specified name. The name of the vault must be unique within a region for an AWS account. You can create up to 1,000 vaults per account. If you need to create more vaults, contact Amazon Glacier.
You must use the following guidelines when naming a vault.
Names can be between 1 and 255 characters long.
Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), and '.' (period).
This operation is idempotent.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and underlying REST API, go to Creating a Vault in Amazon Glacier and Create Vault in the Amazon Glacier Developer Guide.
", + "DeleteArchive": "This operation deletes an archive from a vault. Subsequent requests to initiate a retrieval of this archive will fail. Archive retrievals that are in progress for this archive ID may or may not succeed according to the following scenarios:
This operation is idempotent. Attempting to delete an already-deleted archive does not result in an error.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and underlying REST API, go to Deleting an Archive in Amazon Glacier and Delete Archive in the Amazon Glacier Developer Guide.
", + "DeleteVault": "This operation deletes a vault. Amazon Glacier will delete a vault only if there are no archives in the vault as of the last inventory and there have been no writes to the vault since the last inventory. If either of these conditions is not satisfied, the vault deletion fails (that is, the vault is not removed) and Amazon Glacier returns an error. You can use DescribeVault to return the number of archives in a vault, and you can use Initiate a Job (POST jobs) to initiate a new inventory retrieval for a vault. The inventory contains the archive IDs you use to delete archives using Delete Archive (DELETE archive).
This operation is idempotent.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and underlying REST API, go to Deleting a Vault in Amazon Glacier and Delete Vault in the Amazon Glacier Developer Guide.
", + "DeleteVaultAccessPolicy": "This operation deletes the access policy associated with the specified vault. The operation is eventually consistent; that is, it might take some time for Amazon Glacier to completely remove the access policy, and you might still see the effect of the policy for a short time after you send the delete request.
This operation is idempotent. You can invoke delete multiple times, even if there is no policy associated with the vault. For more information about vault access policies, see Amazon Glacier Access Control with Vault Access Policies.
", + "DeleteVaultNotifications": "This operation deletes the notification configuration set for a vault. The operation is eventually consistent; that is, it might take some time for Amazon Glacier to completely disable the notifications and you might still receive some notifications for a short time after you send the delete request.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and underlying REST API, go to Configuring Vault Notifications in Amazon Glacier and Delete Vault Notification Configuration in the Amazon Glacier Developer Guide.
", + "DescribeJob": "This operation returns information about a job you previously initiated, including the job initiation date, the user who initiated the job, the job status code/message and the Amazon SNS topic to notify after Amazon Glacier completes the job. For more information about initiating a job, see InitiateJob.
This operation enables you to check the status of your job. However, it is strongly recommended that you set up an Amazon SNS topic and specify it in your initiate job request so that Amazon Glacier can notify the topic after it completes the job.
A job ID will not expire for at least 24 hours after Amazon Glacier completes the job.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For information about the underlying REST API, go to Working with Archives in Amazon Glacier in the Amazon Glacier Developer Guide.
", + "DescribeVault": "This operation returns information about a vault, including the vault's Amazon Resource Name (ARN), the date the vault was created, the number of archives it contains, and the total size of all the archives in the vault. The number of archives and their total size are as of the last inventory generation. This means that if you add or remove an archive from a vault, and then immediately use Describe Vault, the change in contents will not be immediately reflected. If you want to retrieve the latest inventory of the vault, use InitiateJob. Amazon Glacier generates vault inventories approximately daily. For more information, see Downloading a Vault Inventory in Amazon Glacier.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and underlying REST API, go to Retrieving Vault Metadata in Amazon Glacier and Describe Vault in the Amazon Glacier Developer Guide.
", + "GetDataRetrievalPolicy": "This operation returns the current data retrieval policy for the account and region specified in the GET request. For more information about data retrieval policies, see Amazon Glacier Data Retrieval Policies.
", + "GetJobOutput": "This operation downloads the output of the job you initiated using InitiateJob. Depending on the job type you specified when you initiated the job, the output will be either the content of an archive or a vault inventory.
A job ID will not expire for at least 24 hours after Amazon Glacier completes the job. That is, you can download the job output within the 24 hours period after Amazon Glacier completes the job.
If the job output is large, then you can use the Range request header to retrieve a portion of the output. This allows you to download the entire output in smaller chunks of bytes. For example, suppose you have 1 GB of job output you want to download and you decide to download 128 MB chunks of data at a time, which is a total of eight Get Job Output requests. You use the following process to download the job output:
Download a 128 MB chunk of output by specifying the appropriate byte range using the Range header.
Along with the data, the response includes a SHA256 tree hash of the payload. You compute the checksum of the payload on the client and compare it with the checksum you received in the response to ensure you received all the expected data.
Repeat steps 1 and 2 for all the eight 128 MB chunks of output data, each time specifying the appropriate byte range.
After downloading all the parts of the job output, you have a list of eight checksum values. Compute the tree hash of these values to find the checksum of the entire output. Using the DescribeJob API, obtain job information of the job that provided you the output. The response includes the checksum of the entire archive stored in Amazon Glacier. You compare this value with the checksum you computed to ensure you have downloaded the entire archive content with no errors.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and the underlying REST API, go to Downloading a Vault Inventory, Downloading an Archive, and Get Job Output
", + "GetVaultAccessPolicy": "This operation retrieves the access-policy subresource set on the vault; for more information on setting this subresource, see Set Vault Access Policy (PUT access-policy). If there is no access policy set on the vault, the operation returns a 404 Not found error. For more information about vault access policies, see Amazon Glacier Access Control with Vault Access Policies.
This operation retrieves the following attributes from the lock-policy subresource set on the specified vault:
The vault lock policy set on the vault.
The state of the vault lock, which is either InProgess or Locked.
When the lock ID expires. The lock ID is used to complete the vault locking process.
When the vault lock was initiated and put into the InProgress state.
A vault lock is put into the InProgress state by calling InitiateVaultLock. A vault lock is put into the Locked state by calling CompleteVaultLock. You can abort the vault locking process by calling AbortVaultLock. For more information about the vault locking process, Amazon Glacier Vault Lock.
If there is no vault lock policy set on the vault, the operation returns a 404 Not found error. For more information about vault lock policies, Amazon Glacier Access Control with Vault Lock Policies.
This operation retrieves the notification-configuration subresource of the specified vault.
For information about setting a notification configuration on a vault, see SetVaultNotifications. If a notification configuration for a vault is not set, the operation returns a 404 Not Found error. For more information about vault notifications, see Configuring Vault Notifications in Amazon Glacier.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and underlying REST API, go to Configuring Vault Notifications in Amazon Glacier and Get Vault Notification Configuration in the Amazon Glacier Developer Guide.
", + "InitiateJob": "This operation initiates a job of the specified type. In this release, you can initiate a job to retrieve either an archive or a vault inventory (a list of archives in a vault).
Retrieving data from Amazon Glacier is a two-step process:
Initiate a retrieval job.
A data retrieval policy can cause your initiate retrieval job request to fail with a PolicyEnforcedException exception. For more information about data retrieval policies, see Amazon Glacier Data Retrieval Policies. For more information about the PolicyEnforcedException exception, see Error Responses.
After the job completes, download the bytes.
The retrieval request is executed asynchronously. When you initiate a retrieval job, Amazon Glacier creates a job and returns a job ID in the response. When Amazon Glacier completes the job, you can get the job output (archive or inventory data). For information about getting job output, see GetJobOutput operation.
The job must complete before you can get its output. To determine when a job is complete, you have the following options:
Use Amazon SNS Notification You can specify an Amazon Simple Notification Service (Amazon SNS) topic to which Amazon Glacier can post a notification after the job is completed. You can specify an SNS topic per job request. The notification is sent only after Amazon Glacier completes the job. In addition to specifying an SNS topic per job request, you can configure vault notifications for a vault so that job notifications are always sent. For more information, see SetVaultNotifications.
Get job details You can make a DescribeJob request to obtain job status information while a job is in progress. However, it is more efficient to use an Amazon SNS notification to determine when a job is complete.
The information you get via notification is same that you get by calling DescribeJob.
If for a specific event, you add both the notification configuration on the vault and also specify an SNS topic in your initiate job request, Amazon Glacier sends both notifications. For more information, see SetVaultNotifications.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
About the Vault Inventory
Amazon Glacier prepares an inventory for each vault periodically, every 24 hours. When you initiate a job for a vault inventory, Amazon Glacier returns the last inventory for the vault. The inventory data you get might be up to a day or two days old. Also, the initiate inventory job might take some time to complete before you can download the vault inventory. So you do not want to retrieve a vault inventory for each vault operation. However, in some scenarios, you might find the vault inventory useful. For example, when you upload an archive, you can provide an archive description but not an archive name. Amazon Glacier provides you a unique archive ID, an opaque string of characters. So, you might maintain your own database that maps archive names to their corresponding Amazon Glacier assigned archive IDs. You might find the vault inventory useful in the event you need to reconcile information in your database with the actual vault inventory.
Range Inventory Retrieval
You can limit the number of inventory items retrieved by filtering on the archive creation date or by setting a limit.
Filtering by Archive Creation Date
You can retrieve inventory items for archives created between StartDate and EndDate by specifying values for these parameters in the InitiateJob request. Archives created on or after the StartDate and before the EndDate will be returned. If you only provide the StartDate without the EndDate, you will retrieve the inventory for all archives created on or after the StartDate. If you only provide the EndDate without the StartDate, you will get back the inventory for all archives created before the EndDate.
Limiting Inventory Items per Retrieval
You can limit the number of inventory items returned by setting the Limit parameter in the InitiateJob request. The inventory job output will contain inventory items up to the specified Limit. If there are more inventory items available, the result is paginated. After a job is complete you can use the DescribeJob operation to get a marker that you use in a subsequent InitiateJob request. The marker will indicate the starting point to retrieve the next set of inventory items. You can page through your entire inventory by repeatedly making InitiateJob requests with the marker from the previous DescribeJob output, until you get a marker from DescribeJob that returns null, indicating that there are no more inventory items available.
You can use the Limit parameter together with the date range parameters.
About Ranged Archive Retrieval
You can initiate an archive retrieval for the whole archive or a range of the archive. In the case of ranged archive retrieval, you specify a byte range to return or the whole archive. The range specified must be megabyte (MB) aligned, that is the range start value must be divisible by 1 MB and range end value plus 1 must be divisible by 1 MB or equal the end of the archive. If the ranged archive retrieval is not megabyte aligned, this operation returns a 400 response. Furthermore, to ensure you get checksum values for data you download using Get Job Output API, the range must be tree hash aligned.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and the underlying REST API, go to Initiate a Job and Downloading a Vault Inventory
", + "InitiateMultipartUpload": "This operation initiates a multipart upload. Amazon Glacier creates a multipart upload resource and returns its ID in the response. The multipart upload ID is used in subsequent requests to upload parts of an archive (see UploadMultipartPart).
When you initiate a multipart upload, you specify the part size in number of bytes. The part size must be a megabyte (1024 KB) multiplied by a power of 2-for example, 1048576 (1 MB), 2097152 (2 MB), 4194304 (4 MB), 8388608 (8 MB), and so on. The minimum allowable part size is 1 MB, and the maximum is 4 GB.
Every part you upload to this resource (see UploadMultipartPart), except the last one, must have the same size. The last one can be the same size or smaller. For example, suppose you want to upload a 16.2 MB file. If you initiate the multipart upload with a part size of 4 MB, you will upload four parts of 4 MB each and one part of 0.2 MB.
You don't need to know the size of the archive when you start a multipart upload because Amazon Glacier does not require you to specify the overall archive size.
After you complete the multipart upload, Amazon Glacier removes the multipart upload resource referenced by the ID. Amazon Glacier also removes the multipart upload resource if you cancel the multipart upload or it may be removed if there is no activity for a period of 24 hours.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and underlying REST API, go to Uploading Large Archives in Parts (Multipart Upload) and Initiate Multipart Upload in the Amazon Glacier Developer Guide.
", + "InitiateVaultLock": "This operation initiates the vault locking process by doing the following:
Installing a vault lock policy on the specified vault.
Setting the lock state of vault lock to InProgress.
Returning a lock ID, which is used to complete the vault locking process.
You can set one vault lock policy for each vault and this policy can be up to 20 KB in size. For more information about vault lock policies, see Amazon Glacier Access Control with Vault Lock Policies.
You must complete the vault locking process within 24 hours after the vault lock enters the InProgress state. After the 24 hour window ends, the lock ID expires, the vault automatically exits the InProgress state, and the vault lock policy is removed from the vault. You call CompleteVaultLock to complete the vault locking process by setting the state of the vault lock to Locked.
After a vault lock is in the Locked state, you cannot initiate a new vault lock for the vault.
You can abort the vault locking process by calling AbortVaultLock. You can get the state of the vault lock by calling GetVaultLock. For more information about the vault locking process, Amazon Glacier Vault Lock.
If this operation is called when the vault lock is in the InProgress state, the operation returns an AccessDeniedException error. When the vault lock is in the InProgress state you must call AbortVaultLock before you can initiate a new vault lock policy.
This operation lists jobs for a vault, including jobs that are in-progress and jobs that have recently finished.
Amazon Glacier retains recently completed jobs for a period before deleting them; however, it eventually removes completed jobs. The output of completed jobs can be retrieved. Retaining completed jobs for a period of time after they have completed enables you to get a job output in the event you miss the job completion notification or your first attempt to download it fails. For example, suppose you start an archive retrieval job to download an archive. After the job completes, you start to download the archive but encounter a network error. In this scenario, you can retry and download the archive while the job exists.
To retrieve an archive or retrieve a vault inventory from Amazon Glacier, you first initiate a job, and after the job completes, you download the data. For an archive retrieval, the output is the archive data, and for an inventory retrieval, it is the inventory list. The List Job operation returns a list of these jobs sorted by job initiation time.
This List Jobs operation supports pagination. By default, this operation returns up to 1,000 jobs in the response. You should always check the response for a marker at which to continue the list; if there are no more items the marker is null. To return a list of jobs that begins at a specific job, set the marker request parameter to the value you obtained from a previous List Jobs request. You can also limit the number of jobs returned in the response by specifying the limit parameter in the request.
Additionally, you can filter the jobs list returned by specifying an optional statuscode (InProgress, Succeeded, or Failed) and completed (true, false) parameter. The statuscode allows you to specify that only jobs that match a specified status are returned. The completed parameter allows you to specify that only jobs in a specific completion state are returned.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For the underlying REST API, go to List Jobs
", + "ListMultipartUploads": "This operation lists in-progress multipart uploads for the specified vault. An in-progress multipart upload is a multipart upload that has been initiated by an InitiateMultipartUpload request, but has not yet been completed or aborted. The list returned in the List Multipart Upload response has no guaranteed order.
The List Multipart Uploads operation supports pagination. By default, this operation returns up to 1,000 multipart uploads in the response. You should always check the response for a marker at which to continue the list; if there are no more items the marker is null. To return a list of multipart uploads that begins at a specific upload, set the marker request parameter to the value you obtained from a previous List Multipart Upload request. You can also limit the number of uploads returned in the response by specifying the limit parameter in the request.
Note the difference between this operation and listing parts (ListParts). The List Multipart Uploads operation lists all multipart uploads for a vault and does not require a multipart upload ID. The List Parts operation requires a multipart upload ID since parts are associated with a single upload.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and the underlying REST API, go to Working with Archives in Amazon Glacier and List Multipart Uploads in the Amazon Glacier Developer Guide.
", + "ListParts": "This operation lists the parts of an archive that have been uploaded in a specific multipart upload. You can make this request at any time during an in-progress multipart upload before you complete the upload (see CompleteMultipartUpload. List Parts returns an error for completed uploads. The list returned in the List Parts response is sorted by part range.
The List Parts operation supports pagination. By default, this operation returns up to 1,000 uploaded parts in the response. You should always check the response for a marker at which to continue the list; if there are no more items the marker is null. To return a list of parts that begins at a specific part, set the marker request parameter to the value you obtained from a previous List Parts request. You can also limit the number of parts returned in the response by specifying the limit parameter in the request.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and the underlying REST API, go to Working with Archives in Amazon Glacier and List Parts in the Amazon Glacier Developer Guide.
", + "ListTagsForVault": "This operation lists all the tags attached to a vault. The operation returns an empty map if there are no tags. For more information about tags, see Tagging Amazon Glacier Resources.
", + "ListVaults": "This operation lists all vaults owned by the calling user's account. The list returned in the response is ASCII-sorted by vault name.
By default, this operation returns up to 1,000 items. If there are more vaults to list, the response marker field contains the vault Amazon Resource Name (ARN) at which to continue the list with a new List Vaults request; otherwise, the marker field is null. To return a list of vaults that begins at a specific vault, set the marker request parameter to the vault ARN you obtained from a previous List Vaults request. You can also limit the number of vaults returned in the response by specifying the limit parameter in the request.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and underlying REST API, go to Retrieving Vault Metadata in Amazon Glacier and List Vaults in the Amazon Glacier Developer Guide.
", + "RemoveTagsFromVault": "This operation removes one or more tags from the set of tags attached to a vault. For more information about tags, see Tagging Amazon Glacier Resources. This operation is idempotent. The operation will be successful, even if there are no tags attached to the vault.
", + "SetDataRetrievalPolicy": "This operation sets and then enacts a data retrieval policy in the region specified in the PUT request. You can set one policy per region for an AWS account. The policy is enacted within a few minutes of a successful PUT operation.
The set policy operation does not affect retrieval jobs that were in progress before the policy was enacted. For more information about data retrieval policies, see Amazon Glacier Data Retrieval Policies.
", + "SetVaultAccessPolicy": "This operation configures an access policy for a vault and will overwrite an existing policy. To configure a vault access policy, send a PUT request to the access-policy subresource of the vault. An access policy is specific to a vault and is also called a vault subresource. You can set one access policy per vault and the policy can be up to 20 KB in size. For more information about vault access policies, see Amazon Glacier Access Control with Vault Access Policies.
This operation configures notifications that will be sent when specific events happen to a vault. By default, you don't get any notifications.
To configure vault notifications, send a PUT request to the notification-configuration subresource of the vault. The request should include a JSON document that provides an Amazon SNS topic and specific events for which you want Amazon Glacier to send notifications to the topic.
Amazon SNS topics must grant permission to the vault to be allowed to publish notifications to the topic. You can configure a vault to publish a notification for the following vault events:
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and underlying REST API, go to Configuring Vault Notifications in Amazon Glacier and Set Vault Notification Configuration in the Amazon Glacier Developer Guide.
", + "UploadArchive": "This operation adds an archive to a vault. This is a synchronous operation, and for a successful upload, your data is durably persisted. Amazon Glacier returns the archive ID in the x-amz-archive-id header of the response.
You must use the archive ID to access your data in Amazon Glacier. After you upload an archive, you should save the archive ID returned so that you can retrieve or delete the archive later. Besides saving the archive ID, you can also index it and give it a friendly name to allow for better searching. You can also use the optional archive description field to specify how the archive is referred to in an external index of archives, such as you might create in Amazon DynamoDB. You can also get the vault inventory to obtain a list of archive IDs in a vault. For more information, see InitiateJob.
You must provide a SHA256 tree hash of the data you are uploading. For information about computing a SHA256 tree hash, see Computing Checksums.
You can optionally specify an archive description of up to 1,024 printable ASCII characters. You can get the archive description when you either retrieve the archive or get the vault inventory. For more information, see InitiateJob. Amazon Glacier does not interpret the description in any way. An archive description does not need to be unique. You cannot use the description to retrieve or sort the archive list.
Archives are immutable. After you upload an archive, you cannot edit the archive or its description.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and underlying REST API, go to Uploading an Archive in Amazon Glacier and Upload Archive in the Amazon Glacier Developer Guide.
", + "UploadMultipartPart": "This operation uploads a part of an archive. You can upload archive parts in any order. You can also upload them in parallel. You can upload up to 10,000 parts for a multipart upload.
Amazon Glacier rejects your upload part request if any of the following conditions is true:
SHA256 tree hash does not matchTo ensure that part data is not corrupted in transmission, you compute a SHA256 tree hash of the part and include it in your request. Upon receiving the part data, Amazon Glacier also computes a SHA256 tree hash. If these hash values don't match, the operation fails. For information about computing a SHA256 tree hash, see Computing Checksums.
Part size does not matchThe size of each part except the last must match the size specified in the corresponding InitiateMultipartUpload request. The size of the last part must be the same size as, or smaller than, the specified size.
If you upload a part whose size is smaller than the part size you specified in your initiate multipart upload request and that part is not the last part, then the upload part request will succeed. However, the subsequent Complete Multipart Upload request will fail.
This operation is idempotent. If you upload the same part multiple times, the data included in the most recent request overwrites the previously uploaded data.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and underlying REST API, go to Uploading Large Archives in Parts (Multipart Upload) and Upload Part in the Amazon Glacier Developer Guide.
" + }, + "service": "Amazon Glacier is a storage solution for \"cold data.\"
Amazon Glacier is an extremely low-cost storage service that provides secure, durable, and easy-to-use storage for data backup and archival. With Amazon Glacier, customers can store their data cost effectively for months, years, or decades. Amazon Glacier also enables customers to offload the administrative burdens of operating and scaling storage to AWS, so they don't have to worry about capacity planning, hardware provisioning, data replication, hardware failure and recovery, or time-consuming hardware migrations.
Amazon Glacier is a great storage choice when low storage cost is paramount, your data is rarely retrieved, and retrieval latency of several hours is acceptable. If your application requires fast or frequent access to your data, consider using Amazon S3. For more information, go to Amazon Simple Storage Service (Amazon S3).
You can store any kind of data in any format. There is no maximum limit on the total amount of data you can store in Amazon Glacier.
If you are a first-time user of Amazon Glacier, we recommend that you begin by reading the following sections in the Amazon Glacier Developer Guide:
What is Amazon Glacier - This section of the Developer Guide describes the underlying data model, the operations it supports, and the AWS SDKs that you can use to interact with the service.
Getting Started with Amazon Glacier - The Getting Started section walks you through the process of creating a vault, uploading archives, creating jobs to download archives, retrieving the job output, and deleting archives.
Provides options to abort a multipart upload identified by the upload ID.
For information about the underlying REST API, go to Abort Multipart Upload. For conceptual information, go to Working with Archives in Amazon Glacier.
", + "refs": { + } + }, + "AbortVaultLockInput": { + "base": "The input values for AbortVaultLock.
The job type. It is either ArchiveRetrieval or InventoryRetrieval.
" + } + }, + "AddTagsToVaultInput": { + "base": "The input values for AddTagsToVault.
Contains the Amazon Glacier response to your request.
For information about the underlying REST API, go to Upload Archive. For conceptual information, go to Working with Archives in Amazon Glacier.
", + "refs": { + } + }, + "CompleteMultipartUploadInput": { + "base": "Provides options to complete a multipart upload operation. This informs Amazon Glacier that all the archive parts have been uploaded and Amazon Glacier can now assemble the archive from the uploaded parts. After assembling and saving the archive to the vault, Amazon Glacier returns the URI path of the newly created archive resource.
", + "refs": { + } + }, + "CompleteVaultLockInput": { + "base": "The input values for CompleteVaultLock.
Provides options to create a vault.
", + "refs": { + } + }, + "CreateVaultOutput": { + "base": "Contains the Amazon Glacier response to your request.
", + "refs": { + } + }, + "DataRetrievalPolicy": { + "base": "Data retrieval policy.
", + "refs": { + "GetDataRetrievalPolicyOutput$Policy": "Contains the returned data retrieval policy in JSON format.
", + "SetDataRetrievalPolicyInput$Policy": "The data retrieval policy in JSON format.
" + } + }, + "DataRetrievalRule": { + "base": "Data retrieval policy rule.
", + "refs": { + "DataRetrievalRulesList$member": null + } + }, + "DataRetrievalRulesList": { + "base": null, + "refs": { + "DataRetrievalPolicy$Rules": "The policy rule. Although this is a list type, currently there must be only one rule, which contains a Strategy field and optionally a BytesPerHour field.
" + } + }, + "DateTime": { + "base": null, + "refs": { + "InventoryRetrievalJobDescription$StartDate": "The start of the date range in UTC for vault inventory retrieval that includes archives created on or after this date. A string representation of ISO 8601 date format, for example, 2013-03-20T17:03:43Z.
", + "InventoryRetrievalJobDescription$EndDate": "The end of the date range in UTC for vault inventory retrieval that includes archives created before this date. A string representation of ISO 8601 date format, for example, 2013-03-20T17:03:43Z.
" + } + }, + "DeleteArchiveInput": { + "base": "Provides options for deleting an archive from an Amazon Glacier vault.
", + "refs": { + } + }, + "DeleteVaultAccessPolicyInput": { + "base": "DeleteVaultAccessPolicy input.
", + "refs": { + } + }, + "DeleteVaultInput": { + "base": "Provides options for deleting a vault from Amazon Glacier.
", + "refs": { + } + }, + "DeleteVaultNotificationsInput": { + "base": "Provides options for deleting a vault notification configuration from an Amazon Glacier vault.
", + "refs": { + } + }, + "DescribeJobInput": { + "base": "Provides options for retrieving a job description.
", + "refs": { + } + }, + "DescribeVaultInput": { + "base": "Provides options for retrieving metadata for a specific vault in Amazon Glacier.
", + "refs": { + } + }, + "DescribeVaultOutput": { + "base": "Contains the Amazon Glacier response to your request.
", + "refs": { + "VaultList$member": null + } + }, + "GetDataRetrievalPolicyInput": { + "base": "Input for GetDataRetrievalPolicy.
", + "refs": { + } + }, + "GetDataRetrievalPolicyOutput": { + "base": "Contains the Amazon Glacier response to the GetDataRetrievalPolicy request.
Provides options for downloading output of an Amazon Glacier job.
", + "refs": { + } + }, + "GetJobOutputOutput": { + "base": "Contains the Amazon Glacier response to your request.
", + "refs": { + } + }, + "GetVaultAccessPolicyInput": { + "base": "Input for GetVaultAccessPolicy.
", + "refs": { + } + }, + "GetVaultAccessPolicyOutput": { + "base": "Output for GetVaultAccessPolicy.
", + "refs": { + } + }, + "GetVaultLockInput": { + "base": "The input values for GetVaultLock.
Contains the Amazon Glacier response to your request.
", + "refs": { + } + }, + "GetVaultNotificationsInput": { + "base": "Provides options for retrieving the notification configuration set on an Amazon Glacier vault.
", + "refs": { + } + }, + "GetVaultNotificationsOutput": { + "base": "Contains the Amazon Glacier response to your request.
", + "refs": { + } + }, + "GlacierJobDescription": { + "base": "Describes an Amazon Glacier job.
", + "refs": { + "JobList$member": null + } + }, + "InitiateJobInput": { + "base": "Provides options for initiating an Amazon Glacier job.
", + "refs": { + } + }, + "InitiateJobOutput": { + "base": "Contains the Amazon Glacier response to your request.
", + "refs": { + } + }, + "InitiateMultipartUploadInput": { + "base": "Provides options for initiating a multipart upload to an Amazon Glacier vault.
", + "refs": { + } + }, + "InitiateMultipartUploadOutput": { + "base": "The Amazon Glacier response to your request.
", + "refs": { + } + }, + "InitiateVaultLockInput": { + "base": "The input values for InitiateVaultLock.
Contains the Amazon Glacier response to your request.
", + "refs": { + } + }, + "InvalidParameterValueException": { + "base": "Returned if a parameter of the request is incorrectly specified.
", + "refs": { + } + }, + "InventoryRetrievalJobDescription": { + "base": "Describes the options for a range inventory retrieval job.
", + "refs": { + "GlacierJobDescription$InventoryRetrievalParameters": "Parameters used for range inventory retrieval.
" + } + }, + "InventoryRetrievalJobInput": { + "base": "Provides options for specifying a range inventory retrieval job.
", + "refs": { + "JobParameters$InventoryRetrievalParameters": "Input parameters used for range inventory retrieval.
" + } + }, + "JobList": { + "base": null, + "refs": { + "ListJobsOutput$JobList": "A list of job objects. Each job object contains metadata describing the job.
" + } + }, + "JobParameters": { + "base": "Provides options for defining a job.
", + "refs": { + "InitiateJobInput$jobParameters": "Provides options for specifying job information.
" + } + }, + "LimitExceededException": { + "base": "Returned if the request results in a vault or account limit being exceeded.
", + "refs": { + } + }, + "ListJobsInput": { + "base": "Provides options for retrieving a job list for an Amazon Glacier vault.
", + "refs": { + } + }, + "ListJobsOutput": { + "base": "Contains the Amazon Glacier response to your request.
", + "refs": { + } + }, + "ListMultipartUploadsInput": { + "base": "Provides options for retrieving list of in-progress multipart uploads for an Amazon Glacier vault.
", + "refs": { + } + }, + "ListMultipartUploadsOutput": { + "base": "Contains the Amazon Glacier response to your request.
", + "refs": { + } + }, + "ListPartsInput": { + "base": "Provides options for retrieving a list of parts of an archive that have been uploaded in a specific multipart upload.
", + "refs": { + } + }, + "ListPartsOutput": { + "base": "Contains the Amazon Glacier response to your request.
", + "refs": { + } + }, + "ListTagsForVaultInput": { + "base": "The input value for ListTagsForVaultInput.
Contains the Amazon Glacier response to your request.
", + "refs": { + } + }, + "ListVaultsInput": { + "base": "Provides options to retrieve the vault list owned by the calling user's account. The list provides metadata information for each vault.
", + "refs": { + } + }, + "ListVaultsOutput": { + "base": "Contains the Amazon Glacier response to your request.
", + "refs": { + } + }, + "MissingParameterValueException": { + "base": "Returned if a required header or parameter is missing from the request.
", + "refs": { + } + }, + "NotificationEventList": { + "base": null, + "refs": { + "VaultNotificationConfig$Events": "A list of one or more events for which Amazon Glacier will send a notification to the specified Amazon SNS topic.
" + } + }, + "NullableLong": { + "base": null, + "refs": { + "DataRetrievalRule$BytesPerHour": "The maximum number of bytes that can be retrieved in an hour.
This field is required only if the value of the Strategy field is BytesPerHour. Your PUT operation will be rejected if the Strategy field is not set to BytesPerHour and you set this field.
A list of the part sizes of the multipart upload.
" + } + }, + "PartListElement": { + "base": "A list of the part sizes of the multipart upload.
", + "refs": { + "PartList$member": null + } + }, + "PolicyEnforcedException": { + "base": "Returned if a retrieval job would exceed the current data policy's retrieval rate limit. For more information about data retrieval policies,
", + "refs": { + } + }, + "RemoveTagsFromVaultInput": { + "base": "The input value for RemoveTagsFromVaultInput.
Returned if, when uploading an archive, Amazon Glacier times out while receiving the upload.
", + "refs": { + } + }, + "ResourceNotFoundException": { + "base": "Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.
", + "refs": { + } + }, + "ServiceUnavailableException": { + "base": "Returned if the service cannot complete the request.
", + "refs": { + } + }, + "SetDataRetrievalPolicyInput": { + "base": "SetDataRetrievalPolicy input.
", + "refs": { + } + }, + "SetVaultAccessPolicyInput": { + "base": "SetVaultAccessPolicy input.
", + "refs": { + } + }, + "SetVaultNotificationsInput": { + "base": "Provides options to configure notifications that will be sent when specific events happen to a vault.
", + "refs": { + } + }, + "Size": { + "base": null, + "refs": { + "GlacierJobDescription$ArchiveSizeInBytes": "For an ArchiveRetrieval job, this is the size in bytes of the archive being requested for download. For the InventoryRetrieval job, the value is null.
", + "GlacierJobDescription$InventorySizeInBytes": "For an InventoryRetrieval job, this is the size in bytes of the inventory requested for download. For the ArchiveRetrieval job, the value is null.
" + } + }, + "StatusCode": { + "base": null, + "refs": { + "GlacierJobDescription$StatusCode": "The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.
" + } + }, + "Stream": { + "base": null, + "refs": { + "GetJobOutputOutput$body": "The job data, either archive data or inventory data.
", + "UploadArchiveInput$body": "The data to upload.
", + "UploadMultipartPartInput$body": "The data to upload.
" + } + }, + "TagKey": { + "base": null, + "refs": { + "TagMap$key": null + } + }, + "TagKeyList": { + "base": null, + "refs": { + "RemoveTagsFromVaultInput$TagKeys": "A list of tag keys. Each corresponding tag is removed from the vault.
" + } + }, + "TagMap": { + "base": null, + "refs": { + "AddTagsToVaultInput$Tags": "The tags to add to the vault. Each tag is composed of a key and a value. The value can be an empty string.
", + "ListTagsForVaultOutput$Tags": "The tags attached to the vault. Each tag is composed of a key and a value.
" + } + }, + "TagValue": { + "base": null, + "refs": { + "TagMap$value": null + } + }, + "UploadArchiveInput": { + "base": "Provides options to add an archive to a vault.
", + "refs": { + } + }, + "UploadListElement": { + "base": "A list of in-progress multipart uploads for a vault.
", + "refs": { + "UploadsList$member": null + } + }, + "UploadMultipartPartInput": { + "base": "Provides options to upload a part of an archive in a multipart upload operation.
", + "refs": { + } + }, + "UploadMultipartPartOutput": { + "base": "Contains the Amazon Glacier response to your request.
", + "refs": { + } + }, + "UploadsList": { + "base": null, + "refs": { + "ListMultipartUploadsOutput$UploadsList": "A list of in-progress multipart uploads.
" + } + }, + "VaultAccessPolicy": { + "base": "Contains the vault access policy.
", + "refs": { + "GetVaultAccessPolicyOutput$policy": "Contains the returned vault access policy as a JSON string.
", + "SetVaultAccessPolicyInput$policy": "The vault access policy as a JSON string.
" + } + }, + "VaultList": { + "base": null, + "refs": { + "ListVaultsOutput$VaultList": "List of vaults.
" + } + }, + "VaultLockPolicy": { + "base": "Contains the vault lock policy.
", + "refs": { + "InitiateVaultLockInput$policy": "The vault lock policy as a JSON string, which uses \"\\\" as an escape character.
" + } + }, + "VaultNotificationConfig": { + "base": "Represents a vault's notification configuration.
", + "refs": { + "GetVaultNotificationsOutput$vaultNotificationConfig": "Returns the notification configuration set on the vault.
", + "SetVaultNotificationsInput$vaultNotificationConfig": "Provides options for specifying notification configuration.
" + } + }, + "boolean": { + "base": null, + "refs": { + "GlacierJobDescription$Completed": "The job status. When a job is completed, you get the job's output.
" + } + }, + "httpstatus": { + "base": null, + "refs": { + "GetJobOutputOutput$status": "The HTTP response code for a job output request. The value depends on whether a range was specified in the request.
" + } + }, + "long": { + "base": null, + "refs": { + "DescribeVaultOutput$NumberOfArchives": "The number of archives in the vault as of the last inventory date. This field will return null if an inventory has not yet run on the vault, for example, if you just created the vault.
Total size, in bytes, of the archives in the vault as of the last inventory date. This field will return null if an inventory has not yet run on the vault, for example, if you just created the vault.
", + "ListPartsOutput$PartSizeInBytes": "The part size in bytes.
", + "UploadListElement$PartSizeInBytes": "The part size, in bytes, specified in the Initiate Multipart Upload request. This is the size of all the parts in the upload except the last part, which may be smaller than this size.
" + } + }, + "string": { + "base": null, + "refs": { + "AbortMultipartUploadInput$accountId": "The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single apos-apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens (apos-apos) in the ID.
The name of the vault.
", + "AbortMultipartUploadInput$uploadId": "The upload ID of the multipart upload to delete.
", + "AbortVaultLockInput$accountId": "The AccountId value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single apos-apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your account ID, do not include any hyphens (apos-apos) in the ID.
The name of the vault.
", + "AddTagsToVaultInput$accountId": "The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single apos-apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens (apos-apos) in the ID.
The name of the vault.
", + "ArchiveCreationOutput$location": "The relative URI path of the newly added archive resource.
", + "ArchiveCreationOutput$checksum": "The checksum of the archive computed by Amazon Glacier.
", + "ArchiveCreationOutput$archiveId": "The ID of the archive. This value is also included as part of the location.
", + "CompleteMultipartUploadInput$accountId": "The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single apos-apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens (apos-apos) in the ID.
The name of the vault.
", + "CompleteMultipartUploadInput$uploadId": "The upload ID of the multipart upload.
", + "CompleteMultipartUploadInput$archiveSize": "The total size, in bytes, of the entire archive. This value should be the sum of all the sizes of the individual parts that you uploaded.
", + "CompleteMultipartUploadInput$checksum": "The SHA256 tree hash of the entire archive. It is the tree hash of SHA256 tree hash of the individual parts. If the value you specify in the request does not match the SHA256 tree hash of the final assembled archive as computed by Amazon Glacier, Amazon Glacier returns an error and the request fails.
", + "CompleteVaultLockInput$accountId": "The AccountId value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single apos-apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your account ID, do not include any hyphens (apos-apos) in the ID.
The name of the vault.
", + "CompleteVaultLockInput$lockId": "The lockId value is the lock ID obtained from a InitiateVaultLock request.
The AccountId value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single apos-apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your account ID, do not include any hyphens (apos-apos) in the ID.
The name of the vault.
", + "CreateVaultOutput$location": "The URI of the vault that was created.
", + "DataRetrievalRule$Strategy": "The type of data retrieval policy to set.
Valid values: BytesPerHour|FreeTier|None
", + "DeleteArchiveInput$accountId": "The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single apos-apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens (apos-apos) in the ID.
The name of the vault.
", + "DeleteArchiveInput$archiveId": "The ID of the archive to delete.
", + "DeleteVaultAccessPolicyInput$accountId": "The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single apos-apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens (apos-apos) in the ID.
The name of the vault.
", + "DeleteVaultInput$accountId": "The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single apos-apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens (apos-apos) in the ID.
The name of the vault.
", + "DeleteVaultNotificationsInput$accountId": "The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single apos-apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens (apos-apos) in the ID.
The name of the vault.
", + "DescribeJobInput$accountId": "The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single apos-apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens (apos-apos) in the ID.
The name of the vault.
", + "DescribeJobInput$jobId": "The ID of the job to describe.
", + "DescribeVaultInput$accountId": "The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single apos-apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens (apos-apos) in the ID.
The name of the vault.
", + "DescribeVaultOutput$VaultARN": "The Amazon Resource Name (ARN) of the vault.
", + "DescribeVaultOutput$VaultName": "The name of the vault.
", + "DescribeVaultOutput$CreationDate": "The UTC date when the vault was created. A string representation of ISO 8601 date format, for example, \"2012-03-20T17:03:43.221Z\".
", + "DescribeVaultOutput$LastInventoryDate": "The UTC date when Amazon Glacier completed the last vault inventory. A string representation of ISO 8601 date format, for example, \"2012-03-20T17:03:43.221Z\".
", + "GetDataRetrievalPolicyInput$accountId": "The AccountId value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single apos-apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your account ID, do not include any hyphens (apos-apos) in the ID.
The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single apos-apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens (apos-apos) in the ID.
The name of the vault.
", + "GetJobOutputInput$jobId": "The job ID whose data is downloaded.
", + "GetJobOutputInput$range": "The range of bytes to retrieve from the output. For example, if you want to download the first 1,048,576 bytes, specify \"Range: bytes=0-1048575\". By default, this operation downloads the entire output.
", + "GetJobOutputOutput$checksum": "The checksum of the data in the response. This header is returned only when retrieving the output for an archive retrieval job. Furthermore, this header appears only under the following conditions:
The range of bytes returned by Amazon Glacier. If only partial output is downloaded, the response provides the range of bytes Amazon Glacier returned. For example, bytes 0-1048575/8388608 returns the first 1 MB from 8 MB.
", + "GetJobOutputOutput$acceptRanges": "Indicates the range units accepted. For more information, go to RFC2616.
", + "GetJobOutputOutput$contentType": "The Content-Type depends on whether the job output is an archive or a vault inventory. For archive data, the Content-Type is application/octet-stream. For vault inventory, if you requested CSV format when you initiated the job, the Content-Type is text/csv. Otherwise, by default, vault inventory is returned as JSON, and the Content-Type is application/json.
", + "GetJobOutputOutput$archiveDescription": "The description of an archive.
", + "GetVaultAccessPolicyInput$accountId": "The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single apos-apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens (apos-apos) in the ID.
The name of the vault.
", + "GetVaultLockInput$accountId": "The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single apos-apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens (apos-apos) in the ID.
The name of the vault.
", + "GetVaultLockOutput$Policy": "The vault lock policy as a JSON string, which uses \"\\\" as an escape character.
", + "GetVaultLockOutput$State": "The state of the vault lock. InProgress or Locked.
The UTC date and time at which the lock ID expires. This value can be null if the vault lock is in a Locked state.
The UTC date and time at which the vault lock was put into the InProgress state.
The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single apos-apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens (apos-apos) in the ID.
The name of the vault.
", + "GlacierJobDescription$JobId": "An opaque string that identifies an Amazon Glacier job.
", + "GlacierJobDescription$JobDescription": "The job description you provided when you initiated the job.
", + "GlacierJobDescription$ArchiveId": "For an ArchiveRetrieval job, this is the archive ID requested for download. Otherwise, this field is null.
", + "GlacierJobDescription$VaultARN": "The Amazon Resource Name (ARN) of the vault from which the archive retrieval was requested.
", + "GlacierJobDescription$CreationDate": "The UTC date when the job was created. A string representation of ISO 8601 date format, for example, \"2012-03-20T17:03:43.221Z\".
", + "GlacierJobDescription$StatusMessage": "A friendly message that describes the job status.
", + "GlacierJobDescription$SNSTopic": "An Amazon Simple Notification Service (Amazon SNS) topic that receives notification.
", + "GlacierJobDescription$CompletionDate": "The UTC time that the archive retrieval request completed. While the job is in progress, the value will be null.
", + "GlacierJobDescription$SHA256TreeHash": "For an ArchiveRetrieval job, it is the checksum of the archive. Otherwise, the value is null.
The SHA256 tree hash value for the requested range of an archive. If the Initiate a Job request for an archive specified a tree-hash aligned range, then this field returns a value.
For the specific case when the whole archive is retrieved, this value is the same as the ArchiveSHA256TreeHash value.
This field is null in the following situations:
Archive retrieval jobs that specify a range that is not tree-hash aligned.
Archival jobs that specify a range that is equal to the whole archive and the job status is InProgress.
Inventory jobs.
The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval jobs, this field is null.
", + "GlacierJobDescription$RetrievalByteRange": "The retrieved byte range for archive retrieval jobs in the form \"StartByteValue-EndByteValue\" If no range was specified in the archive retrieval, then the whole archive is retrieved and StartByteValue equals 0 and EndByteValue equals the size of the archive minus 1. For inventory retrieval jobs this field is null.
", + "InitiateJobInput$accountId": "The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single apos-apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens (apos-apos) in the ID.
The name of the vault.
", + "InitiateJobOutput$location": "The relative URI path of the job.
", + "InitiateJobOutput$jobId": "The ID of the job.
", + "InitiateMultipartUploadInput$accountId": "The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single apos-apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens (apos-apos) in the ID.
The name of the vault.
", + "InitiateMultipartUploadInput$archiveDescription": "The archive description that you are uploading in parts.
The part size must be a megabyte (1024 KB) multiplied by a power of 2, for example 1048576 (1 MB), 2097152 (2 MB), 4194304 (4 MB), 8388608 (8 MB), and so on. The minimum allowable part size is 1 MB, and the maximum is 4 GB (4096 MB).
", + "InitiateMultipartUploadInput$partSize": "The size of each part except the last, in bytes. The last part can be smaller than this part size.
", + "InitiateMultipartUploadOutput$location": "The relative URI path of the multipart upload ID Amazon Glacier created.
", + "InitiateMultipartUploadOutput$uploadId": "The ID of the multipart upload. This value is also included as part of the location.
", + "InitiateVaultLockInput$accountId": "The AccountId value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single apos-apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your account ID, do not include any hyphens (apos-apos) in the ID.
The name of the vault.
", + "InitiateVaultLockOutput$lockId": "The lock ID, which is used to complete the vault locking process.
", + "InvalidParameterValueException$type": "Client
", + "InvalidParameterValueException$code": "400 Bad Request
", + "InvalidParameterValueException$message": null, + "InventoryRetrievalJobDescription$Format": "The output format for the vault inventory list, which is set by the InitiateJob request when initiating a job to retrieve a vault inventory. Valid values are \"CSV\" and \"JSON\".
", + "InventoryRetrievalJobDescription$Limit": "Specifies the maximum number of inventory items returned per vault inventory retrieval request. This limit is set when initiating the job with the a InitiateJob request.
", + "InventoryRetrievalJobDescription$Marker": "An opaque string that represents where to continue pagination of the vault inventory retrieval results. You use the marker in a new InitiateJob request to obtain additional inventory items. If there are no more inventory items, this value is null. For more information, see Range Inventory Retrieval.
The start of the date range in UTC for vault inventory retrieval that includes archives created on or after this date. A string representation of ISO 8601 date format, for example, 2013-03-20T17:03:43Z.
", + "InventoryRetrievalJobInput$EndDate": "The end of the date range in UTC for vault inventory retrieval that includes archives created before this date. A string representation of ISO 8601 date format, for example, 2013-03-20T17:03:43Z.
", + "InventoryRetrievalJobInput$Limit": "Specifies the maximum number of inventory items returned per vault inventory retrieval request. Valid values are greater than or equal to 1.
", + "InventoryRetrievalJobInput$Marker": "An opaque string that represents where to continue pagination of the vault inventory retrieval results. You use the marker in a new InitiateJob request to obtain additional inventory items. If there are no more inventory items, this value is null.
When initiating a job to retrieve a vault inventory, you can optionally add this parameter to your request to specify the output format. If you are initiating an inventory job and do not specify a Format field, JSON is the default format. Valid values are \"CSV\" and \"JSON\".
", + "JobParameters$Type": "The job type. You can initiate a job to retrieve an archive or get an inventory of a vault. Valid values are \"archive-retrieval\" and \"inventory-retrieval\".
", + "JobParameters$ArchiveId": "The ID of the archive that you want to retrieve. This field is required only if Type is set to archive-retrieval. An error occurs if you specify this request parameter for an inventory retrieval job request.
The optional description for the job. The description must be less than or equal to 1,024 bytes. The allowable characters are 7-bit ASCII without control codes-specifically, ASCII values 32-126 decimal or 0x20-0x7E hexadecimal.
", + "JobParameters$SNSTopic": "The Amazon SNS topic ARN to which Amazon Glacier sends a notification when the job is completed and the output is ready for you to download. The specified topic publishes the notification to its subscribers. The SNS topic must exist.
", + "JobParameters$RetrievalByteRange": "The byte range to retrieve for an archive retrieval. in the form \"StartByteValue-EndByteValue\" If not specified, the whole archive is retrieved. If specified, the byte range must be megabyte (1024*1024) aligned which means that StartByteValue must be divisible by 1 MB and EndByteValue plus 1 must be divisible by 1 MB or be the end of the archive specified as the archive byte size value minus 1. If RetrievalByteRange is not megabyte aligned, this operation returns a 400 response.
An error occurs if you specify this field for an inventory retrieval job request.
", + "LimitExceededException$type": "Client
", + "LimitExceededException$code": "400 Bad Request
", + "LimitExceededException$message": null, + "ListJobsInput$accountId": "The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single apos-apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens (apos-apos) in the ID.
The name of the vault.
", + "ListJobsInput$limit": "Specifies that the response be limited to the specified number of items or fewer. If not specified, the List Jobs operation returns up to 1,000 jobs.
", + "ListJobsInput$marker": "An opaque string used for pagination. This value specifies the job at which the listing of jobs should begin. Get the marker value from a previous List Jobs response. You need only include the marker if you are continuing the pagination of results started in a previous List Jobs request.
", + "ListJobsInput$statuscode": "Specifies the type of job status to return. You can specify the following values: \"InProgress\", \"Succeeded\", or \"Failed\".
", + "ListJobsInput$completed": "Specifies the state of the jobs to return. You can specify true or false.
An opaque string that represents where to continue pagination of the results. You use this value in a new List Jobs request to obtain more jobs in the list. If there are no more jobs, this value is null.
The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single apos-apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens (apos-apos) in the ID.
The name of the vault.
", + "ListMultipartUploadsInput$marker": "An opaque string used for pagination. This value specifies the upload at which the listing of uploads should begin. Get the marker value from a previous List Uploads response. You need only include the marker if you are continuing the pagination of results started in a previous List Uploads request.
", + "ListMultipartUploadsInput$limit": "Specifies the maximum number of uploads returned in the response body. If this value is not specified, the List Uploads operation returns up to 1,000 uploads.
", + "ListMultipartUploadsOutput$Marker": "An opaque string that represents where to continue pagination of the results. You use the marker in a new List Multipart Uploads request to obtain more uploads in the list. If there are no more uploads, this value is null.
The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single apos-apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens (apos-apos) in the ID.
The name of the vault.
", + "ListPartsInput$uploadId": "The upload ID of the multipart upload.
", + "ListPartsInput$marker": "An opaque string used for pagination. This value specifies the part at which the listing of parts should begin. Get the marker value from the response of a previous List Parts response. You need only include the marker if you are continuing the pagination of results started in a previous List Parts request.
", + "ListPartsInput$limit": "Specifies the maximum number of parts returned in the response body. If this value is not specified, the List Parts operation returns up to 1,000 uploads.
", + "ListPartsOutput$MultipartUploadId": "The ID of the upload to which the parts are associated.
", + "ListPartsOutput$VaultARN": "The Amazon Resource Name (ARN) of the vault to which the multipart upload was initiated.
", + "ListPartsOutput$ArchiveDescription": "The description of the archive that was specified in the Initiate Multipart Upload request.
", + "ListPartsOutput$CreationDate": "The UTC time at which the multipart upload was initiated.
", + "ListPartsOutput$Marker": "An opaque string that represents where to continue pagination of the results. You use the marker in a new List Parts request to obtain more jobs in the list. If there are no more parts, this value is null.
The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single apos-apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens (apos-apos) in the ID.
The name of the vault.
", + "ListVaultsInput$accountId": "The AccountId value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single apos-apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your account ID, do not include any hyphens (apos-apos) in the ID.
A string used for pagination. The marker specifies the vault ARN after which the listing of vaults should begin.
", + "ListVaultsInput$limit": "The maximum number of items returned in the response. If you don't specify a value, the List Vaults operation returns up to 1,000 items.
", + "ListVaultsOutput$Marker": "The vault ARN at which to continue pagination of the results. You use the marker in another List Vaults request to obtain more vaults in the list.
", + "MissingParameterValueException$type": "Client.
", + "MissingParameterValueException$code": "400 Bad Request
", + "MissingParameterValueException$message": null, + "NotificationEventList$member": null, + "PartListElement$RangeInBytes": "The byte range of a part, inclusive of the upper value of the range.
", + "PartListElement$SHA256TreeHash": "The SHA256 tree hash value that Amazon Glacier calculated for the part. This field is never null.
Client
", + "PolicyEnforcedException$code": "PolicyEnforcedException
", + "PolicyEnforcedException$message": "InitiateJob request denied by current data retrieval policy.
", + "RemoveTagsFromVaultInput$accountId": "The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single apos-apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens (apos-apos) in the ID.
The name of the vault.
", + "RequestTimeoutException$type": "Client
", + "RequestTimeoutException$code": "408 Request Timeout
", + "RequestTimeoutException$message": null, + "ResourceNotFoundException$type": "Client
", + "ResourceNotFoundException$code": "404 Not Found
", + "ResourceNotFoundException$message": null, + "ServiceUnavailableException$type": "Server
", + "ServiceUnavailableException$code": "500 Internal Server Error
", + "ServiceUnavailableException$message": null, + "SetDataRetrievalPolicyInput$accountId": "The AccountId value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single apos-apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your account ID, do not include any hyphens (apos-apos) in the ID.
The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single apos-apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens (apos-apos) in the ID.
The name of the vault.
", + "SetVaultNotificationsInput$accountId": "The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single apos-apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens (apos-apos) in the ID.
The name of the vault.
", + "TagKeyList$member": null, + "UploadArchiveInput$vaultName": "The name of the vault.
", + "UploadArchiveInput$accountId": "The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single apos-apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens (apos-apos) in the ID.
The optional description of the archive you are uploading.
", + "UploadArchiveInput$checksum": "The SHA256 tree hash of the data being uploaded.
", + "UploadListElement$MultipartUploadId": "The ID of a multipart upload.
", + "UploadListElement$VaultARN": "The Amazon Resource Name (ARN) of the vault that contains the archive.
", + "UploadListElement$ArchiveDescription": "The description of the archive that was specified in the Initiate Multipart Upload request.
", + "UploadListElement$CreationDate": "The UTC time at which the multipart upload was initiated.
", + "UploadMultipartPartInput$accountId": "The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single apos-apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens (apos-apos) in the ID.
The name of the vault.
", + "UploadMultipartPartInput$uploadId": "The upload ID of the multipart upload.
", + "UploadMultipartPartInput$checksum": "The SHA256 tree hash of the data being uploaded.
", + "UploadMultipartPartInput$range": "Identifies the range of bytes in the assembled archive that will be uploaded in this part. Amazon Glacier uses this information to assemble the archive in the proper sequence. The format of this header follows RFC 2616. An example header is Content-Range:bytes 0-4194303/*.
", + "UploadMultipartPartOutput$checksum": "The SHA256 tree hash that Amazon Glacier computed for the uploaded part.
", + "VaultAccessPolicy$Policy": "The vault access policy.
", + "VaultLockPolicy$Policy": "The vault lock policy.
", + "VaultNotificationConfig$SNSTopic": "The Amazon Simple Notification Service (Amazon SNS) topic Amazon Resource Name (ARN).
" + } + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/glacier/2012-06-01/paginators-1.json b/vendor/github.com/aws/aws-sdk-go/models/apis/glacier/2012-06-01/paginators-1.json new file mode 100644 index 000000000..69691437e --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/glacier/2012-06-01/paginators-1.json @@ -0,0 +1,28 @@ +{ + "pagination": { + "ListJobs": { + "input_token": "marker", + "output_token": "Marker", + "limit_key": "limit", + "result_key": "JobList" + }, + "ListMultipartUploads": { + "input_token": "marker", + "output_token": "Marker", + "limit_key": "limit", + "result_key": "UploadsList" + }, + "ListParts": { + "input_token": "marker", + "output_token": "Marker", + "limit_key": "limit", + "result_key": "Parts" + }, + "ListVaults": { + "input_token": "marker", + "output_token": "Marker", + "limit_key": "limit", + "result_key": "VaultList" + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/glacier/2012-06-01/waiters-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/glacier/2012-06-01/waiters-2.json new file mode 100644 index 000000000..07a64a056 --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/glacier/2012-06-01/waiters-2.json @@ -0,0 +1,39 @@ +{ + "version": 2, + "waiters": { + "VaultExists": { + "operation": "DescribeVault", + "delay": 3, + "maxAttempts": 15, + "acceptors": [ + { + "state": "success", + "matcher": "status", + "expected": 200 + }, + { + "state": "retry", + "matcher": "error", + "expected": "ResourceNotFoundException" + } + ] + }, + "VaultNotExists": { + "operation": "DescribeVault", + "delay": 3, + "maxAttempts": 15, + "acceptors": [ + { + "state": "retry", + "matcher": "status", + "expected": 200 + }, + { + "state": "success", + "matcher": "error", + "expected": "ResourceNotFoundException" + } + ] + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/iam/2010-05-08/api-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/iam/2010-05-08/api-2.json new file mode 100644 index 000000000..a118fe568 --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/iam/2010-05-08/api-2.json @@ -0,0 +1,4514 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2010-05-08", + "endpointPrefix":"iam", + "globalEndpoint":"iam.amazonaws.com", + "protocol":"query", + "serviceAbbreviation":"IAM", + "serviceFullName":"AWS Identity and Access Management", + "signatureVersion":"v4", + "xmlNamespace":"https://iam.amazonaws.com/doc/2010-05-08/" + }, + "operations":{ + "AddClientIDToOpenIDConnectProvider":{ + "name":"AddClientIDToOpenIDConnectProvider", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddClientIDToOpenIDConnectProviderRequest"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"NoSuchEntityException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceFailureException"} + ] + }, + "AddRoleToInstanceProfile":{ + "name":"AddRoleToInstanceProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddRoleToInstanceProfileRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"EntityAlreadyExistsException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceFailureException"} + ] + }, + "AddUserToGroup":{ + "name":"AddUserToGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddUserToGroupRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceFailureException"} + ] + }, + "AttachGroupPolicy":{ + "name":"AttachGroupPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AttachGroupPolicyRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"LimitExceededException"}, + {"shape":"InvalidInputException"}, + {"shape":"ServiceFailureException"} + ] + }, + "AttachRolePolicy":{ + "name":"AttachRolePolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AttachRolePolicyRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"LimitExceededException"}, + {"shape":"InvalidInputException"}, + {"shape":"ServiceFailureException"} + ] + }, + "AttachUserPolicy":{ + "name":"AttachUserPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AttachUserPolicyRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"LimitExceededException"}, + {"shape":"InvalidInputException"}, + {"shape":"ServiceFailureException"} + ] + }, + "ChangePassword":{ + "name":"ChangePassword", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ChangePasswordRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"InvalidUserTypeException"}, + {"shape":"LimitExceededException"}, + {"shape":"EntityTemporarilyUnmodifiableException"}, + {"shape":"PasswordPolicyViolationException"}, + {"shape":"ServiceFailureException"} + ] + }, + "CreateAccessKey":{ + "name":"CreateAccessKey", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateAccessKeyRequest"}, + "output":{ + "shape":"CreateAccessKeyResponse", + "resultWrapper":"CreateAccessKeyResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceFailureException"} + ] + }, + "CreateAccountAlias":{ + "name":"CreateAccountAlias", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateAccountAliasRequest"}, + "errors":[ + {"shape":"EntityAlreadyExistsException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceFailureException"} + ] + }, + "CreateGroup":{ + "name":"CreateGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateGroupRequest"}, + "output":{ + "shape":"CreateGroupResponse", + "resultWrapper":"CreateGroupResult" + }, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"EntityAlreadyExistsException"}, + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceFailureException"} + ] + }, + "CreateInstanceProfile":{ + "name":"CreateInstanceProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateInstanceProfileRequest"}, + "output":{ + "shape":"CreateInstanceProfileResponse", + "resultWrapper":"CreateInstanceProfileResult" + }, + "errors":[ + {"shape":"EntityAlreadyExistsException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceFailureException"} + ] + }, + "CreateLoginProfile":{ + "name":"CreateLoginProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateLoginProfileRequest"}, + "output":{ + "shape":"CreateLoginProfileResponse", + "resultWrapper":"CreateLoginProfileResult" + }, + "errors":[ + {"shape":"EntityAlreadyExistsException"}, + {"shape":"NoSuchEntityException"}, + {"shape":"PasswordPolicyViolationException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceFailureException"} + ] + }, + "CreateOpenIDConnectProvider":{ + "name":"CreateOpenIDConnectProvider", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateOpenIDConnectProviderRequest"}, + "output":{ + "shape":"CreateOpenIDConnectProviderResponse", + "resultWrapper":"CreateOpenIDConnectProviderResult" + }, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"EntityAlreadyExistsException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceFailureException"} + ] + }, + "CreatePolicy":{ + "name":"CreatePolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreatePolicyRequest"}, + "output":{ + "shape":"CreatePolicyResponse", + "resultWrapper":"CreatePolicyResult" + }, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"LimitExceededException"}, + {"shape":"EntityAlreadyExistsException"}, + {"shape":"MalformedPolicyDocumentException"}, + {"shape":"ServiceFailureException"} + ] + }, + "CreatePolicyVersion":{ + "name":"CreatePolicyVersion", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreatePolicyVersionRequest"}, + "output":{ + "shape":"CreatePolicyVersionResponse", + "resultWrapper":"CreatePolicyVersionResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"MalformedPolicyDocumentException"}, + {"shape":"InvalidInputException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceFailureException"} + ] + }, + "CreateRole":{ + "name":"CreateRole", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateRoleRequest"}, + "output":{ + "shape":"CreateRoleResponse", + "resultWrapper":"CreateRoleResult" + }, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"EntityAlreadyExistsException"}, + {"shape":"MalformedPolicyDocumentException"}, + {"shape":"ServiceFailureException"} + ] + }, + "CreateSAMLProvider":{ + "name":"CreateSAMLProvider", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateSAMLProviderRequest"}, + "output":{ + "shape":"CreateSAMLProviderResponse", + "resultWrapper":"CreateSAMLProviderResult" + }, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"EntityAlreadyExistsException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceFailureException"} + ] + }, + "CreateUser":{ + "name":"CreateUser", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateUserRequest"}, + "output":{ + "shape":"CreateUserResponse", + "resultWrapper":"CreateUserResult" + }, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"EntityAlreadyExistsException"}, + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceFailureException"} + ] + }, + "CreateVirtualMFADevice":{ + "name":"CreateVirtualMFADevice", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateVirtualMFADeviceRequest"}, + "output":{ + "shape":"CreateVirtualMFADeviceResponse", + "resultWrapper":"CreateVirtualMFADeviceResult" + }, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"EntityAlreadyExistsException"}, + {"shape":"ServiceFailureException"} + ] + }, + "DeactivateMFADevice":{ + "name":"DeactivateMFADevice", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeactivateMFADeviceRequest"}, + "errors":[ + {"shape":"EntityTemporarilyUnmodifiableException"}, + {"shape":"NoSuchEntityException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceFailureException"} + ] + }, + "DeleteAccessKey":{ + "name":"DeleteAccessKey", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteAccessKeyRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceFailureException"} + ] + }, + "DeleteAccountAlias":{ + "name":"DeleteAccountAlias", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteAccountAliasRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceFailureException"} + ] + }, + "DeleteAccountPasswordPolicy":{ + "name":"DeleteAccountPasswordPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceFailureException"} + ] + }, + "DeleteGroup":{ + "name":"DeleteGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteGroupRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"DeleteConflictException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceFailureException"} + ] + }, + "DeleteGroupPolicy":{ + "name":"DeleteGroupPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteGroupPolicyRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceFailureException"} + ] + }, + "DeleteInstanceProfile":{ + "name":"DeleteInstanceProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteInstanceProfileRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"DeleteConflictException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceFailureException"} + ] + }, + "DeleteLoginProfile":{ + "name":"DeleteLoginProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteLoginProfileRequest"}, + "errors":[ + {"shape":"EntityTemporarilyUnmodifiableException"}, + {"shape":"NoSuchEntityException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceFailureException"} + ] + }, + "DeleteOpenIDConnectProvider":{ + "name":"DeleteOpenIDConnectProvider", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteOpenIDConnectProviderRequest"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceFailureException"} + ] + }, + "DeletePolicy":{ + "name":"DeletePolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeletePolicyRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"LimitExceededException"}, + {"shape":"InvalidInputException"}, + {"shape":"DeleteConflictException"}, + {"shape":"ServiceFailureException"} + ] + }, + "DeletePolicyVersion":{ + "name":"DeletePolicyVersion", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeletePolicyVersionRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"LimitExceededException"}, + {"shape":"InvalidInputException"}, + {"shape":"DeleteConflictException"}, + {"shape":"ServiceFailureException"} + ] + }, + "DeleteRole":{ + "name":"DeleteRole", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteRoleRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"DeleteConflictException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceFailureException"} + ] + }, + "DeleteRolePolicy":{ + "name":"DeleteRolePolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteRolePolicyRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceFailureException"} + ] + }, + "DeleteSAMLProvider":{ + "name":"DeleteSAMLProvider", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSAMLProviderRequest"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"LimitExceededException"}, + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceFailureException"} + ] + }, + "DeleteSSHPublicKey":{ + "name":"DeleteSSHPublicKey", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSSHPublicKeyRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"} + ] + }, + "DeleteServerCertificate":{ + "name":"DeleteServerCertificate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteServerCertificateRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"DeleteConflictException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceFailureException"} + ] + }, + "DeleteSigningCertificate":{ + "name":"DeleteSigningCertificate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSigningCertificateRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceFailureException"} + ] + }, + "DeleteUser":{ + "name":"DeleteUser", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteUserRequest"}, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"NoSuchEntityException"}, + {"shape":"DeleteConflictException"}, + {"shape":"ServiceFailureException"} + ] + }, + "DeleteUserPolicy":{ + "name":"DeleteUserPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteUserPolicyRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceFailureException"} + ] + }, + "DeleteVirtualMFADevice":{ + "name":"DeleteVirtualMFADevice", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteVirtualMFADeviceRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"DeleteConflictException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceFailureException"} + ] + }, + "DetachGroupPolicy":{ + "name":"DetachGroupPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetachGroupPolicyRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"LimitExceededException"}, + {"shape":"InvalidInputException"}, + {"shape":"ServiceFailureException"} + ] + }, + "DetachRolePolicy":{ + "name":"DetachRolePolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetachRolePolicyRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"LimitExceededException"}, + {"shape":"InvalidInputException"}, + {"shape":"ServiceFailureException"} + ] + }, + "DetachUserPolicy":{ + "name":"DetachUserPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetachUserPolicyRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"LimitExceededException"}, + {"shape":"InvalidInputException"}, + {"shape":"ServiceFailureException"} + ] + }, + "EnableMFADevice":{ + "name":"EnableMFADevice", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"EnableMFADeviceRequest"}, + "errors":[ + {"shape":"EntityAlreadyExistsException"}, + {"shape":"EntityTemporarilyUnmodifiableException"}, + {"shape":"InvalidAuthenticationCodeException"}, + {"shape":"LimitExceededException"}, + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceFailureException"} + ] + }, + "GenerateCredentialReport":{ + "name":"GenerateCredentialReport", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "output":{ + "shape":"GenerateCredentialReportResponse", + "resultWrapper":"GenerateCredentialReportResult" + }, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"ServiceFailureException"} + ] + }, + "GetAccessKeyLastUsed":{ + "name":"GetAccessKeyLastUsed", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetAccessKeyLastUsedRequest"}, + "output":{ + "shape":"GetAccessKeyLastUsedResponse", + "resultWrapper":"GetAccessKeyLastUsedResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"} + ] + }, + "GetAccountAuthorizationDetails":{ + "name":"GetAccountAuthorizationDetails", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetAccountAuthorizationDetailsRequest"}, + "output":{ + "shape":"GetAccountAuthorizationDetailsResponse", + "resultWrapper":"GetAccountAuthorizationDetailsResult" + }, + "errors":[ + {"shape":"ServiceFailureException"} + ] + }, + "GetAccountPasswordPolicy":{ + "name":"GetAccountPasswordPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "output":{ + "shape":"GetAccountPasswordPolicyResponse", + "resultWrapper":"GetAccountPasswordPolicyResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceFailureException"} + ] + }, + "GetAccountSummary":{ + "name":"GetAccountSummary", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "output":{ + "shape":"GetAccountSummaryResponse", + "resultWrapper":"GetAccountSummaryResult" + }, + "errors":[ + {"shape":"ServiceFailureException"} + ] + }, + "GetContextKeysForCustomPolicy":{ + "name":"GetContextKeysForCustomPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetContextKeysForCustomPolicyRequest"}, + "output":{ + "shape":"GetContextKeysForPolicyResponse", + "resultWrapper":"GetContextKeysForCustomPolicyResult" + }, + "errors":[ + {"shape":"InvalidInputException"} + ] + }, + "GetContextKeysForPrincipalPolicy":{ + "name":"GetContextKeysForPrincipalPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetContextKeysForPrincipalPolicyRequest"}, + "output":{ + "shape":"GetContextKeysForPolicyResponse", + "resultWrapper":"GetContextKeysForPrincipalPolicyResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"InvalidInputException"} + ] + }, + "GetCredentialReport":{ + "name":"GetCredentialReport", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "output":{ + "shape":"GetCredentialReportResponse", + "resultWrapper":"GetCredentialReportResult" + }, + "errors":[ + {"shape":"CredentialReportNotPresentException"}, + {"shape":"CredentialReportExpiredException"}, + {"shape":"CredentialReportNotReadyException"}, + {"shape":"ServiceFailureException"} + ] + }, + "GetGroup":{ + "name":"GetGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetGroupRequest"}, + "output":{ + "shape":"GetGroupResponse", + "resultWrapper":"GetGroupResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceFailureException"} + ] + }, + "GetGroupPolicy":{ + "name":"GetGroupPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetGroupPolicyRequest"}, + "output":{ + "shape":"GetGroupPolicyResponse", + "resultWrapper":"GetGroupPolicyResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceFailureException"} + ] + }, + "GetInstanceProfile":{ + "name":"GetInstanceProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetInstanceProfileRequest"}, + "output":{ + "shape":"GetInstanceProfileResponse", + "resultWrapper":"GetInstanceProfileResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceFailureException"} + ] + }, + "GetLoginProfile":{ + "name":"GetLoginProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetLoginProfileRequest"}, + "output":{ + "shape":"GetLoginProfileResponse", + "resultWrapper":"GetLoginProfileResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceFailureException"} + ] + }, + "GetOpenIDConnectProvider":{ + "name":"GetOpenIDConnectProvider", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetOpenIDConnectProviderRequest"}, + "output":{ + "shape":"GetOpenIDConnectProviderResponse", + "resultWrapper":"GetOpenIDConnectProviderResult" + }, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceFailureException"} + ] + }, + "GetPolicy":{ + "name":"GetPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetPolicyRequest"}, + "output":{ + "shape":"GetPolicyResponse", + "resultWrapper":"GetPolicyResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"InvalidInputException"}, + {"shape":"ServiceFailureException"} + ] + }, + "GetPolicyVersion":{ + "name":"GetPolicyVersion", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetPolicyVersionRequest"}, + "output":{ + "shape":"GetPolicyVersionResponse", + "resultWrapper":"GetPolicyVersionResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"InvalidInputException"}, + {"shape":"ServiceFailureException"} + ] + }, + "GetRole":{ + "name":"GetRole", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetRoleRequest"}, + "output":{ + "shape":"GetRoleResponse", + "resultWrapper":"GetRoleResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceFailureException"} + ] + }, + "GetRolePolicy":{ + "name":"GetRolePolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetRolePolicyRequest"}, + "output":{ + "shape":"GetRolePolicyResponse", + "resultWrapper":"GetRolePolicyResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceFailureException"} + ] + }, + "GetSAMLProvider":{ + "name":"GetSAMLProvider", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetSAMLProviderRequest"}, + "output":{ + "shape":"GetSAMLProviderResponse", + "resultWrapper":"GetSAMLProviderResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"InvalidInputException"}, + {"shape":"ServiceFailureException"} + ] + }, + "GetSSHPublicKey":{ + "name":"GetSSHPublicKey", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetSSHPublicKeyRequest"}, + "output":{ + "shape":"GetSSHPublicKeyResponse", + "resultWrapper":"GetSSHPublicKeyResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"UnrecognizedPublicKeyEncodingException"} + ] + }, + "GetServerCertificate":{ + "name":"GetServerCertificate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetServerCertificateRequest"}, + "output":{ + "shape":"GetServerCertificateResponse", + "resultWrapper":"GetServerCertificateResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceFailureException"} + ] + }, + "GetUser":{ + "name":"GetUser", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetUserRequest"}, + "output":{ + "shape":"GetUserResponse", + "resultWrapper":"GetUserResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceFailureException"} + ] + }, + "GetUserPolicy":{ + "name":"GetUserPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetUserPolicyRequest"}, + "output":{ + "shape":"GetUserPolicyResponse", + "resultWrapper":"GetUserPolicyResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceFailureException"} + ] + }, + "ListAccessKeys":{ + "name":"ListAccessKeys", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAccessKeysRequest"}, + "output":{ + "shape":"ListAccessKeysResponse", + "resultWrapper":"ListAccessKeysResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceFailureException"} + ] + }, + "ListAccountAliases":{ + "name":"ListAccountAliases", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAccountAliasesRequest"}, + "output":{ + "shape":"ListAccountAliasesResponse", + "resultWrapper":"ListAccountAliasesResult" + }, + "errors":[ + {"shape":"ServiceFailureException"} + ] + }, + "ListAttachedGroupPolicies":{ + "name":"ListAttachedGroupPolicies", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAttachedGroupPoliciesRequest"}, + "output":{ + "shape":"ListAttachedGroupPoliciesResponse", + "resultWrapper":"ListAttachedGroupPoliciesResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"InvalidInputException"}, + {"shape":"ServiceFailureException"} + ] + }, + "ListAttachedRolePolicies":{ + "name":"ListAttachedRolePolicies", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAttachedRolePoliciesRequest"}, + "output":{ + "shape":"ListAttachedRolePoliciesResponse", + "resultWrapper":"ListAttachedRolePoliciesResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"InvalidInputException"}, + {"shape":"ServiceFailureException"} + ] + }, + "ListAttachedUserPolicies":{ + "name":"ListAttachedUserPolicies", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAttachedUserPoliciesRequest"}, + "output":{ + "shape":"ListAttachedUserPoliciesResponse", + "resultWrapper":"ListAttachedUserPoliciesResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"InvalidInputException"}, + {"shape":"ServiceFailureException"} + ] + }, + "ListEntitiesForPolicy":{ + "name":"ListEntitiesForPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListEntitiesForPolicyRequest"}, + "output":{ + "shape":"ListEntitiesForPolicyResponse", + "resultWrapper":"ListEntitiesForPolicyResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"InvalidInputException"}, + {"shape":"ServiceFailureException"} + ] + }, + "ListGroupPolicies":{ + "name":"ListGroupPolicies", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListGroupPoliciesRequest"}, + "output":{ + "shape":"ListGroupPoliciesResponse", + "resultWrapper":"ListGroupPoliciesResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceFailureException"} + ] + }, + "ListGroups":{ + "name":"ListGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListGroupsRequest"}, + "output":{ + "shape":"ListGroupsResponse", + "resultWrapper":"ListGroupsResult" + }, + "errors":[ + {"shape":"ServiceFailureException"} + ] + }, + "ListGroupsForUser":{ + "name":"ListGroupsForUser", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListGroupsForUserRequest"}, + "output":{ + "shape":"ListGroupsForUserResponse", + "resultWrapper":"ListGroupsForUserResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceFailureException"} + ] + }, + "ListInstanceProfiles":{ + "name":"ListInstanceProfiles", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListInstanceProfilesRequest"}, + "output":{ + "shape":"ListInstanceProfilesResponse", + "resultWrapper":"ListInstanceProfilesResult" + }, + "errors":[ + {"shape":"ServiceFailureException"} + ] + }, + "ListInstanceProfilesForRole":{ + "name":"ListInstanceProfilesForRole", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListInstanceProfilesForRoleRequest"}, + "output":{ + "shape":"ListInstanceProfilesForRoleResponse", + "resultWrapper":"ListInstanceProfilesForRoleResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceFailureException"} + ] + }, + "ListMFADevices":{ + "name":"ListMFADevices", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListMFADevicesRequest"}, + "output":{ + "shape":"ListMFADevicesResponse", + "resultWrapper":"ListMFADevicesResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceFailureException"} + ] + }, + "ListOpenIDConnectProviders":{ + "name":"ListOpenIDConnectProviders", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListOpenIDConnectProvidersRequest"}, + "output":{ + "shape":"ListOpenIDConnectProvidersResponse", + "resultWrapper":"ListOpenIDConnectProvidersResult" + }, + "errors":[ + {"shape":"ServiceFailureException"} + ] + }, + "ListPolicies":{ + "name":"ListPolicies", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListPoliciesRequest"}, + "output":{ + "shape":"ListPoliciesResponse", + "resultWrapper":"ListPoliciesResult" + }, + "errors":[ + {"shape":"ServiceFailureException"} + ] + }, + "ListPolicyVersions":{ + "name":"ListPolicyVersions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListPolicyVersionsRequest"}, + "output":{ + "shape":"ListPolicyVersionsResponse", + "resultWrapper":"ListPolicyVersionsResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"InvalidInputException"}, + {"shape":"ServiceFailureException"} + ] + }, + "ListRolePolicies":{ + "name":"ListRolePolicies", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListRolePoliciesRequest"}, + "output":{ + "shape":"ListRolePoliciesResponse", + "resultWrapper":"ListRolePoliciesResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceFailureException"} + ] + }, + "ListRoles":{ + "name":"ListRoles", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListRolesRequest"}, + "output":{ + "shape":"ListRolesResponse", + "resultWrapper":"ListRolesResult" + }, + "errors":[ + {"shape":"ServiceFailureException"} + ] + }, + "ListSAMLProviders":{ + "name":"ListSAMLProviders", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListSAMLProvidersRequest"}, + "output":{ + "shape":"ListSAMLProvidersResponse", + "resultWrapper":"ListSAMLProvidersResult" + }, + "errors":[ + {"shape":"ServiceFailureException"} + ] + }, + "ListSSHPublicKeys":{ + "name":"ListSSHPublicKeys", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListSSHPublicKeysRequest"}, + "output":{ + "shape":"ListSSHPublicKeysResponse", + "resultWrapper":"ListSSHPublicKeysResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"} + ] + }, + "ListServerCertificates":{ + "name":"ListServerCertificates", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListServerCertificatesRequest"}, + "output":{ + "shape":"ListServerCertificatesResponse", + "resultWrapper":"ListServerCertificatesResult" + }, + "errors":[ + {"shape":"ServiceFailureException"} + ] + }, + "ListSigningCertificates":{ + "name":"ListSigningCertificates", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListSigningCertificatesRequest"}, + "output":{ + "shape":"ListSigningCertificatesResponse", + "resultWrapper":"ListSigningCertificatesResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceFailureException"} + ] + }, + "ListUserPolicies":{ + "name":"ListUserPolicies", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListUserPoliciesRequest"}, + "output":{ + "shape":"ListUserPoliciesResponse", + "resultWrapper":"ListUserPoliciesResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceFailureException"} + ] + }, + "ListUsers":{ + "name":"ListUsers", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListUsersRequest"}, + "output":{ + "shape":"ListUsersResponse", + "resultWrapper":"ListUsersResult" + }, + "errors":[ + {"shape":"ServiceFailureException"} + ] + }, + "ListVirtualMFADevices":{ + "name":"ListVirtualMFADevices", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListVirtualMFADevicesRequest"}, + "output":{ + "shape":"ListVirtualMFADevicesResponse", + "resultWrapper":"ListVirtualMFADevicesResult" + } + }, + "PutGroupPolicy":{ + "name":"PutGroupPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutGroupPolicyRequest"}, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"MalformedPolicyDocumentException"}, + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceFailureException"} + ] + }, + "PutRolePolicy":{ + "name":"PutRolePolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutRolePolicyRequest"}, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"MalformedPolicyDocumentException"}, + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceFailureException"} + ] + }, + "PutUserPolicy":{ + "name":"PutUserPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutUserPolicyRequest"}, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"MalformedPolicyDocumentException"}, + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceFailureException"} + ] + }, + "RemoveClientIDFromOpenIDConnectProvider":{ + "name":"RemoveClientIDFromOpenIDConnectProvider", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RemoveClientIDFromOpenIDConnectProviderRequest"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceFailureException"} + ] + }, + "RemoveRoleFromInstanceProfile":{ + "name":"RemoveRoleFromInstanceProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RemoveRoleFromInstanceProfileRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceFailureException"} + ] + }, + "RemoveUserFromGroup":{ + "name":"RemoveUserFromGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RemoveUserFromGroupRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceFailureException"} + ] + }, + "ResyncMFADevice":{ + "name":"ResyncMFADevice", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResyncMFADeviceRequest"}, + "errors":[ + {"shape":"InvalidAuthenticationCodeException"}, + {"shape":"NoSuchEntityException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceFailureException"} + ] + }, + "SetDefaultPolicyVersion":{ + "name":"SetDefaultPolicyVersion", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SetDefaultPolicyVersionRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"InvalidInputException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceFailureException"} + ] + }, + "SimulateCustomPolicy":{ + "name":"SimulateCustomPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SimulateCustomPolicyRequest"}, + "output":{ + "shape":"SimulatePolicyResponse", + "resultWrapper":"SimulateCustomPolicyResult" + }, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"PolicyEvaluationException"} + ] + }, + "SimulatePrincipalPolicy":{ + "name":"SimulatePrincipalPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SimulatePrincipalPolicyRequest"}, + "output":{ + "shape":"SimulatePolicyResponse", + "resultWrapper":"SimulatePrincipalPolicyResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"InvalidInputException"}, + {"shape":"PolicyEvaluationException"} + ] + }, + "UpdateAccessKey":{ + "name":"UpdateAccessKey", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateAccessKeyRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceFailureException"} + ] + }, + "UpdateAccountPasswordPolicy":{ + "name":"UpdateAccountPasswordPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateAccountPasswordPolicyRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"MalformedPolicyDocumentException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceFailureException"} + ] + }, + "UpdateAssumeRolePolicy":{ + "name":"UpdateAssumeRolePolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateAssumeRolePolicyRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"MalformedPolicyDocumentException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceFailureException"} + ] + }, + "UpdateGroup":{ + "name":"UpdateGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateGroupRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"EntityAlreadyExistsException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceFailureException"} + ] + }, + "UpdateLoginProfile":{ + "name":"UpdateLoginProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateLoginProfileRequest"}, + "errors":[ + {"shape":"EntityTemporarilyUnmodifiableException"}, + {"shape":"NoSuchEntityException"}, + {"shape":"PasswordPolicyViolationException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceFailureException"} + ] + }, + "UpdateOpenIDConnectProviderThumbprint":{ + "name":"UpdateOpenIDConnectProviderThumbprint", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateOpenIDConnectProviderThumbprintRequest"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceFailureException"} + ] + }, + "UpdateSAMLProvider":{ + "name":"UpdateSAMLProvider", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateSAMLProviderRequest"}, + "output":{ + "shape":"UpdateSAMLProviderResponse", + "resultWrapper":"UpdateSAMLProviderResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"InvalidInputException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceFailureException"} + ] + }, + "UpdateSSHPublicKey":{ + "name":"UpdateSSHPublicKey", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateSSHPublicKeyRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"} + ] + }, + "UpdateServerCertificate":{ + "name":"UpdateServerCertificate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateServerCertificateRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"EntityAlreadyExistsException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceFailureException"} + ] + }, + "UpdateSigningCertificate":{ + "name":"UpdateSigningCertificate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateSigningCertificateRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceFailureException"} + ] + }, + "UpdateUser":{ + "name":"UpdateUser", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateUserRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"LimitExceededException"}, + {"shape":"EntityAlreadyExistsException"}, + {"shape":"EntityTemporarilyUnmodifiableException"}, + {"shape":"ServiceFailureException"} + ] + }, + "UploadSSHPublicKey":{ + "name":"UploadSSHPublicKey", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UploadSSHPublicKeyRequest"}, + "output":{ + "shape":"UploadSSHPublicKeyResponse", + "resultWrapper":"UploadSSHPublicKeyResult" + }, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"NoSuchEntityException"}, + {"shape":"InvalidPublicKeyException"}, + {"shape":"DuplicateSSHPublicKeyException"}, + {"shape":"UnrecognizedPublicKeyEncodingException"} + ] + }, + "UploadServerCertificate":{ + "name":"UploadServerCertificate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UploadServerCertificateRequest"}, + "output":{ + "shape":"UploadServerCertificateResponse", + "resultWrapper":"UploadServerCertificateResult" + }, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"EntityAlreadyExistsException"}, + {"shape":"MalformedCertificateException"}, + {"shape":"KeyPairMismatchException"}, + {"shape":"ServiceFailureException"} + ] + }, + "UploadSigningCertificate":{ + "name":"UploadSigningCertificate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UploadSigningCertificateRequest"}, + "output":{ + "shape":"UploadSigningCertificateResponse", + "resultWrapper":"UploadSigningCertificateResult" + }, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"EntityAlreadyExistsException"}, + {"shape":"MalformedCertificateException"}, + {"shape":"InvalidCertificateException"}, + {"shape":"DuplicateCertificateException"}, + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceFailureException"} + ] + } + }, + "shapes":{ + "AccessKey":{ + "type":"structure", + "required":[ + "UserName", + "AccessKeyId", + "Status", + "SecretAccessKey" + ], + "members":{ + "UserName":{"shape":"userNameType"}, + "AccessKeyId":{"shape":"accessKeyIdType"}, + "Status":{"shape":"statusType"}, + "SecretAccessKey":{"shape":"accessKeySecretType"}, + "CreateDate":{"shape":"dateType"} + } + }, + "AccessKeyLastUsed":{ + "type":"structure", + "required":[ + "LastUsedDate", + "ServiceName", + "Region" + ], + "members":{ + "LastUsedDate":{"shape":"dateType"}, + "ServiceName":{"shape":"stringType"}, + "Region":{"shape":"stringType"} + } + }, + "AccessKeyMetadata":{ + "type":"structure", + "members":{ + "UserName":{"shape":"userNameType"}, + "AccessKeyId":{"shape":"accessKeyIdType"}, + "Status":{"shape":"statusType"}, + "CreateDate":{"shape":"dateType"} + } + }, + "ActionNameListType":{ + "type":"list", + "member":{"shape":"ActionNameType"} + }, + "ActionNameType":{ + "type":"string", + "max":128, + "min":3 + }, + "AddClientIDToOpenIDConnectProviderRequest":{ + "type":"structure", + "required":[ + "OpenIDConnectProviderArn", + "ClientID" + ], + "members":{ + "OpenIDConnectProviderArn":{"shape":"arnType"}, + "ClientID":{"shape":"clientIDType"} + } + }, + "AddRoleToInstanceProfileRequest":{ + "type":"structure", + "required":[ + "InstanceProfileName", + "RoleName" + ], + "members":{ + "InstanceProfileName":{"shape":"instanceProfileNameType"}, + "RoleName":{"shape":"roleNameType"} + } + }, + "AddUserToGroupRequest":{ + "type":"structure", + "required":[ + "GroupName", + "UserName" + ], + "members":{ + "GroupName":{"shape":"groupNameType"}, + "UserName":{"shape":"existingUserNameType"} + } + }, + "AttachGroupPolicyRequest":{ + "type":"structure", + "required":[ + "GroupName", + "PolicyArn" + ], + "members":{ + "GroupName":{"shape":"groupNameType"}, + "PolicyArn":{"shape":"arnType"} + } + }, + "AttachRolePolicyRequest":{ + "type":"structure", + "required":[ + "RoleName", + "PolicyArn" + ], + "members":{ + "RoleName":{"shape":"roleNameType"}, + "PolicyArn":{"shape":"arnType"} + } + }, + "AttachUserPolicyRequest":{ + "type":"structure", + "required":[ + "UserName", + "PolicyArn" + ], + "members":{ + "UserName":{"shape":"userNameType"}, + "PolicyArn":{"shape":"arnType"} + } + }, + "AttachedPolicy":{ + "type":"structure", + "members":{ + "PolicyName":{"shape":"policyNameType"}, + "PolicyArn":{"shape":"arnType"} + } + }, + "BootstrapDatum":{ + "type":"blob", + "sensitive":true + }, + "ChangePasswordRequest":{ + "type":"structure", + "required":[ + "OldPassword", + "NewPassword" + ], + "members":{ + "OldPassword":{"shape":"passwordType"}, + "NewPassword":{"shape":"passwordType"} + } + }, + "ColumnNumber":{"type":"integer"}, + "ContextEntry":{ + "type":"structure", + "members":{ + "ContextKeyName":{"shape":"ContextKeyNameType"}, + "ContextKeyValues":{"shape":"ContextKeyValueListType"}, + "ContextKeyType":{"shape":"ContextKeyTypeEnum"} + } + }, + "ContextEntryListType":{ + "type":"list", + "member":{"shape":"ContextEntry"} + }, + "ContextKeyNameType":{ + "type":"string", + "max":256, + "min":5 + }, + "ContextKeyNamesResultListType":{ + "type":"list", + "member":{"shape":"ContextKeyNameType"} + }, + "ContextKeyTypeEnum":{ + "type":"string", + "enum":[ + "string", + "stringList", + "numeric", + "numericList", + "boolean", + "booleanList", + "ip", + "ipList", + "binary", + "binaryList", + "date", + "dateList" + ] + }, + "ContextKeyValueListType":{ + "type":"list", + "member":{"shape":"ContextKeyValueType"} + }, + "ContextKeyValueType":{"type":"string"}, + "CreateAccessKeyRequest":{ + "type":"structure", + "members":{ + "UserName":{"shape":"existingUserNameType"} + } + }, + "CreateAccessKeyResponse":{ + "type":"structure", + "required":["AccessKey"], + "members":{ + "AccessKey":{"shape":"AccessKey"} + } + }, + "CreateAccountAliasRequest":{ + "type":"structure", + "required":["AccountAlias"], + "members":{ + "AccountAlias":{"shape":"accountAliasType"} + } + }, + "CreateGroupRequest":{ + "type":"structure", + "required":["GroupName"], + "members":{ + "Path":{"shape":"pathType"}, + "GroupName":{"shape":"groupNameType"} + } + }, + "CreateGroupResponse":{ + "type":"structure", + "required":["Group"], + "members":{ + "Group":{"shape":"Group"} + } + }, + "CreateInstanceProfileRequest":{ + "type":"structure", + "required":["InstanceProfileName"], + "members":{ + "InstanceProfileName":{"shape":"instanceProfileNameType"}, + "Path":{"shape":"pathType"} + } + }, + "CreateInstanceProfileResponse":{ + "type":"structure", + "required":["InstanceProfile"], + "members":{ + "InstanceProfile":{"shape":"InstanceProfile"} + } + }, + "CreateLoginProfileRequest":{ + "type":"structure", + "required":[ + "UserName", + "Password" + ], + "members":{ + "UserName":{"shape":"userNameType"}, + "Password":{"shape":"passwordType"}, + "PasswordResetRequired":{"shape":"booleanType"} + } + }, + "CreateLoginProfileResponse":{ + "type":"structure", + "required":["LoginProfile"], + "members":{ + "LoginProfile":{"shape":"LoginProfile"} + } + }, + "CreateOpenIDConnectProviderRequest":{ + "type":"structure", + "required":[ + "Url", + "ThumbprintList" + ], + "members":{ + "Url":{"shape":"OpenIDConnectProviderUrlType"}, + "ClientIDList":{"shape":"clientIDListType"}, + "ThumbprintList":{"shape":"thumbprintListType"} + } + }, + "CreateOpenIDConnectProviderResponse":{ + "type":"structure", + "members":{ + "OpenIDConnectProviderArn":{"shape":"arnType"} + } + }, + "CreatePolicyRequest":{ + "type":"structure", + "required":[ + "PolicyName", + "PolicyDocument" + ], + "members":{ + "PolicyName":{"shape":"policyNameType"}, + "Path":{"shape":"policyPathType"}, + "PolicyDocument":{"shape":"policyDocumentType"}, + "Description":{"shape":"policyDescriptionType"} + } + }, + "CreatePolicyResponse":{ + "type":"structure", + "members":{ + "Policy":{"shape":"Policy"} + } + }, + "CreatePolicyVersionRequest":{ + "type":"structure", + "required":[ + "PolicyArn", + "PolicyDocument" + ], + "members":{ + "PolicyArn":{"shape":"arnType"}, + "PolicyDocument":{"shape":"policyDocumentType"}, + "SetAsDefault":{"shape":"booleanType"} + } + }, + "CreatePolicyVersionResponse":{ + "type":"structure", + "members":{ + "PolicyVersion":{"shape":"PolicyVersion"} + } + }, + "CreateRoleRequest":{ + "type":"structure", + "required":[ + "RoleName", + "AssumeRolePolicyDocument" + ], + "members":{ + "Path":{"shape":"pathType"}, + "RoleName":{"shape":"roleNameType"}, + "AssumeRolePolicyDocument":{"shape":"policyDocumentType"} + } + }, + "CreateRoleResponse":{ + "type":"structure", + "required":["Role"], + "members":{ + "Role":{"shape":"Role"} + } + }, + "CreateSAMLProviderRequest":{ + "type":"structure", + "required":[ + "SAMLMetadataDocument", + "Name" + ], + "members":{ + "SAMLMetadataDocument":{"shape":"SAMLMetadataDocumentType"}, + "Name":{"shape":"SAMLProviderNameType"} + } + }, + "CreateSAMLProviderResponse":{ + "type":"structure", + "members":{ + "SAMLProviderArn":{"shape":"arnType"} + } + }, + "CreateUserRequest":{ + "type":"structure", + "required":["UserName"], + "members":{ + "Path":{"shape":"pathType"}, + "UserName":{"shape":"userNameType"} + } + }, + "CreateUserResponse":{ + "type":"structure", + "members":{ + "User":{"shape":"User"} + } + }, + "CreateVirtualMFADeviceRequest":{ + "type":"structure", + "required":["VirtualMFADeviceName"], + "members":{ + "Path":{"shape":"pathType"}, + "VirtualMFADeviceName":{"shape":"virtualMFADeviceName"} + } + }, + "CreateVirtualMFADeviceResponse":{ + "type":"structure", + "required":["VirtualMFADevice"], + "members":{ + "VirtualMFADevice":{"shape":"VirtualMFADevice"} + } + }, + "CredentialReportExpiredException":{ + "type":"structure", + "members":{ + "message":{"shape":"credentialReportExpiredExceptionMessage"} + }, + "error":{ + "code":"ReportExpired", + "httpStatusCode":410, + "senderFault":true + }, + "exception":true + }, + "CredentialReportNotPresentException":{ + "type":"structure", + "members":{ + "message":{"shape":"credentialReportNotPresentExceptionMessage"} + }, + "error":{ + "code":"ReportNotPresent", + "httpStatusCode":410, + "senderFault":true + }, + "exception":true + }, + "CredentialReportNotReadyException":{ + "type":"structure", + "members":{ + "message":{"shape":"credentialReportNotReadyExceptionMessage"} + }, + "error":{ + "code":"ReportInProgress", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "DeactivateMFADeviceRequest":{ + "type":"structure", + "required":[ + "UserName", + "SerialNumber" + ], + "members":{ + "UserName":{"shape":"existingUserNameType"}, + "SerialNumber":{"shape":"serialNumberType"} + } + }, + "DeleteAccessKeyRequest":{ + "type":"structure", + "required":["AccessKeyId"], + "members":{ + "UserName":{"shape":"existingUserNameType"}, + "AccessKeyId":{"shape":"accessKeyIdType"} + } + }, + "DeleteAccountAliasRequest":{ + "type":"structure", + "required":["AccountAlias"], + "members":{ + "AccountAlias":{"shape":"accountAliasType"} + } + }, + "DeleteConflictException":{ + "type":"structure", + "members":{ + "message":{"shape":"deleteConflictMessage"} + }, + "error":{ + "code":"DeleteConflict", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + "DeleteGroupPolicyRequest":{ + "type":"structure", + "required":[ + "GroupName", + "PolicyName" + ], + "members":{ + "GroupName":{"shape":"groupNameType"}, + "PolicyName":{"shape":"policyNameType"} + } + }, + "DeleteGroupRequest":{ + "type":"structure", + "required":["GroupName"], + "members":{ + "GroupName":{"shape":"groupNameType"} + } + }, + "DeleteInstanceProfileRequest":{ + "type":"structure", + "required":["InstanceProfileName"], + "members":{ + "InstanceProfileName":{"shape":"instanceProfileNameType"} + } + }, + "DeleteLoginProfileRequest":{ + "type":"structure", + "required":["UserName"], + "members":{ + "UserName":{"shape":"userNameType"} + } + }, + "DeleteOpenIDConnectProviderRequest":{ + "type":"structure", + "required":["OpenIDConnectProviderArn"], + "members":{ + "OpenIDConnectProviderArn":{"shape":"arnType"} + } + }, + "DeletePolicyRequest":{ + "type":"structure", + "required":["PolicyArn"], + "members":{ + "PolicyArn":{"shape":"arnType"} + } + }, + "DeletePolicyVersionRequest":{ + "type":"structure", + "required":[ + "PolicyArn", + "VersionId" + ], + "members":{ + "PolicyArn":{"shape":"arnType"}, + "VersionId":{"shape":"policyVersionIdType"} + } + }, + "DeleteRolePolicyRequest":{ + "type":"structure", + "required":[ + "RoleName", + "PolicyName" + ], + "members":{ + "RoleName":{"shape":"roleNameType"}, + "PolicyName":{"shape":"policyNameType"} + } + }, + "DeleteRoleRequest":{ + "type":"structure", + "required":["RoleName"], + "members":{ + "RoleName":{"shape":"roleNameType"} + } + }, + "DeleteSAMLProviderRequest":{ + "type":"structure", + "required":["SAMLProviderArn"], + "members":{ + "SAMLProviderArn":{"shape":"arnType"} + } + }, + "DeleteSSHPublicKeyRequest":{ + "type":"structure", + "required":[ + "UserName", + "SSHPublicKeyId" + ], + "members":{ + "UserName":{"shape":"userNameType"}, + "SSHPublicKeyId":{"shape":"publicKeyIdType"} + } + }, + "DeleteServerCertificateRequest":{ + "type":"structure", + "required":["ServerCertificateName"], + "members":{ + "ServerCertificateName":{"shape":"serverCertificateNameType"} + } + }, + "DeleteSigningCertificateRequest":{ + "type":"structure", + "required":["CertificateId"], + "members":{ + "UserName":{"shape":"existingUserNameType"}, + "CertificateId":{"shape":"certificateIdType"} + } + }, + "DeleteUserPolicyRequest":{ + "type":"structure", + "required":[ + "UserName", + "PolicyName" + ], + "members":{ + "UserName":{"shape":"existingUserNameType"}, + "PolicyName":{"shape":"policyNameType"} + } + }, + "DeleteUserRequest":{ + "type":"structure", + "required":["UserName"], + "members":{ + "UserName":{"shape":"existingUserNameType"} + } + }, + "DeleteVirtualMFADeviceRequest":{ + "type":"structure", + "required":["SerialNumber"], + "members":{ + "SerialNumber":{"shape":"serialNumberType"} + } + }, + "DetachGroupPolicyRequest":{ + "type":"structure", + "required":[ + "GroupName", + "PolicyArn" + ], + "members":{ + "GroupName":{"shape":"groupNameType"}, + "PolicyArn":{"shape":"arnType"} + } + }, + "DetachRolePolicyRequest":{ + "type":"structure", + "required":[ + "RoleName", + "PolicyArn" + ], + "members":{ + "RoleName":{"shape":"roleNameType"}, + "PolicyArn":{"shape":"arnType"} + } + }, + "DetachUserPolicyRequest":{ + "type":"structure", + "required":[ + "UserName", + "PolicyArn" + ], + "members":{ + "UserName":{"shape":"userNameType"}, + "PolicyArn":{"shape":"arnType"} + } + }, + "DuplicateCertificateException":{ + "type":"structure", + "members":{ + "message":{"shape":"duplicateCertificateMessage"} + }, + "error":{ + "code":"DuplicateCertificate", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + "DuplicateSSHPublicKeyException":{ + "type":"structure", + "members":{ + "message":{"shape":"duplicateSSHPublicKeyMessage"} + }, + "error":{ + "code":"DuplicateSSHPublicKey", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "EnableMFADeviceRequest":{ + "type":"structure", + "required":[ + "UserName", + "SerialNumber", + "AuthenticationCode1", + "AuthenticationCode2" + ], + "members":{ + "UserName":{"shape":"existingUserNameType"}, + "SerialNumber":{"shape":"serialNumberType"}, + "AuthenticationCode1":{"shape":"authenticationCodeType"}, + "AuthenticationCode2":{"shape":"authenticationCodeType"} + } + }, + "EntityAlreadyExistsException":{ + "type":"structure", + "members":{ + "message":{"shape":"entityAlreadyExistsMessage"} + }, + "error":{ + "code":"EntityAlreadyExists", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + "EntityTemporarilyUnmodifiableException":{ + "type":"structure", + "members":{ + "message":{"shape":"entityTemporarilyUnmodifiableMessage"} + }, + "error":{ + "code":"EntityTemporarilyUnmodifiable", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + "EntityType":{ + "type":"string", + "enum":[ + "User", + "Role", + "Group", + "LocalManagedPolicy", + "AWSManagedPolicy" + ] + }, + "EvalDecisionDetailsType":{ + "type":"map", + "key":{"shape":"EvalDecisionSourceType"}, + "value":{"shape":"PolicyEvaluationDecisionType"} + }, + "EvalDecisionSourceType":{ + "type":"string", + "max":256, + "min":3 + }, + "EvaluationResult":{ + "type":"structure", + "required":[ + "EvalActionName", + "EvalDecision" + ], + "members":{ + "EvalActionName":{"shape":"ActionNameType"}, + "EvalResourceName":{"shape":"ResourceNameType"}, + "EvalDecision":{"shape":"PolicyEvaluationDecisionType"}, + "MatchedStatements":{"shape":"StatementListType"}, + "MissingContextValues":{"shape":"ContextKeyNamesResultListType"}, + "EvalDecisionDetails":{"shape":"EvalDecisionDetailsType"}, + "ResourceSpecificResults":{"shape":"ResourceSpecificResultListType"} + } + }, + "EvaluationResultsListType":{ + "type":"list", + "member":{"shape":"EvaluationResult"} + }, + "GenerateCredentialReportResponse":{ + "type":"structure", + "members":{ + "State":{"shape":"ReportStateType"}, + "Description":{"shape":"ReportStateDescriptionType"} + } + }, + "GetAccessKeyLastUsedRequest":{ + "type":"structure", + "required":["AccessKeyId"], + "members":{ + "AccessKeyId":{"shape":"accessKeyIdType"} + } + }, + "GetAccessKeyLastUsedResponse":{ + "type":"structure", + "members":{ + "UserName":{"shape":"existingUserNameType"}, + "AccessKeyLastUsed":{"shape":"AccessKeyLastUsed"} + } + }, + "GetAccountAuthorizationDetailsRequest":{ + "type":"structure", + "members":{ + "Filter":{"shape":"entityListType"}, + "MaxItems":{"shape":"maxItemsType"}, + "Marker":{"shape":"markerType"} + } + }, + "GetAccountAuthorizationDetailsResponse":{ + "type":"structure", + "members":{ + "UserDetailList":{"shape":"userDetailListType"}, + "GroupDetailList":{"shape":"groupDetailListType"}, + "RoleDetailList":{"shape":"roleDetailListType"}, + "Policies":{"shape":"ManagedPolicyDetailListType"}, + "IsTruncated":{"shape":"booleanType"}, + "Marker":{"shape":"markerType"} + } + }, + "GetAccountPasswordPolicyResponse":{ + "type":"structure", + "required":["PasswordPolicy"], + "members":{ + "PasswordPolicy":{"shape":"PasswordPolicy"} + } + }, + "GetAccountSummaryResponse":{ + "type":"structure", + "members":{ + "SummaryMap":{"shape":"summaryMapType"} + } + }, + "GetContextKeysForCustomPolicyRequest":{ + "type":"structure", + "required":["PolicyInputList"], + "members":{ + "PolicyInputList":{"shape":"SimulationPolicyListType"} + } + }, + "GetContextKeysForPolicyResponse":{ + "type":"structure", + "members":{ + "ContextKeyNames":{"shape":"ContextKeyNamesResultListType"} + } + }, + "GetContextKeysForPrincipalPolicyRequest":{ + "type":"structure", + "required":["PolicySourceArn"], + "members":{ + "PolicySourceArn":{"shape":"arnType"}, + "PolicyInputList":{"shape":"SimulationPolicyListType"} + } + }, + "GetCredentialReportResponse":{ + "type":"structure", + "members":{ + "Content":{"shape":"ReportContentType"}, + "ReportFormat":{"shape":"ReportFormatType"}, + "GeneratedTime":{"shape":"dateType"} + } + }, + "GetGroupPolicyRequest":{ + "type":"structure", + "required":[ + "GroupName", + "PolicyName" + ], + "members":{ + "GroupName":{"shape":"groupNameType"}, + "PolicyName":{"shape":"policyNameType"} + } + }, + "GetGroupPolicyResponse":{ + "type":"structure", + "required":[ + "GroupName", + "PolicyName", + "PolicyDocument" + ], + "members":{ + "GroupName":{"shape":"groupNameType"}, + "PolicyName":{"shape":"policyNameType"}, + "PolicyDocument":{"shape":"policyDocumentType"} + } + }, + "GetGroupRequest":{ + "type":"structure", + "required":["GroupName"], + "members":{ + "GroupName":{"shape":"groupNameType"}, + "Marker":{"shape":"markerType"}, + "MaxItems":{"shape":"maxItemsType"} + } + }, + "GetGroupResponse":{ + "type":"structure", + "required":[ + "Group", + "Users" + ], + "members":{ + "Group":{"shape":"Group"}, + "Users":{"shape":"userListType"}, + "IsTruncated":{"shape":"booleanType"}, + "Marker":{"shape":"markerType"} + } + }, + "GetInstanceProfileRequest":{ + "type":"structure", + "required":["InstanceProfileName"], + "members":{ + "InstanceProfileName":{"shape":"instanceProfileNameType"} + } + }, + "GetInstanceProfileResponse":{ + "type":"structure", + "required":["InstanceProfile"], + "members":{ + "InstanceProfile":{"shape":"InstanceProfile"} + } + }, + "GetLoginProfileRequest":{ + "type":"structure", + "required":["UserName"], + "members":{ + "UserName":{"shape":"userNameType"} + } + }, + "GetLoginProfileResponse":{ + "type":"structure", + "required":["LoginProfile"], + "members":{ + "LoginProfile":{"shape":"LoginProfile"} + } + }, + "GetOpenIDConnectProviderRequest":{ + "type":"structure", + "required":["OpenIDConnectProviderArn"], + "members":{ + "OpenIDConnectProviderArn":{"shape":"arnType"} + } + }, + "GetOpenIDConnectProviderResponse":{ + "type":"structure", + "members":{ + "Url":{"shape":"OpenIDConnectProviderUrlType"}, + "ClientIDList":{"shape":"clientIDListType"}, + "ThumbprintList":{"shape":"thumbprintListType"}, + "CreateDate":{"shape":"dateType"} + } + }, + "GetPolicyRequest":{ + "type":"structure", + "required":["PolicyArn"], + "members":{ + "PolicyArn":{"shape":"arnType"} + } + }, + "GetPolicyResponse":{ + "type":"structure", + "members":{ + "Policy":{"shape":"Policy"} + } + }, + "GetPolicyVersionRequest":{ + "type":"structure", + "required":[ + "PolicyArn", + "VersionId" + ], + "members":{ + "PolicyArn":{"shape":"arnType"}, + "VersionId":{"shape":"policyVersionIdType"} + } + }, + "GetPolicyVersionResponse":{ + "type":"structure", + "members":{ + "PolicyVersion":{"shape":"PolicyVersion"} + } + }, + "GetRolePolicyRequest":{ + "type":"structure", + "required":[ + "RoleName", + "PolicyName" + ], + "members":{ + "RoleName":{"shape":"roleNameType"}, + "PolicyName":{"shape":"policyNameType"} + } + }, + "GetRolePolicyResponse":{ + "type":"structure", + "required":[ + "RoleName", + "PolicyName", + "PolicyDocument" + ], + "members":{ + "RoleName":{"shape":"roleNameType"}, + "PolicyName":{"shape":"policyNameType"}, + "PolicyDocument":{"shape":"policyDocumentType"} + } + }, + "GetRoleRequest":{ + "type":"structure", + "required":["RoleName"], + "members":{ + "RoleName":{"shape":"roleNameType"} + } + }, + "GetRoleResponse":{ + "type":"structure", + "required":["Role"], + "members":{ + "Role":{"shape":"Role"} + } + }, + "GetSAMLProviderRequest":{ + "type":"structure", + "required":["SAMLProviderArn"], + "members":{ + "SAMLProviderArn":{"shape":"arnType"} + } + }, + "GetSAMLProviderResponse":{ + "type":"structure", + "members":{ + "SAMLMetadataDocument":{"shape":"SAMLMetadataDocumentType"}, + "CreateDate":{"shape":"dateType"}, + "ValidUntil":{"shape":"dateType"} + } + }, + "GetSSHPublicKeyRequest":{ + "type":"structure", + "required":[ + "UserName", + "SSHPublicKeyId", + "Encoding" + ], + "members":{ + "UserName":{"shape":"userNameType"}, + "SSHPublicKeyId":{"shape":"publicKeyIdType"}, + "Encoding":{"shape":"encodingType"} + } + }, + "GetSSHPublicKeyResponse":{ + "type":"structure", + "members":{ + "SSHPublicKey":{"shape":"SSHPublicKey"} + } + }, + "GetServerCertificateRequest":{ + "type":"structure", + "required":["ServerCertificateName"], + "members":{ + "ServerCertificateName":{"shape":"serverCertificateNameType"} + } + }, + "GetServerCertificateResponse":{ + "type":"structure", + "required":["ServerCertificate"], + "members":{ + "ServerCertificate":{"shape":"ServerCertificate"} + } + }, + "GetUserPolicyRequest":{ + "type":"structure", + "required":[ + "UserName", + "PolicyName" + ], + "members":{ + "UserName":{"shape":"existingUserNameType"}, + "PolicyName":{"shape":"policyNameType"} + } + }, + "GetUserPolicyResponse":{ + "type":"structure", + "required":[ + "UserName", + "PolicyName", + "PolicyDocument" + ], + "members":{ + "UserName":{"shape":"existingUserNameType"}, + "PolicyName":{"shape":"policyNameType"}, + "PolicyDocument":{"shape":"policyDocumentType"} + } + }, + "GetUserRequest":{ + "type":"structure", + "members":{ + "UserName":{"shape":"existingUserNameType"} + } + }, + "GetUserResponse":{ + "type":"structure", + "required":["User"], + "members":{ + "User":{"shape":"User"} + } + }, + "Group":{ + "type":"structure", + "required":[ + "Path", + "GroupName", + "GroupId", + "Arn", + "CreateDate" + ], + "members":{ + "Path":{"shape":"pathType"}, + "GroupName":{"shape":"groupNameType"}, + "GroupId":{"shape":"idType"}, + "Arn":{"shape":"arnType"}, + "CreateDate":{"shape":"dateType"} + } + }, + "GroupDetail":{ + "type":"structure", + "members":{ + "Path":{"shape":"pathType"}, + "GroupName":{"shape":"groupNameType"}, + "GroupId":{"shape":"idType"}, + "Arn":{"shape":"arnType"}, + "CreateDate":{"shape":"dateType"}, + "GroupPolicyList":{"shape":"policyDetailListType"}, + "AttachedManagedPolicies":{"shape":"attachedPoliciesListType"} + } + }, + "InstanceProfile":{ + "type":"structure", + "required":[ + "Path", + "InstanceProfileName", + "InstanceProfileId", + "Arn", + "CreateDate", + "Roles" + ], + "members":{ + "Path":{"shape":"pathType"}, + "InstanceProfileName":{"shape":"instanceProfileNameType"}, + "InstanceProfileId":{"shape":"idType"}, + "Arn":{"shape":"arnType"}, + "CreateDate":{"shape":"dateType"}, + "Roles":{"shape":"roleListType"} + } + }, + "InvalidAuthenticationCodeException":{ + "type":"structure", + "members":{ + "message":{"shape":"invalidAuthenticationCodeMessage"} + }, + "error":{ + "code":"InvalidAuthenticationCode", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "InvalidCertificateException":{ + "type":"structure", + "members":{ + "message":{"shape":"invalidCertificateMessage"} + }, + "error":{ + "code":"InvalidCertificate", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidInputException":{ + "type":"structure", + "members":{ + "message":{"shape":"invalidInputMessage"} + }, + "error":{ + "code":"InvalidInput", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidPublicKeyException":{ + "type":"structure", + "members":{ + "message":{"shape":"invalidPublicKeyMessage"} + }, + "error":{ + "code":"InvalidPublicKey", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidUserTypeException":{ + "type":"structure", + "members":{ + "message":{"shape":"invalidUserTypeMessage"} + }, + "error":{ + "code":"InvalidUserType", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "KeyPairMismatchException":{ + "type":"structure", + "members":{ + "message":{"shape":"keyPairMismatchMessage"} + }, + "error":{ + "code":"KeyPairMismatch", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + "message":{"shape":"limitExceededMessage"} + }, + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + "LineNumber":{"type":"integer"}, + "ListAccessKeysRequest":{ + "type":"structure", + "members":{ + "UserName":{"shape":"existingUserNameType"}, + "Marker":{"shape":"markerType"}, + "MaxItems":{"shape":"maxItemsType"} + } + }, + "ListAccessKeysResponse":{ + "type":"structure", + "required":["AccessKeyMetadata"], + "members":{ + "AccessKeyMetadata":{"shape":"accessKeyMetadataListType"}, + "IsTruncated":{"shape":"booleanType"}, + "Marker":{"shape":"markerType"} + } + }, + "ListAccountAliasesRequest":{ + "type":"structure", + "members":{ + "Marker":{"shape":"markerType"}, + "MaxItems":{"shape":"maxItemsType"} + } + }, + "ListAccountAliasesResponse":{ + "type":"structure", + "required":["AccountAliases"], + "members":{ + "AccountAliases":{"shape":"accountAliasListType"}, + "IsTruncated":{"shape":"booleanType"}, + "Marker":{"shape":"markerType"} + } + }, + "ListAttachedGroupPoliciesRequest":{ + "type":"structure", + "required":["GroupName"], + "members":{ + "GroupName":{"shape":"groupNameType"}, + "PathPrefix":{"shape":"policyPathType"}, + "Marker":{"shape":"markerType"}, + "MaxItems":{"shape":"maxItemsType"} + } + }, + "ListAttachedGroupPoliciesResponse":{ + "type":"structure", + "members":{ + "AttachedPolicies":{"shape":"attachedPoliciesListType"}, + "IsTruncated":{"shape":"booleanType"}, + "Marker":{"shape":"markerType"} + } + }, + "ListAttachedRolePoliciesRequest":{ + "type":"structure", + "required":["RoleName"], + "members":{ + "RoleName":{"shape":"roleNameType"}, + "PathPrefix":{"shape":"policyPathType"}, + "Marker":{"shape":"markerType"}, + "MaxItems":{"shape":"maxItemsType"} + } + }, + "ListAttachedRolePoliciesResponse":{ + "type":"structure", + "members":{ + "AttachedPolicies":{"shape":"attachedPoliciesListType"}, + "IsTruncated":{"shape":"booleanType"}, + "Marker":{"shape":"markerType"} + } + }, + "ListAttachedUserPoliciesRequest":{ + "type":"structure", + "required":["UserName"], + "members":{ + "UserName":{"shape":"userNameType"}, + "PathPrefix":{"shape":"policyPathType"}, + "Marker":{"shape":"markerType"}, + "MaxItems":{"shape":"maxItemsType"} + } + }, + "ListAttachedUserPoliciesResponse":{ + "type":"structure", + "members":{ + "AttachedPolicies":{"shape":"attachedPoliciesListType"}, + "IsTruncated":{"shape":"booleanType"}, + "Marker":{"shape":"markerType"} + } + }, + "ListEntitiesForPolicyRequest":{ + "type":"structure", + "required":["PolicyArn"], + "members":{ + "PolicyArn":{"shape":"arnType"}, + "EntityFilter":{"shape":"EntityType"}, + "PathPrefix":{"shape":"pathType"}, + "Marker":{"shape":"markerType"}, + "MaxItems":{"shape":"maxItemsType"} + } + }, + "ListEntitiesForPolicyResponse":{ + "type":"structure", + "members":{ + "PolicyGroups":{"shape":"PolicyGroupListType"}, + "PolicyUsers":{"shape":"PolicyUserListType"}, + "PolicyRoles":{"shape":"PolicyRoleListType"}, + "IsTruncated":{"shape":"booleanType"}, + "Marker":{"shape":"markerType"} + } + }, + "ListGroupPoliciesRequest":{ + "type":"structure", + "required":["GroupName"], + "members":{ + "GroupName":{"shape":"groupNameType"}, + "Marker":{"shape":"markerType"}, + "MaxItems":{"shape":"maxItemsType"} + } + }, + "ListGroupPoliciesResponse":{ + "type":"structure", + "required":["PolicyNames"], + "members":{ + "PolicyNames":{"shape":"policyNameListType"}, + "IsTruncated":{"shape":"booleanType"}, + "Marker":{"shape":"markerType"} + } + }, + "ListGroupsForUserRequest":{ + "type":"structure", + "required":["UserName"], + "members":{ + "UserName":{"shape":"existingUserNameType"}, + "Marker":{"shape":"markerType"}, + "MaxItems":{"shape":"maxItemsType"} + } + }, + "ListGroupsForUserResponse":{ + "type":"structure", + "required":["Groups"], + "members":{ + "Groups":{"shape":"groupListType"}, + "IsTruncated":{"shape":"booleanType"}, + "Marker":{"shape":"markerType"} + } + }, + "ListGroupsRequest":{ + "type":"structure", + "members":{ + "PathPrefix":{"shape":"pathPrefixType"}, + "Marker":{"shape":"markerType"}, + "MaxItems":{"shape":"maxItemsType"} + } + }, + "ListGroupsResponse":{ + "type":"structure", + "required":["Groups"], + "members":{ + "Groups":{"shape":"groupListType"}, + "IsTruncated":{"shape":"booleanType"}, + "Marker":{"shape":"markerType"} + } + }, + "ListInstanceProfilesForRoleRequest":{ + "type":"structure", + "required":["RoleName"], + "members":{ + "RoleName":{"shape":"roleNameType"}, + "Marker":{"shape":"markerType"}, + "MaxItems":{"shape":"maxItemsType"} + } + }, + "ListInstanceProfilesForRoleResponse":{ + "type":"structure", + "required":["InstanceProfiles"], + "members":{ + "InstanceProfiles":{"shape":"instanceProfileListType"}, + "IsTruncated":{"shape":"booleanType"}, + "Marker":{"shape":"markerType"} + } + }, + "ListInstanceProfilesRequest":{ + "type":"structure", + "members":{ + "PathPrefix":{"shape":"pathPrefixType"}, + "Marker":{"shape":"markerType"}, + "MaxItems":{"shape":"maxItemsType"} + } + }, + "ListInstanceProfilesResponse":{ + "type":"structure", + "required":["InstanceProfiles"], + "members":{ + "InstanceProfiles":{"shape":"instanceProfileListType"}, + "IsTruncated":{"shape":"booleanType"}, + "Marker":{"shape":"markerType"} + } + }, + "ListMFADevicesRequest":{ + "type":"structure", + "members":{ + "UserName":{"shape":"existingUserNameType"}, + "Marker":{"shape":"markerType"}, + "MaxItems":{"shape":"maxItemsType"} + } + }, + "ListMFADevicesResponse":{ + "type":"structure", + "required":["MFADevices"], + "members":{ + "MFADevices":{"shape":"mfaDeviceListType"}, + "IsTruncated":{"shape":"booleanType"}, + "Marker":{"shape":"markerType"} + } + }, + "ListOpenIDConnectProvidersRequest":{ + "type":"structure", + "members":{ + } + }, + "ListOpenIDConnectProvidersResponse":{ + "type":"structure", + "members":{ + "OpenIDConnectProviderList":{"shape":"OpenIDConnectProviderListType"} + } + }, + "ListPoliciesRequest":{ + "type":"structure", + "members":{ + "Scope":{"shape":"policyScopeType"}, + "OnlyAttached":{"shape":"booleanType"}, + "PathPrefix":{"shape":"policyPathType"}, + "Marker":{"shape":"markerType"}, + "MaxItems":{"shape":"maxItemsType"} + } + }, + "ListPoliciesResponse":{ + "type":"structure", + "members":{ + "Policies":{"shape":"policyListType"}, + "IsTruncated":{"shape":"booleanType"}, + "Marker":{"shape":"markerType"} + } + }, + "ListPolicyVersionsRequest":{ + "type":"structure", + "required":["PolicyArn"], + "members":{ + "PolicyArn":{"shape":"arnType"}, + "Marker":{"shape":"markerType"}, + "MaxItems":{"shape":"maxItemsType"} + } + }, + "ListPolicyVersionsResponse":{ + "type":"structure", + "members":{ + "Versions":{"shape":"policyDocumentVersionListType"}, + "IsTruncated":{"shape":"booleanType"}, + "Marker":{"shape":"markerType"} + } + }, + "ListRolePoliciesRequest":{ + "type":"structure", + "required":["RoleName"], + "members":{ + "RoleName":{"shape":"roleNameType"}, + "Marker":{"shape":"markerType"}, + "MaxItems":{"shape":"maxItemsType"} + } + }, + "ListRolePoliciesResponse":{ + "type":"structure", + "required":["PolicyNames"], + "members":{ + "PolicyNames":{"shape":"policyNameListType"}, + "IsTruncated":{"shape":"booleanType"}, + "Marker":{"shape":"markerType"} + } + }, + "ListRolesRequest":{ + "type":"structure", + "members":{ + "PathPrefix":{"shape":"pathPrefixType"}, + "Marker":{"shape":"markerType"}, + "MaxItems":{"shape":"maxItemsType"} + } + }, + "ListRolesResponse":{ + "type":"structure", + "required":["Roles"], + "members":{ + "Roles":{"shape":"roleListType"}, + "IsTruncated":{"shape":"booleanType"}, + "Marker":{"shape":"markerType"} + } + }, + "ListSAMLProvidersRequest":{ + "type":"structure", + "members":{ + } + }, + "ListSAMLProvidersResponse":{ + "type":"structure", + "members":{ + "SAMLProviderList":{"shape":"SAMLProviderListType"} + } + }, + "ListSSHPublicKeysRequest":{ + "type":"structure", + "members":{ + "UserName":{"shape":"userNameType"}, + "Marker":{"shape":"markerType"}, + "MaxItems":{"shape":"maxItemsType"} + } + }, + "ListSSHPublicKeysResponse":{ + "type":"structure", + "members":{ + "SSHPublicKeys":{"shape":"SSHPublicKeyListType"}, + "IsTruncated":{"shape":"booleanType"}, + "Marker":{"shape":"markerType"} + } + }, + "ListServerCertificatesRequest":{ + "type":"structure", + "members":{ + "PathPrefix":{"shape":"pathPrefixType"}, + "Marker":{"shape":"markerType"}, + "MaxItems":{"shape":"maxItemsType"} + } + }, + "ListServerCertificatesResponse":{ + "type":"structure", + "required":["ServerCertificateMetadataList"], + "members":{ + "ServerCertificateMetadataList":{"shape":"serverCertificateMetadataListType"}, + "IsTruncated":{"shape":"booleanType"}, + "Marker":{"shape":"markerType"} + } + }, + "ListSigningCertificatesRequest":{ + "type":"structure", + "members":{ + "UserName":{"shape":"existingUserNameType"}, + "Marker":{"shape":"markerType"}, + "MaxItems":{"shape":"maxItemsType"} + } + }, + "ListSigningCertificatesResponse":{ + "type":"structure", + "required":["Certificates"], + "members":{ + "Certificates":{"shape":"certificateListType"}, + "IsTruncated":{"shape":"booleanType"}, + "Marker":{"shape":"markerType"} + } + }, + "ListUserPoliciesRequest":{ + "type":"structure", + "required":["UserName"], + "members":{ + "UserName":{"shape":"existingUserNameType"}, + "Marker":{"shape":"markerType"}, + "MaxItems":{"shape":"maxItemsType"} + } + }, + "ListUserPoliciesResponse":{ + "type":"structure", + "required":["PolicyNames"], + "members":{ + "PolicyNames":{"shape":"policyNameListType"}, + "IsTruncated":{"shape":"booleanType"}, + "Marker":{"shape":"markerType"} + } + }, + "ListUsersRequest":{ + "type":"structure", + "members":{ + "PathPrefix":{"shape":"pathPrefixType"}, + "Marker":{"shape":"markerType"}, + "MaxItems":{"shape":"maxItemsType"} + } + }, + "ListUsersResponse":{ + "type":"structure", + "required":["Users"], + "members":{ + "Users":{"shape":"userListType"}, + "IsTruncated":{"shape":"booleanType"}, + "Marker":{"shape":"markerType"} + } + }, + "ListVirtualMFADevicesRequest":{ + "type":"structure", + "members":{ + "AssignmentStatus":{"shape":"assignmentStatusType"}, + "Marker":{"shape":"markerType"}, + "MaxItems":{"shape":"maxItemsType"} + } + }, + "ListVirtualMFADevicesResponse":{ + "type":"structure", + "required":["VirtualMFADevices"], + "members":{ + "VirtualMFADevices":{"shape":"virtualMFADeviceListType"}, + "IsTruncated":{"shape":"booleanType"}, + "Marker":{"shape":"markerType"} + } + }, + "LoginProfile":{ + "type":"structure", + "required":[ + "UserName", + "CreateDate" + ], + "members":{ + "UserName":{"shape":"userNameType"}, + "CreateDate":{"shape":"dateType"}, + "PasswordResetRequired":{"shape":"booleanType"} + } + }, + "MFADevice":{ + "type":"structure", + "required":[ + "UserName", + "SerialNumber", + "EnableDate" + ], + "members":{ + "UserName":{"shape":"userNameType"}, + "SerialNumber":{"shape":"serialNumberType"}, + "EnableDate":{"shape":"dateType"} + } + }, + "MalformedCertificateException":{ + "type":"structure", + "members":{ + "message":{"shape":"malformedCertificateMessage"} + }, + "error":{ + "code":"MalformedCertificate", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "MalformedPolicyDocumentException":{ + "type":"structure", + "members":{ + "message":{"shape":"malformedPolicyDocumentMessage"} + }, + "error":{ + "code":"MalformedPolicyDocument", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ManagedPolicyDetail":{ + "type":"structure", + "members":{ + "PolicyName":{"shape":"policyNameType"}, + "PolicyId":{"shape":"idType"}, + "Arn":{"shape":"arnType"}, + "Path":{"shape":"policyPathType"}, + "DefaultVersionId":{"shape":"policyVersionIdType"}, + "AttachmentCount":{"shape":"attachmentCountType"}, + "IsAttachable":{"shape":"booleanType"}, + "Description":{"shape":"policyDescriptionType"}, + "CreateDate":{"shape":"dateType"}, + "UpdateDate":{"shape":"dateType"}, + "PolicyVersionList":{"shape":"policyDocumentVersionListType"} + } + }, + "ManagedPolicyDetailListType":{ + "type":"list", + "member":{"shape":"ManagedPolicyDetail"} + }, + "NoSuchEntityException":{ + "type":"structure", + "members":{ + "message":{"shape":"noSuchEntityMessage"} + }, + "error":{ + "code":"NoSuchEntity", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "OpenIDConnectProviderListEntry":{ + "type":"structure", + "members":{ + "Arn":{"shape":"arnType"} + } + }, + "OpenIDConnectProviderListType":{ + "type":"list", + "member":{"shape":"OpenIDConnectProviderListEntry"} + }, + "OpenIDConnectProviderUrlType":{ + "type":"string", + "max":255, + "min":1 + }, + "PasswordPolicy":{ + "type":"structure", + "members":{ + "MinimumPasswordLength":{"shape":"minimumPasswordLengthType"}, + "RequireSymbols":{"shape":"booleanType"}, + "RequireNumbers":{"shape":"booleanType"}, + "RequireUppercaseCharacters":{"shape":"booleanType"}, + "RequireLowercaseCharacters":{"shape":"booleanType"}, + "AllowUsersToChangePassword":{"shape":"booleanType"}, + "ExpirePasswords":{"shape":"booleanType"}, + "MaxPasswordAge":{"shape":"maxPasswordAgeType"}, + "PasswordReusePrevention":{"shape":"passwordReusePreventionType"}, + "HardExpiry":{"shape":"booleanObjectType"} + } + }, + "PasswordPolicyViolationException":{ + "type":"structure", + "members":{ + "message":{"shape":"passwordPolicyViolationMessage"} + }, + "error":{ + "code":"PasswordPolicyViolation", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "Policy":{ + "type":"structure", + "members":{ + "PolicyName":{"shape":"policyNameType"}, + "PolicyId":{"shape":"idType"}, + "Arn":{"shape":"arnType"}, + "Path":{"shape":"policyPathType"}, + "DefaultVersionId":{"shape":"policyVersionIdType"}, + "AttachmentCount":{"shape":"attachmentCountType"}, + "IsAttachable":{"shape":"booleanType"}, + "Description":{"shape":"policyDescriptionType"}, + "CreateDate":{"shape":"dateType"}, + "UpdateDate":{"shape":"dateType"} + } + }, + "PolicyDetail":{ + "type":"structure", + "members":{ + "PolicyName":{"shape":"policyNameType"}, + "PolicyDocument":{"shape":"policyDocumentType"} + } + }, + "PolicyEvaluationDecisionType":{ + "type":"string", + "enum":[ + "allowed", + "explicitDeny", + "implicitDeny" + ] + }, + "PolicyEvaluationException":{ + "type":"structure", + "members":{ + "message":{"shape":"policyEvaluationErrorMessage"} + }, + "error":{ + "code":"PolicyEvaluation", + "httpStatusCode":500 + }, + "exception":true + }, + "PolicyGroup":{ + "type":"structure", + "members":{ + "GroupName":{"shape":"groupNameType"}, + "GroupId":{"shape":"idType"} + } + }, + "PolicyGroupListType":{ + "type":"list", + "member":{"shape":"PolicyGroup"} + }, + "PolicyIdentifierType":{"type":"string"}, + "PolicyRole":{ + "type":"structure", + "members":{ + "RoleName":{"shape":"roleNameType"}, + "RoleId":{"shape":"idType"} + } + }, + "PolicyRoleListType":{ + "type":"list", + "member":{"shape":"PolicyRole"} + }, + "PolicySourceType":{ + "type":"string", + "enum":[ + "user", + "group", + "role", + "aws-managed", + "user-managed", + "resource", + "none" + ] + }, + "PolicyUser":{ + "type":"structure", + "members":{ + "UserName":{"shape":"userNameType"}, + "UserId":{"shape":"idType"} + } + }, + "PolicyUserListType":{ + "type":"list", + "member":{"shape":"PolicyUser"} + }, + "PolicyVersion":{ + "type":"structure", + "members":{ + "Document":{"shape":"policyDocumentType"}, + "VersionId":{"shape":"policyVersionIdType"}, + "IsDefaultVersion":{"shape":"booleanType"}, + "CreateDate":{"shape":"dateType"} + } + }, + "Position":{ + "type":"structure", + "members":{ + "Line":{"shape":"LineNumber"}, + "Column":{"shape":"ColumnNumber"} + } + }, + "PutGroupPolicyRequest":{ + "type":"structure", + "required":[ + "GroupName", + "PolicyName", + "PolicyDocument" + ], + "members":{ + "GroupName":{"shape":"groupNameType"}, + "PolicyName":{"shape":"policyNameType"}, + "PolicyDocument":{"shape":"policyDocumentType"} + } + }, + "PutRolePolicyRequest":{ + "type":"structure", + "required":[ + "RoleName", + "PolicyName", + "PolicyDocument" + ], + "members":{ + "RoleName":{"shape":"roleNameType"}, + "PolicyName":{"shape":"policyNameType"}, + "PolicyDocument":{"shape":"policyDocumentType"} + } + }, + "PutUserPolicyRequest":{ + "type":"structure", + "required":[ + "UserName", + "PolicyName", + "PolicyDocument" + ], + "members":{ + "UserName":{"shape":"existingUserNameType"}, + "PolicyName":{"shape":"policyNameType"}, + "PolicyDocument":{"shape":"policyDocumentType"} + } + }, + "RemoveClientIDFromOpenIDConnectProviderRequest":{ + "type":"structure", + "required":[ + "OpenIDConnectProviderArn", + "ClientID" + ], + "members":{ + "OpenIDConnectProviderArn":{"shape":"arnType"}, + "ClientID":{"shape":"clientIDType"} + } + }, + "RemoveRoleFromInstanceProfileRequest":{ + "type":"structure", + "required":[ + "InstanceProfileName", + "RoleName" + ], + "members":{ + "InstanceProfileName":{"shape":"instanceProfileNameType"}, + "RoleName":{"shape":"roleNameType"} + } + }, + "RemoveUserFromGroupRequest":{ + "type":"structure", + "required":[ + "GroupName", + "UserName" + ], + "members":{ + "GroupName":{"shape":"groupNameType"}, + "UserName":{"shape":"existingUserNameType"} + } + }, + "ReportContentType":{"type":"blob"}, + "ReportFormatType":{ + "type":"string", + "enum":["text/csv"] + }, + "ReportStateDescriptionType":{"type":"string"}, + "ReportStateType":{ + "type":"string", + "enum":[ + "STARTED", + "INPROGRESS", + "COMPLETE" + ] + }, + "ResourceHandlingOptionType":{ + "type":"string", + "max":64, + "min":1 + }, + "ResourceNameListType":{ + "type":"list", + "member":{"shape":"ResourceNameType"} + }, + "ResourceNameType":{ + "type":"string", + "max":2048, + "min":1 + }, + "ResourceSpecificResult":{ + "type":"structure", + "required":[ + "EvalResourceName", + "EvalResourceDecision" + ], + "members":{ + "EvalResourceName":{"shape":"ResourceNameType"}, + "EvalResourceDecision":{"shape":"PolicyEvaluationDecisionType"}, + "MatchedStatements":{"shape":"StatementListType"}, + "MissingContextValues":{"shape":"ContextKeyNamesResultListType"}, + "EvalDecisionDetails":{"shape":"EvalDecisionDetailsType"} + } + }, + "ResourceSpecificResultListType":{ + "type":"list", + "member":{"shape":"ResourceSpecificResult"} + }, + "ResyncMFADeviceRequest":{ + "type":"structure", + "required":[ + "UserName", + "SerialNumber", + "AuthenticationCode1", + "AuthenticationCode2" + ], + "members":{ + "UserName":{"shape":"existingUserNameType"}, + "SerialNumber":{"shape":"serialNumberType"}, + "AuthenticationCode1":{"shape":"authenticationCodeType"}, + "AuthenticationCode2":{"shape":"authenticationCodeType"} + } + }, + "Role":{ + "type":"structure", + "required":[ + "Path", + "RoleName", + "RoleId", + "Arn", + "CreateDate" + ], + "members":{ + "Path":{"shape":"pathType"}, + "RoleName":{"shape":"roleNameType"}, + "RoleId":{"shape":"idType"}, + "Arn":{"shape":"arnType"}, + "CreateDate":{"shape":"dateType"}, + "AssumeRolePolicyDocument":{"shape":"policyDocumentType"} + } + }, + "RoleDetail":{ + "type":"structure", + "members":{ + "Path":{"shape":"pathType"}, + "RoleName":{"shape":"roleNameType"}, + "RoleId":{"shape":"idType"}, + "Arn":{"shape":"arnType"}, + "CreateDate":{"shape":"dateType"}, + "AssumeRolePolicyDocument":{"shape":"policyDocumentType"}, + "InstanceProfileList":{"shape":"instanceProfileListType"}, + "RolePolicyList":{"shape":"policyDetailListType"}, + "AttachedManagedPolicies":{"shape":"attachedPoliciesListType"} + } + }, + "SAMLMetadataDocumentType":{ + "type":"string", + "max":10000000, + "min":1000 + }, + "SAMLProviderListEntry":{ + "type":"structure", + "members":{ + "Arn":{"shape":"arnType"}, + "ValidUntil":{"shape":"dateType"}, + "CreateDate":{"shape":"dateType"} + } + }, + "SAMLProviderListType":{ + "type":"list", + "member":{"shape":"SAMLProviderListEntry"} + }, + "SAMLProviderNameType":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[\\w._-]+" + }, + "SSHPublicKey":{ + "type":"structure", + "required":[ + "UserName", + "SSHPublicKeyId", + "Fingerprint", + "SSHPublicKeyBody", + "Status" + ], + "members":{ + "UserName":{"shape":"userNameType"}, + "SSHPublicKeyId":{"shape":"publicKeyIdType"}, + "Fingerprint":{"shape":"publicKeyFingerprintType"}, + "SSHPublicKeyBody":{"shape":"publicKeyMaterialType"}, + "Status":{"shape":"statusType"}, + "UploadDate":{"shape":"dateType"} + } + }, + "SSHPublicKeyListType":{ + "type":"list", + "member":{"shape":"SSHPublicKeyMetadata"} + }, + "SSHPublicKeyMetadata":{ + "type":"structure", + "required":[ + "UserName", + "SSHPublicKeyId", + "Status", + "UploadDate" + ], + "members":{ + "UserName":{"shape":"userNameType"}, + "SSHPublicKeyId":{"shape":"publicKeyIdType"}, + "Status":{"shape":"statusType"}, + "UploadDate":{"shape":"dateType"} + } + }, + "ServerCertificate":{ + "type":"structure", + "required":[ + "ServerCertificateMetadata", + "CertificateBody" + ], + "members":{ + "ServerCertificateMetadata":{"shape":"ServerCertificateMetadata"}, + "CertificateBody":{"shape":"certificateBodyType"}, + "CertificateChain":{"shape":"certificateChainType"} + } + }, + "ServerCertificateMetadata":{ + "type":"structure", + "required":[ + "Path", + "ServerCertificateName", + "ServerCertificateId", + "Arn" + ], + "members":{ + "Path":{"shape":"pathType"}, + "ServerCertificateName":{"shape":"serverCertificateNameType"}, + "ServerCertificateId":{"shape":"idType"}, + "Arn":{"shape":"arnType"}, + "UploadDate":{"shape":"dateType"}, + "Expiration":{"shape":"dateType"} + } + }, + "ServiceFailureException":{ + "type":"structure", + "members":{ + "message":{"shape":"serviceFailureExceptionMessage"} + }, + "error":{ + "code":"ServiceFailure", + "httpStatusCode":500 + }, + "exception":true + }, + "SetDefaultPolicyVersionRequest":{ + "type":"structure", + "required":[ + "PolicyArn", + "VersionId" + ], + "members":{ + "PolicyArn":{"shape":"arnType"}, + "VersionId":{"shape":"policyVersionIdType"} + } + }, + "SigningCertificate":{ + "type":"structure", + "required":[ + "UserName", + "CertificateId", + "CertificateBody", + "Status" + ], + "members":{ + "UserName":{"shape":"userNameType"}, + "CertificateId":{"shape":"certificateIdType"}, + "CertificateBody":{"shape":"certificateBodyType"}, + "Status":{"shape":"statusType"}, + "UploadDate":{"shape":"dateType"} + } + }, + "SimulateCustomPolicyRequest":{ + "type":"structure", + "required":[ + "PolicyInputList", + "ActionNames" + ], + "members":{ + "PolicyInputList":{"shape":"SimulationPolicyListType"}, + "ActionNames":{"shape":"ActionNameListType"}, + "ResourceArns":{"shape":"ResourceNameListType"}, + "ResourcePolicy":{"shape":"policyDocumentType"}, + "ResourceOwner":{"shape":"ResourceNameType"}, + "CallerArn":{"shape":"ResourceNameType"}, + "ContextEntries":{"shape":"ContextEntryListType"}, + "ResourceHandlingOption":{"shape":"ResourceHandlingOptionType"}, + "MaxItems":{"shape":"maxItemsType"}, + "Marker":{"shape":"markerType"} + } + }, + "SimulatePolicyResponse":{ + "type":"structure", + "members":{ + "EvaluationResults":{"shape":"EvaluationResultsListType"}, + "IsTruncated":{"shape":"booleanType"}, + "Marker":{"shape":"markerType"} + } + }, + "SimulatePrincipalPolicyRequest":{ + "type":"structure", + "required":[ + "PolicySourceArn", + "ActionNames" + ], + "members":{ + "PolicySourceArn":{"shape":"arnType"}, + "PolicyInputList":{"shape":"SimulationPolicyListType"}, + "ActionNames":{"shape":"ActionNameListType"}, + "ResourceArns":{"shape":"ResourceNameListType"}, + "ResourcePolicy":{"shape":"policyDocumentType"}, + "ResourceOwner":{"shape":"ResourceNameType"}, + "CallerArn":{"shape":"ResourceNameType"}, + "ContextEntries":{"shape":"ContextEntryListType"}, + "ResourceHandlingOption":{"shape":"ResourceHandlingOptionType"}, + "MaxItems":{"shape":"maxItemsType"}, + "Marker":{"shape":"markerType"} + } + }, + "SimulationPolicyListType":{ + "type":"list", + "member":{"shape":"policyDocumentType"} + }, + "Statement":{ + "type":"structure", + "members":{ + "SourcePolicyId":{"shape":"PolicyIdentifierType"}, + "SourcePolicyType":{"shape":"PolicySourceType"}, + "StartPosition":{"shape":"Position"}, + "EndPosition":{"shape":"Position"} + } + }, + "StatementListType":{ + "type":"list", + "member":{"shape":"Statement"} + }, + "UnrecognizedPublicKeyEncodingException":{ + "type":"structure", + "members":{ + "message":{"shape":"unrecognizedPublicKeyEncodingMessage"} + }, + "error":{ + "code":"UnrecognizedPublicKeyEncoding", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "UpdateAccessKeyRequest":{ + "type":"structure", + "required":[ + "AccessKeyId", + "Status" + ], + "members":{ + "UserName":{"shape":"existingUserNameType"}, + "AccessKeyId":{"shape":"accessKeyIdType"}, + "Status":{"shape":"statusType"} + } + }, + "UpdateAccountPasswordPolicyRequest":{ + "type":"structure", + "members":{ + "MinimumPasswordLength":{"shape":"minimumPasswordLengthType"}, + "RequireSymbols":{"shape":"booleanType"}, + "RequireNumbers":{"shape":"booleanType"}, + "RequireUppercaseCharacters":{"shape":"booleanType"}, + "RequireLowercaseCharacters":{"shape":"booleanType"}, + "AllowUsersToChangePassword":{"shape":"booleanType"}, + "MaxPasswordAge":{"shape":"maxPasswordAgeType"}, + "PasswordReusePrevention":{"shape":"passwordReusePreventionType"}, + "HardExpiry":{"shape":"booleanObjectType"} + } + }, + "UpdateAssumeRolePolicyRequest":{ + "type":"structure", + "required":[ + "RoleName", + "PolicyDocument" + ], + "members":{ + "RoleName":{"shape":"roleNameType"}, + "PolicyDocument":{"shape":"policyDocumentType"} + } + }, + "UpdateGroupRequest":{ + "type":"structure", + "required":["GroupName"], + "members":{ + "GroupName":{"shape":"groupNameType"}, + "NewPath":{"shape":"pathType"}, + "NewGroupName":{"shape":"groupNameType"} + } + }, + "UpdateLoginProfileRequest":{ + "type":"structure", + "required":["UserName"], + "members":{ + "UserName":{"shape":"userNameType"}, + "Password":{"shape":"passwordType"}, + "PasswordResetRequired":{"shape":"booleanObjectType"} + } + }, + "UpdateOpenIDConnectProviderThumbprintRequest":{ + "type":"structure", + "required":[ + "OpenIDConnectProviderArn", + "ThumbprintList" + ], + "members":{ + "OpenIDConnectProviderArn":{"shape":"arnType"}, + "ThumbprintList":{"shape":"thumbprintListType"} + } + }, + "UpdateSAMLProviderRequest":{ + "type":"structure", + "required":[ + "SAMLMetadataDocument", + "SAMLProviderArn" + ], + "members":{ + "SAMLMetadataDocument":{"shape":"SAMLMetadataDocumentType"}, + "SAMLProviderArn":{"shape":"arnType"} + } + }, + "UpdateSAMLProviderResponse":{ + "type":"structure", + "members":{ + "SAMLProviderArn":{"shape":"arnType"} + } + }, + "UpdateSSHPublicKeyRequest":{ + "type":"structure", + "required":[ + "UserName", + "SSHPublicKeyId", + "Status" + ], + "members":{ + "UserName":{"shape":"userNameType"}, + "SSHPublicKeyId":{"shape":"publicKeyIdType"}, + "Status":{"shape":"statusType"} + } + }, + "UpdateServerCertificateRequest":{ + "type":"structure", + "required":["ServerCertificateName"], + "members":{ + "ServerCertificateName":{"shape":"serverCertificateNameType"}, + "NewPath":{"shape":"pathType"}, + "NewServerCertificateName":{"shape":"serverCertificateNameType"} + } + }, + "UpdateSigningCertificateRequest":{ + "type":"structure", + "required":[ + "CertificateId", + "Status" + ], + "members":{ + "UserName":{"shape":"existingUserNameType"}, + "CertificateId":{"shape":"certificateIdType"}, + "Status":{"shape":"statusType"} + } + }, + "UpdateUserRequest":{ + "type":"structure", + "required":["UserName"], + "members":{ + "UserName":{"shape":"existingUserNameType"}, + "NewPath":{"shape":"pathType"}, + "NewUserName":{"shape":"userNameType"} + } + }, + "UploadSSHPublicKeyRequest":{ + "type":"structure", + "required":[ + "UserName", + "SSHPublicKeyBody" + ], + "members":{ + "UserName":{"shape":"userNameType"}, + "SSHPublicKeyBody":{"shape":"publicKeyMaterialType"} + } + }, + "UploadSSHPublicKeyResponse":{ + "type":"structure", + "members":{ + "SSHPublicKey":{"shape":"SSHPublicKey"} + } + }, + "UploadServerCertificateRequest":{ + "type":"structure", + "required":[ + "ServerCertificateName", + "CertificateBody", + "PrivateKey" + ], + "members":{ + "Path":{"shape":"pathType"}, + "ServerCertificateName":{"shape":"serverCertificateNameType"}, + "CertificateBody":{"shape":"certificateBodyType"}, + "PrivateKey":{"shape":"privateKeyType"}, + "CertificateChain":{"shape":"certificateChainType"} + } + }, + "UploadServerCertificateResponse":{ + "type":"structure", + "members":{ + "ServerCertificateMetadata":{"shape":"ServerCertificateMetadata"} + } + }, + "UploadSigningCertificateRequest":{ + "type":"structure", + "required":["CertificateBody"], + "members":{ + "UserName":{"shape":"existingUserNameType"}, + "CertificateBody":{"shape":"certificateBodyType"} + } + }, + "UploadSigningCertificateResponse":{ + "type":"structure", + "required":["Certificate"], + "members":{ + "Certificate":{"shape":"SigningCertificate"} + } + }, + "User":{ + "type":"structure", + "required":[ + "Path", + "UserName", + "UserId", + "Arn", + "CreateDate" + ], + "members":{ + "Path":{"shape":"pathType"}, + "UserName":{"shape":"userNameType"}, + "UserId":{"shape":"idType"}, + "Arn":{"shape":"arnType"}, + "CreateDate":{"shape":"dateType"}, + "PasswordLastUsed":{"shape":"dateType"} + } + }, + "UserDetail":{ + "type":"structure", + "members":{ + "Path":{"shape":"pathType"}, + "UserName":{"shape":"userNameType"}, + "UserId":{"shape":"idType"}, + "Arn":{"shape":"arnType"}, + "CreateDate":{"shape":"dateType"}, + "UserPolicyList":{"shape":"policyDetailListType"}, + "GroupList":{"shape":"groupNameListType"}, + "AttachedManagedPolicies":{"shape":"attachedPoliciesListType"} + } + }, + "VirtualMFADevice":{ + "type":"structure", + "required":["SerialNumber"], + "members":{ + "SerialNumber":{"shape":"serialNumberType"}, + "Base32StringSeed":{"shape":"BootstrapDatum"}, + "QRCodePNG":{"shape":"BootstrapDatum"}, + "User":{"shape":"User"}, + "EnableDate":{"shape":"dateType"} + } + }, + "accessKeyIdType":{ + "type":"string", + "max":32, + "min":16, + "pattern":"[\\w]+" + }, + "accessKeyMetadataListType":{ + "type":"list", + "member":{"shape":"AccessKeyMetadata"} + }, + "accessKeySecretType":{ + "type":"string", + "sensitive":true + }, + "accountAliasListType":{ + "type":"list", + "member":{"shape":"accountAliasType"} + }, + "accountAliasType":{ + "type":"string", + "max":63, + "min":3, + "pattern":"^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$" + }, + "arnType":{ + "type":"string", + "max":2048, + "min":20 + }, + "assignmentStatusType":{ + "type":"string", + "enum":[ + "Assigned", + "Unassigned", + "Any" + ] + }, + "attachedPoliciesListType":{ + "type":"list", + "member":{"shape":"AttachedPolicy"} + }, + "attachmentCountType":{"type":"integer"}, + "authenticationCodeType":{ + "type":"string", + "max":6, + "min":6, + "pattern":"[\\d]+" + }, + "booleanObjectType":{ + "type":"boolean", + "box":true + }, + "booleanType":{"type":"boolean"}, + "certificateBodyType":{ + "type":"string", + "max":16384, + "min":1, + "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+" + }, + "certificateChainType":{ + "type":"string", + "max":2097152, + "min":1, + "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+" + }, + "certificateIdType":{ + "type":"string", + "max":128, + "min":24, + "pattern":"[\\w]+" + }, + "certificateListType":{ + "type":"list", + "member":{"shape":"SigningCertificate"} + }, + "clientIDListType":{ + "type":"list", + "member":{"shape":"clientIDType"} + }, + "clientIDType":{ + "type":"string", + "max":255, + "min":1 + }, + "credentialReportExpiredExceptionMessage":{"type":"string"}, + "credentialReportNotPresentExceptionMessage":{"type":"string"}, + "credentialReportNotReadyExceptionMessage":{"type":"string"}, + "dateType":{"type":"timestamp"}, + "deleteConflictMessage":{"type":"string"}, + "duplicateCertificateMessage":{"type":"string"}, + "duplicateSSHPublicKeyMessage":{"type":"string"}, + "encodingType":{ + "type":"string", + "enum":[ + "SSH", + "PEM" + ] + }, + "entityAlreadyExistsMessage":{"type":"string"}, + "entityListType":{ + "type":"list", + "member":{"shape":"EntityType"} + }, + "entityTemporarilyUnmodifiableMessage":{"type":"string"}, + "existingUserNameType":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[\\w+=,.@-]+" + }, + "groupDetailListType":{ + "type":"list", + "member":{"shape":"GroupDetail"} + }, + "groupListType":{ + "type":"list", + "member":{"shape":"Group"} + }, + "groupNameListType":{ + "type":"list", + "member":{"shape":"groupNameType"} + }, + "groupNameType":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[\\w+=,.@-]+" + }, + "idType":{ + "type":"string", + "max":32, + "min":16, + "pattern":"[\\w]+" + }, + "instanceProfileListType":{ + "type":"list", + "member":{"shape":"InstanceProfile"} + }, + "instanceProfileNameType":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[\\w+=,.@-]+" + }, + "invalidAuthenticationCodeMessage":{"type":"string"}, + "invalidCertificateMessage":{"type":"string"}, + "invalidInputMessage":{"type":"string"}, + "invalidPublicKeyMessage":{"type":"string"}, + "invalidUserTypeMessage":{"type":"string"}, + "keyPairMismatchMessage":{"type":"string"}, + "limitExceededMessage":{"type":"string"}, + "malformedCertificateMessage":{"type":"string"}, + "malformedPolicyDocumentMessage":{"type":"string"}, + "markerType":{ + "type":"string", + "max":320, + "min":1, + "pattern":"[\\u0020-\\u00FF]+" + }, + "maxItemsType":{ + "type":"integer", + "max":1000, + "min":1 + }, + "maxPasswordAgeType":{ + "type":"integer", + "box":true, + "max":1095, + "min":1 + }, + "mfaDeviceListType":{ + "type":"list", + "member":{"shape":"MFADevice"} + }, + "minimumPasswordLengthType":{ + "type":"integer", + "max":128, + "min":6 + }, + "noSuchEntityMessage":{"type":"string"}, + "passwordPolicyViolationMessage":{"type":"string"}, + "passwordReusePreventionType":{ + "type":"integer", + "box":true, + "max":24, + "min":1 + }, + "passwordType":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+", + "sensitive":true + }, + "pathPrefixType":{ + "type":"string", + "max":512, + "min":1, + "pattern":"\\u002F[\\u0021-\\u007F]*" + }, + "pathType":{ + "type":"string", + "max":512, + "min":1, + "pattern":"(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)" + }, + "policyDescriptionType":{ + "type":"string", + "max":1000 + }, + "policyDetailListType":{ + "type":"list", + "member":{"shape":"PolicyDetail"} + }, + "policyDocumentType":{ + "type":"string", + "max":131072, + "min":1, + "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+" + }, + "policyDocumentVersionListType":{ + "type":"list", + "member":{"shape":"PolicyVersion"} + }, + "policyEvaluationErrorMessage":{"type":"string"}, + "policyListType":{ + "type":"list", + "member":{"shape":"Policy"} + }, + "policyNameListType":{ + "type":"list", + "member":{"shape":"policyNameType"} + }, + "policyNameType":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[\\w+=,.@-]+" + }, + "policyPathType":{ + "type":"string", + "pattern":"((/[A-Za-z0-9\\.,\\+@=_-]+)*)/" + }, + "policyScopeType":{ + "type":"string", + "enum":[ + "All", + "AWS", + "Local" + ] + }, + "policyVersionIdType":{ + "type":"string", + "pattern":"v[1-9][0-9]*(\\.[A-Za-z0-9-]*)?" + }, + "privateKeyType":{ + "type":"string", + "max":16384, + "min":1, + "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+", + "sensitive":true + }, + "publicKeyFingerprintType":{ + "type":"string", + "max":48, + "min":48, + "pattern":"[:\\w]+" + }, + "publicKeyIdType":{ + "type":"string", + "max":128, + "min":20, + "pattern":"[\\w]+" + }, + "publicKeyMaterialType":{ + "type":"string", + "max":16384, + "min":1, + "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+" + }, + "roleDetailListType":{ + "type":"list", + "member":{"shape":"RoleDetail"} + }, + "roleListType":{ + "type":"list", + "member":{"shape":"Role"} + }, + "roleNameType":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[\\w+=,.@-]+" + }, + "serialNumberType":{ + "type":"string", + "max":256, + "min":9, + "pattern":"[\\w+=/:,.@-]+" + }, + "serverCertificateMetadataListType":{ + "type":"list", + "member":{"shape":"ServerCertificateMetadata"} + }, + "serverCertificateNameType":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[\\w+=,.@-]+" + }, + "serviceFailureExceptionMessage":{"type":"string"}, + "statusType":{ + "type":"string", + "enum":[ + "Active", + "Inactive" + ] + }, + "stringType":{"type":"string"}, + "summaryKeyType":{ + "type":"string", + "enum":[ + "Users", + "UsersQuota", + "Groups", + "GroupsQuota", + "ServerCertificates", + "ServerCertificatesQuota", + "UserPolicySizeQuota", + "GroupPolicySizeQuota", + "GroupsPerUserQuota", + "SigningCertificatesPerUserQuota", + "AccessKeysPerUserQuota", + "MFADevices", + "MFADevicesInUse", + "AccountMFAEnabled", + "AccountAccessKeysPresent", + "AccountSigningCertificatesPresent", + "AttachedPoliciesPerGroupQuota", + "AttachedPoliciesPerRoleQuota", + "AttachedPoliciesPerUserQuota", + "Policies", + "PoliciesQuota", + "PolicySizeQuota", + "PolicyVersionsInUse", + "PolicyVersionsInUseQuota", + "VersionsPerPolicyQuota" + ] + }, + "summaryMapType":{ + "type":"map", + "key":{"shape":"summaryKeyType"}, + "value":{"shape":"summaryValueType"} + }, + "summaryValueType":{"type":"integer"}, + "thumbprintListType":{ + "type":"list", + "member":{"shape":"thumbprintType"} + }, + "thumbprintType":{ + "type":"string", + "max":40, + "min":40 + }, + "unrecognizedPublicKeyEncodingMessage":{"type":"string"}, + "userDetailListType":{ + "type":"list", + "member":{"shape":"UserDetail"} + }, + "userListType":{ + "type":"list", + "member":{"shape":"User"} + }, + "userNameType":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[\\w+=,.@-]+" + }, + "virtualMFADeviceListType":{ + "type":"list", + "member":{"shape":"VirtualMFADevice"} + }, + "virtualMFADeviceName":{ + "type":"string", + "min":1, + "pattern":"[\\w+=,.@-]+" + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/iam/2010-05-08/docs-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/iam/2010-05-08/docs-2.json new file mode 100644 index 000000000..1eb92c480 --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/iam/2010-05-08/docs-2.json @@ -0,0 +1,2523 @@ +{ + "version": "2.0", + "service": "AWS Identity and Access Management (IAM) is a web service that you can use to manage users and user permissions under your AWS account. This guide provides descriptions of IAM actions that you can call programmatically. For general information about IAM, see AWS Identity and Access Management (IAM). For the user guide for IAM, see Using IAM.
AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to IAM and AWS. For example, the SDKs take care of tasks such as cryptographically signing requests (see below), managing errors, and retrying requests automatically. For information about the AWS SDKs, including how to download and install them, see the Tools for Amazon Web Services page.
We recommend that you use the AWS SDKs to make programmatic API calls to IAM. However, you can also use the IAM Query API to make direct calls to the IAM web service. To learn more about the IAM Query API, see Making Query Requests in the Using IAM guide. IAM supports GET and POST requests for all actions. That is, the API does not require you to use GET for some actions and POST for others. However, GET requests are subject to the limitation size of a URL. Therefore, for operations that require larger sizes, use a POST request.
Signing Requests
Requests must be signed using an access key ID and a secret access key. We strongly recommend that you do not use your AWS account access key ID and secret access key for everyday work with IAM. You can use the access key ID and secret access key for an IAM user or you can use the AWS Security Token Service to generate temporary security credentials and use those to sign requests.
To sign requests, we recommend that you use Signature Version 4. If you have an existing application that uses Signature Version 2, you do not have to update it to use Signature Version 4. However, some operations now require Signature Version 4. The documentation for operations that require version 4 indicate this requirement.
Additional Resources
For more information, see the following:
AWS Security Credentials. This topic provides general information about the types of credentials used for accessing AWS.
IAM Best Practices. This topic presents a list of suggestions for using the IAM service to help secure your AWS resources.
Signing AWS API Requests. This set of topics walk you through the process of signing a request using an access key ID and secret access key.
Adds a new client ID (also known as audience) to the list of client IDs already registered for the specified IAM OpenID Connect (OIDC) provider resource.
This action is idempotent; it does not fail or return an error if you add an existing client ID to the provider.
", + "AddRoleToInstanceProfile": "Adds the specified IAM role to the specified instance profile.
The caller of this API must be granted the PassRole permission on the IAM role by a permission policy.
For more information about roles, go to Working with Roles. For more information about instance profiles, go to About Instance Profiles.
", + "AddUserToGroup": "Adds the specified user to the specified group.
", + "AttachGroupPolicy": "Attaches the specified managed policy to the specified IAM group.
You use this API to attach a managed policy to a group. To embed an inline policy in a group, use PutGroupPolicy.
For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide.
", + "AttachRolePolicy": "Attaches the specified managed policy to the specified IAM role.
When you attach a managed policy to a role, the managed policy becomes part of the role's permission (access) policy. You cannot use a managed policy as the role's trust policy. The role's trust policy is created at the same time as the role, using CreateRole. You can update a role's trust policy using UpdateAssumeRolePolicy.
Use this API to attach a managed policy to a role. To embed an inline policy in a role, use PutRolePolicy. For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide.
", + "AttachUserPolicy": "Attaches the specified managed policy to the specified user.
You use this API to attach a managed policy to a user. To embed an inline policy in a user, use PutUserPolicy.
For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide.
", + "ChangePassword": "Changes the password of the IAM user who is calling this action. The root account password is not affected by this action.
To change the password for a different user, see UpdateLoginProfile. For more information about modifying passwords, see Managing Passwords in the IAM User Guide.
", + "CreateAccessKey": " Creates a new AWS secret access key and corresponding AWS access key ID for the specified user. The default status for new keys is Active.
If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users.
For information about limits on the number of keys you can create, see Limitations on IAM Entities in the IAM User Guide.
To ensure the security of your AWS account, the secret access key is accessible only during key and user creation. You must save the key (for example, in a text file) if you want to be able to access it again. If a secret key is lost, you can delete the access keys for the associated user and then create new keys.
Creates an alias for your AWS account. For information about using an AWS account alias, see Using an Alias for Your AWS Account ID in the IAM User Guide.
", + "CreateGroup": "Creates a new group.
For information about the number of groups you can create, see Limitations on IAM Entities in the IAM User Guide.
", + "CreateInstanceProfile": "Creates a new instance profile. For information about instance profiles, go to About Instance Profiles.
For information about the number of instance profiles you can create, see Limitations on IAM Entities in the IAM User Guide.
", + "CreateLoginProfile": "Creates a password for the specified user, giving the user the ability to access AWS services through the AWS Management Console. For more information about managing passwords, see Managing Passwords in the IAM User Guide.
", + "CreateOpenIDConnectProvider": "Creates an IAM entity to describe an identity provider (IdP) that supports OpenID Connect (OIDC).
The OIDC provider that you create with this operation can be used as a principal in a role's trust policy to establish a trust relationship between AWS and the OIDC provider.
When you create the IAM OIDC provider, you specify the URL of the OIDC identity provider (IdP) to trust, a list of client IDs (also known as audiences) that identify the application or applications that are allowed to authenticate using the OIDC provider, and a list of thumbprints of the server certificate(s) that the IdP uses. You get all of this information from the OIDC IdP that you want to use for access to AWS.
Because trust for the OIDC provider is ultimately derived from the IAM provider that this action creates, it is a best practice to limit access to the CreateOpenIDConnectProvider action to highly-privileged users.
Creates a new managed policy for your AWS account.
This operation creates a policy version with a version identifier of v1 and sets v1 as the policy's default version. For more information about policy versions, see Versioning for Managed Policies in the IAM User Guide.
For more information about managed policies in general, see Managed Policies and Inline Policies in the IAM User Guide.
", + "CreatePolicyVersion": "Creates a new version of the specified managed policy. To update a managed policy, you create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must delete an existing version using DeletePolicyVersion before you create a new version.
Optionally, you can set the new version as the policy's default version. The default version is the version that is in effect for the IAM users, groups, and roles to which the policy is attached.
For more information about managed policy versions, see Versioning for Managed Policies in the IAM User Guide.
", + "CreateRole": "Creates a new role for your AWS account. For more information about roles, go to Working with Roles. For information about limitations on role names and the number of roles you can create, go to Limitations on IAM Entities in the IAM User Guide.
", + "CreateSAMLProvider": "Creates an IAM resource that describes an identity provider (IdP) that supports SAML 2.0.
The SAML provider resource that you create with this operation can be used as a principal in an IAM role's trust policy to enable federated users who sign-in using the SAML IdP to assume the role. You can create an IAM role that supports Web-based single sign-on (SSO) to the AWS Management Console or one that supports API access to AWS.
When you create the SAML provider resource, you upload an a SAML metadata document that you get from your IdP and that includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that the IdP sends. You must generate the metadata document using the identity management software that is used as your organization's IdP.
This operation requires Signature Version 4.
For more information, see Enabling SAML 2.0 Federated Users to Access the AWS Management Console and About SAML 2.0-based Federation in the IAM User Guide.
", + "CreateUser": "Creates a new IAM user for your AWS account.
For information about limitations on the number of IAM users you can create, see Limitations on IAM Entities in the IAM User Guide.
", + "CreateVirtualMFADevice": "Creates a new virtual MFA device for the AWS account. After creating the virtual MFA, use EnableMFADevice to attach the MFA device to an IAM user. For more information about creating and working with virtual MFA devices, go to Using a Virtual MFA Device in the IAM User Guide.
For information about limits on the number of MFA devices you can create, see Limitations on Entities in the IAM User Guide.
The seed information contained in the QR code and the Base32 string should be treated like any other secret access information, such as your AWS access keys or your passwords. After you provision your virtual device, you should ensure that the information is destroyed following secure procedures.
Deactivates the specified MFA device and removes it from association with the user name for which it was originally enabled.
For more information about creating and working with virtual MFA devices, go to Using a Virtual MFA Device in the IAM User Guide.
", + "DeleteAccessKey": "Deletes the access key pair associated with the specified IAM user.
If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users.
", + "DeleteAccountAlias": "Deletes the specified AWS account alias. For information about using an AWS account alias, see Using an Alias for Your AWS Account ID in the IAM User Guide.
", + "DeleteAccountPasswordPolicy": "Deletes the password policy for the AWS account. There are no parameters.
", + "DeleteGroup": "Deletes the specified IAM group. The group must not contain any users or have any attached policies.
", + "DeleteGroupPolicy": "Deletes the specified inline policy that is embedded in the specified IAM group.
A group can also have managed policies attached to it. To detach a managed policy from a group, use DetachGroupPolicy. For more information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide.
", + "DeleteInstanceProfile": "Deletes the specified instance profile. The instance profile must not have an associated role.
Make sure you do not have any Amazon EC2 instances running with the instance profile you are about to delete. Deleting a role or instance profile that is associated with a running instance will break any applications running on the instance.
For more information about instance profiles, go to About Instance Profiles.
", + "DeleteLoginProfile": "Deletes the password for the specified IAM user, which terminates the user's ability to access AWS services through the AWS Management Console.
Deleting a user's password does not prevent a user from accessing AWS through the command line interface or the API. To prevent all user access you must also either make any access keys inactive or delete them. For more information about making keys inactive or deleting them, see UpdateAccessKey and DeleteAccessKey.
Deletes an OpenID Connect identity provider (IdP) resource object in IAM.
Deleting an IAM OIDC provider resource does not update any roles that reference the provider as a principal in their trust policies. Any attempt to assume a role that references a deleted provider fails.
This action is idempotent; it does not fail or return an error if you call the action for a provider that does not exist.
", + "DeletePolicy": "Deletes the specified managed policy.
Before you can delete a managed policy, you must first detach the policy from all users, groups, and roles that it is attached to, and you must delete all of the policy's versions. The following steps describe the process for deleting a managed policy:
Detach the policy from all users, groups, and roles that the policy is attached to, using the DetachUserPolicy, DetachGroupPolicy, or DetachRolePolicy APIs. To list all the users, groups, and roles that a policy is attached to, use ListEntitiesForPolicy.
Delete all versions of the policy using DeletePolicyVersion. To list the policy's versions, use ListPolicyVersions. You cannot use DeletePolicyVersion to delete the version that is marked as the default version. You delete the policy's default version in the next step of the process.
Delete the policy (this automatically deletes the policy's default version) using this API.
For information about managed policies, see Managed Policies and Inline Policies in the IAM User Guide.
", + "DeletePolicyVersion": "Deletes the specified version from the specified managed policy.
You cannot delete the default version from a policy using this API. To delete the default version from a policy, use DeletePolicy. To find out which version of a policy is marked as the default version, use ListPolicyVersions.
For information about versions for managed policies, see Versioning for Managed Policies in the IAM User Guide.
", + "DeleteRole": "Deletes the specified role. The role must not have any policies attached. For more information about roles, go to Working with Roles.
Make sure you do not have any Amazon EC2 instances running with the role you are about to delete. Deleting a role or instance profile that is associated with a running instance will break any applications running on the instance.
Deletes the specified inline policy that is embedded in the specified IAM role.
A role can also have managed policies attached to it. To detach a managed policy from a role, use DetachRolePolicy. For more information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide.
", + "DeleteSAMLProvider": "Deletes a SAML provider resource in IAM.
Deleting the provider resource from IAM does not update any roles that reference the SAML provider resource's ARN as a principal in their trust policies. Any attempt to assume a role that references a non-existent provider resource ARN fails.
This operation requires Signature Version 4.
Deletes the specified SSH public key.
The SSH public key deleted by this action is used only for authenticating the associated IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see Set up AWS CodeCommit for SSH Connections in the AWS CodeCommit User Guide.
", + "DeleteServerCertificate": "Deletes the specified server certificate.
For more information about working with server certificates, including a list of AWS services that can use the server certificates that you manage with IAM, go to Working with Server Certificates in the IAM User Guide.
If you are using a server certificate with Elastic Load Balancing, deleting the certificate could have implications for your application. If Elastic Load Balancing doesn't detect the deletion of bound certificates, it may continue to use the certificates. This could cause Elastic Load Balancing to stop accepting traffic. We recommend that you remove the reference to the certificate from Elastic Load Balancing before using this command to delete the certificate. For more information, go to DeleteLoadBalancerListeners in the Elastic Load Balancing API Reference.
Deletes a signing certificate associated with the specified IAM user.
If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated IAM users.
", + "DeleteUser": "Deletes the specified IAM user. The user must not belong to any groups or have any access keys, signing certificates, or attached policies.
", + "DeleteUserPolicy": "Deletes the specified inline policy that is embedded in the specified IAM user.
A user can also have managed policies attached to it. To detach a managed policy from a user, use DetachUserPolicy. For more information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide.
", + "DeleteVirtualMFADevice": "Deletes a virtual MFA device.
You must deactivate a user's virtual MFA device before you can delete it. For information about deactivating MFA devices, see DeactivateMFADevice.
Removes the specified managed policy from the specified IAM group.
A group can also have inline policies embedded with it. To delete an inline policy, use the DeleteGroupPolicy API. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide.
", + "DetachRolePolicy": "Removes the specified managed policy from the specified role.
A role can also have inline policies embedded with it. To delete an inline policy, use the DeleteRolePolicy API. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide.
", + "DetachUserPolicy": "Removes the specified managed policy from the specified user.
A user can also have inline policies embedded with it. To delete an inline policy, use the DeleteUserPolicy API. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide.
", + "EnableMFADevice": "Enables the specified MFA device and associates it with the specified IAM user. When enabled, the MFA device is required for every subsequent login by the IAM user associated with the device.
", + "GenerateCredentialReport": "Generates a credential report for the AWS account. For more information about the credential report, see Getting Credential Reports in the IAM User Guide.
", + "GetAccessKeyLastUsed": "Retrieves information about when the specified access key was last used. The information includes the date and time of last use, along with the AWS service and region that were specified in the last request made with that key.
", + "GetAccountAuthorizationDetails": "Retrieves information about all IAM users, groups, roles, and policies in your AWS account, including their relationships to one another. Use this API to obtain a snapshot of the configuration of IAM permissions (users, groups, roles, and policies) in your account.
You can optionally filter the results using the Filter parameter. You can paginate the results using the MaxItems and Marker parameters.
Retrieves the password policy for the AWS account. For more information about using a password policy, go to Managing an IAM Password Policy.
", + "GetAccountSummary": "Retrieves information about IAM entity usage and IAM quotas in the AWS account.
For information about limitations on IAM entities, see Limitations on IAM Entities in the IAM User Guide.
", + "GetContextKeysForCustomPolicy": "Gets a list of all of the context keys referenced in the input policies. The policies are supplied as a list of one or more strings. To get the context keys from policies associated with an IAM user, group, or role, use GetContextKeysForPrincipalPolicy.
Context keys are variables maintained by AWS and its services that provide details about the context of an API query request, and can be evaluated by testing against a value specified in an IAM policy. Use GetContextKeysForCustomPolicy to understand what key names and values you must supply when you call SimulateCustomPolicy. Note that all parameters are shown in unencoded form here for clarity, but must be URL encoded to be included as a part of a real HTML request.
", + "GetContextKeysForPrincipalPolicy": "Gets a list of all of the context keys referenced in all of the IAM policies attached to the specified IAM entity. The entity can be an IAM user, group, or role. If you specify a user, then the request also includes all of the policies attached to groups that the user is a member of.
You can optionally include a list of one or more additional policies, specified as strings. If you want to include only a list of policies by string, use GetContextKeysForCustomPolicy instead.
Note: This API discloses information about the permissions granted to other users. If you do not want users to see other user's permissions, then consider allowing them to use GetContextKeysForCustomPolicy instead.
Context keys are variables maintained by AWS and its services that provide details about the context of an API query request, and can be evaluated by testing against a value in an IAM policy. Use GetContextKeysForPrincipalPolicy to understand what key names and values you must supply when you call SimulatePrincipalPolicy.
", + "GetCredentialReport": "Retrieves a credential report for the AWS account. For more information about the credential report, see Getting Credential Reports in the IAM User Guide.
", + "GetGroup": " Returns a list of IAM users that are in the specified IAM group. You can paginate the results using the MaxItems and Marker parameters.
Retrieves the specified inline policy document that is embedded in the specified IAM group.
Policies returned by this API are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality.
An IAM group can also have managed policies attached to it. To retrieve a managed policy document that is attached to a group, use GetPolicy to determine the policy's default version, then use GetPolicyVersion to retrieve the policy document.
For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide.
", + "GetInstanceProfile": "Retrieves information about the specified instance profile, including the instance profile's path, GUID, ARN, and role. For more information about instance profiles, see About Instance Profiles in the IAM User Guide.
", + "GetLoginProfile": "Retrieves the user name and password-creation date for the specified IAM user. If the user has not been assigned a password, the action returns a 404 (NoSuchEntity) error.
Returns information about the specified OpenID Connect (OIDC) provider resource object in IAM.
", + "GetPolicy": "Retrieves information about the specified managed policy, including the policy's default version and the total number of IAM users, groups, and roles to which the policy is attached. To retrieve the list of the specific users, groups, and roles that the policy is attached to, use the ListEntitiesForPolicy API. This API returns metadata about the policy. To retrieve the actual policy document for a specific version of the policy, use GetPolicyVersion.
This API retrieves information about managed policies. To retrieve information about an inline policy that is embedded with an IAM user, group, or role, use the GetUserPolicy, GetGroupPolicy, or GetRolePolicy API.
For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide.
", + "GetPolicyVersion": "Retrieves information about the specified version of the specified managed policy, including the policy document.
Policies returned by this API are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality.
To list the available versions for a policy, use ListPolicyVersions.
This API retrieves information about managed policies. To retrieve information about an inline policy that is embedded in a user, group, or role, use the GetUserPolicy, GetGroupPolicy, or GetRolePolicy API.
For more information about the types of policies, see Managed Policies and Inline Policies in the IAM User Guide.
For more information about managed policy versions, see Versioning for Managed Policies in the IAM User Guide.
", + "GetRole": "Retrieves information about the specified role, including the role's path, GUID, ARN, and the role's trust policy that grants permission to assume the role. For more information about roles, see Working with Roles.
Policies returned by this API are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality.
Retrieves the specified inline policy document that is embedded with the specified IAM role.
Policies returned by this API are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality.
An IAM role can also have managed policies attached to it. To retrieve a managed policy document that is attached to a role, use GetPolicy to determine the policy's default version, then use GetPolicyVersion to retrieve the policy document.
For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide.
For more information about roles, see Using Roles to Delegate Permissions and Federate Identities.
", + "GetSAMLProvider": "Returns the SAML provider metadocument that was uploaded when the IAM SAML provider resource object was created or updated.
This operation requires Signature Version 4.
Retrieves the specified SSH public key, including metadata about the key.
The SSH public key retrieved by this action is used only for authenticating the associated IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see Set up AWS CodeCommit for SSH Connections in the AWS CodeCommit User Guide.
", + "GetServerCertificate": "Retrieves information about the specified server certificate stored in IAM.
For more information about working with server certificates, including a list of AWS services that can use the server certificates that you manage with IAM, go to Working with Server Certificates in the IAM User Guide.
", + "GetUser": "Retrieves information about the specified IAM user, including the user's creation date, path, unique ID, and ARN.
If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID used to sign the request to this API.
", + "GetUserPolicy": "Retrieves the specified inline policy document that is embedded in the specified IAM user.
Policies returned by this API are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality.
An IAM user can also have managed policies attached to it. To retrieve a managed policy document that is attached to a user, use GetPolicy to determine the policy's default version, then use GetPolicyVersion to retrieve the policy document.
For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide.
", + "ListAccessKeys": "Returns information about the access key IDs associated with the specified IAM user. If there are none, the action returns an empty list.
Although each user is limited to a small number of keys, you can still paginate the results using the MaxItems and Marker parameters.
If the UserName field is not specified, the UserName is determined implicitly based on the AWS access key ID used to sign the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users.
To ensure the security of your AWS account, the secret access key is accessible only during key and user creation.
Lists the account alias associated with the AWS account (Note: you can have only one). For information about using an AWS account alias, see Using an Alias for Your AWS Account ID in the IAM User Guide.
", + "ListAttachedGroupPolicies": "Lists all managed policies that are attached to the specified IAM group.
An IAM group can also have inline policies embedded with it. To list the inline policies for a group, use the ListGroupPolicies API. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide.
You can paginate the results using the MaxItems and Marker parameters. You can use the PathPrefix parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified group (or none that match the specified path prefix), the action returns an empty list.
Lists all managed policies that are attached to the specified IAM role.
An IAM role can also have inline policies embedded with it. To list the inline policies for a role, use the ListRolePolicies API. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide.
You can paginate the results using the MaxItems and Marker parameters. You can use the PathPrefix parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified role (or none that match the specified path prefix), the action returns an empty list.
Lists all managed policies that are attached to the specified IAM user.
An IAM user can also have inline policies embedded with it. To list the inline policies for a user, use the ListUserPolicies API. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide.
You can paginate the results using the MaxItems and Marker parameters. You can use the PathPrefix parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified group (or none that match the specified path prefix), the action returns an empty list.
Lists all IAM users, groups, and roles that the specified managed policy is attached to.
You can use the optional EntityFilter parameter to limit the results to a particular type of entity (users, groups, or roles). For example, to list only the roles that are attached to the specified policy, set EntityFilter to Role.
You can paginate the results using the MaxItems and Marker parameters.
Lists the names of the inline policies that are embedded in the specified IAM group.
An IAM group can also have managed policies attached to it. To list the managed policies that are attached to a group, use ListAttachedGroupPolicies. For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide.
You can paginate the results using the MaxItems and Marker parameters. If there are no inline policies embedded with the specified group, the action returns an empty list.
Lists the IAM groups that have the specified path prefix.
You can paginate the results using the MaxItems and Marker parameters.
Lists the IAM groups that the specified IAM user belongs to.
You can paginate the results using the MaxItems and Marker parameters.
Lists the instance profiles that have the specified path prefix. If there are none, the action returns an empty list. For more information about instance profiles, go to About Instance Profiles.
You can paginate the results using the MaxItems and Marker parameters.
Lists the instance profiles that have the specified associated IAM role. If there are none, the action returns an empty list. For more information about instance profiles, go to About Instance Profiles.
You can paginate the results using the MaxItems and Marker parameters.
Lists the MFA devices for an IAM user. If the request includes a IAM user name, then this action lists all the MFA devices associated with the specified user. If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request for this API.
You can paginate the results using the MaxItems and Marker parameters.
Lists information about the IAM OpenID Connect (OIDC) provider resource objects defined in the AWS account.
", + "ListPolicies": "Lists all the managed policies that are available in your AWS account, including your own customer-defined managed policies and all AWS managed policies.
You can filter the list of policies that is returned using the optional OnlyAttached, Scope, and PathPrefix parameters. For example, to list only the customer managed policies in your AWS account, set Scope to Local. To list only AWS managed policies, set Scope to AWS.
You can paginate the results using the MaxItems and Marker parameters.
For more information about managed policies, see Managed Policies and Inline Policies in the IAM User Guide.
", + "ListPolicyVersions": "Lists information about the versions of the specified managed policy, including the version that is currently set as the policy's default version.
For more information about managed policies, see Managed Policies and Inline Policies in the IAM User Guide.
", + "ListRolePolicies": "Lists the names of the inline policies that are embedded in the specified IAM role.
An IAM role can also have managed policies attached to it. To list the managed policies that are attached to a role, use ListAttachedRolePolicies. For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide.
You can paginate the results using the MaxItems and Marker parameters. If there are no inline policies embedded with the specified role, the action returns an empty list.
Lists the IAM roles that have the specified path prefix. If there are none, the action returns an empty list. For more information about roles, go to Working with Roles.
You can paginate the results using the MaxItems and Marker parameters.
Lists the SAML provider resource objects defined in IAM in the account.
This operation requires Signature Version 4.
Returns information about the SSH public keys associated with the specified IAM user. If there are none, the action returns an empty list.
The SSH public keys returned by this action are used only for authenticating the IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see Set up AWS CodeCommit for SSH Connections in the AWS CodeCommit User Guide.
Although each user is limited to a small number of keys, you can still paginate the results using the MaxItems and Marker parameters.
Lists the server certificates stored in IAM that have the specified path prefix. If none exist, the action returns an empty list.
You can paginate the results using the MaxItems and Marker parameters.
For more information about working with server certificates, including a list of AWS services that can use the server certificates that you manage with IAM, go to Working with Server Certificates in the IAM User Guide.
", + "ListSigningCertificates": "Returns information about the signing certificates associated with the specified IAM user. If there are none, the action returns an empty list.
Although each user is limited to a small number of signing certificates, you can still paginate the results using the MaxItems and Marker parameters.
If the UserName field is not specified, the user name is determined implicitly based on the AWS access key ID used to sign the request for this API. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users.
Lists the names of the inline policies embedded in the specified IAM user.
An IAM user can also have managed policies attached to it. To list the managed policies that are attached to a user, use ListAttachedUserPolicies. For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide.
You can paginate the results using the MaxItems and Marker parameters. If there are no inline policies embedded with the specified user, the action returns an empty list.
Lists the IAM users that have the specified path prefix. If no path prefix is specified, the action returns all users in the AWS account. If there are none, the action returns an empty list.
You can paginate the results using the MaxItems and Marker parameters.
Lists the virtual MFA devices defined in the AWS account by assignment status. If you do not specify an assignment status, the action returns a list of all virtual MFA devices. Assignment status can be Assigned, Unassigned, or Any.
You can paginate the results using the MaxItems and Marker parameters.
Adds or updates an inline policy document that is embedded in the specified IAM group.
A user can also have managed policies attached to it. To attach a managed policy to a group, use AttachGroupPolicy. To create a new managed policy, use CreatePolicy. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide.
For information about limits on the number of inline policies that you can embed in a group, see Limitations on IAM Entities in the IAM User Guide.
Because policy documents can be large, you should use POST rather than GET when calling PutGroupPolicy. For general information about using the Query API with IAM, go to Making Query Requests in the IAM User Guide.
Adds or updates an inline policy document that is embedded in the specified IAM role.
When you embed an inline policy in a role, the inline policy is used as part of the role's access (permissions) policy. The role's trust policy is created at the same time as the role, using CreateRole. You can update a role's trust policy using UpdateAssumeRolePolicy. For more information about IAM roles, go to Using Roles to Delegate Permissions and Federate Identities.
A role can also have a managed policy attached to it. To attach a managed policy to a role, use AttachRolePolicy. To create a new managed policy, use CreatePolicy. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide.
For information about limits on the number of inline policies that you can embed with a role, see Limitations on IAM Entities in the IAM User Guide.
Because policy documents can be large, you should use POST rather than GET when calling PutRolePolicy. For general information about using the Query API with IAM, go to Making Query Requests in the IAM User Guide.
Adds or updates an inline policy document that is embedded in the specified IAM user.
An IAM user can also have a managed policy attached to it. To attach a managed policy to a user, use AttachUserPolicy. To create a new managed policy, use CreatePolicy. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide.
For information about limits on the number of inline policies that you can embed in a user, see Limitations on IAM Entities in the IAM User Guide.
Because policy documents can be large, you should use POST rather than GET when calling PutUserPolicy. For general information about using the Query API with IAM, go to Making Query Requests in the IAM User Guide.
Removes the specified client ID (also known as audience) from the list of client IDs registered for the specified IAM OpenID Connect (OIDC) provider resource object.
This action is idempotent; it does not fail or return an error if you try to remove a client ID that does not exist.
", + "RemoveRoleFromInstanceProfile": "Removes the specified IAM role from the specified EC2 instance profile.
Make sure you do not have any Amazon EC2 instances running with the role you are about to remove from the instance profile. Removing a role from an instance profile that is associated with a running instance break any applications running on the instance.
For more information about IAM roles, go to Working with Roles. For more information about instance profiles, go to About Instance Profiles.
", + "RemoveUserFromGroup": "Removes the specified user from the specified group.
", + "ResyncMFADevice": "Synchronizes the specified MFA device with its IAM resource object on the AWS servers.
For more information about creating and working with virtual MFA devices, go to Using a Virtual MFA Device in the IAM User Guide.
", + "SetDefaultPolicyVersion": "Sets the specified version of the specified policy as the policy's default (operative) version.
This action affects all users, groups, and roles that the policy is attached to. To list the users, groups, and roles that the policy is attached to, use the ListEntitiesForPolicy API.
For information about managed policies, see Managed Policies and Inline Policies in the IAM User Guide.
", + "SimulateCustomPolicy": "Simulate how a set of IAM policies and optionally a resource-based policy works with a list of API actions and AWS resources to determine the policies' effective permissions. The policies are provided as strings.
The simulation does not perform the API actions; it only checks the authorization to determine if the simulated policies allow or deny the actions.
If you want to simulate existing policies attached to an IAM user, group, or role, use SimulatePrincipalPolicy instead.
Context keys are variables maintained by AWS and its services that provide details about the context of an API query request. You can use the Condition element of an IAM policy to evaluate context keys. To get the list of context keys that the policies require for correct simulation, use GetContextKeysForCustomPolicy.
If the output is long, you can use MaxItems and Marker parameters to paginate the results.
Simulate how a set of IAM policies attached to an IAM entity works with a list of API actions and AWS resources to determine the policies' effective permissions. The entity can be an IAM user, group, or role. If you specify a user, then the simulation also includes all of the policies that are attached to groups that the user belongs to .
You can optionally include a list of one or more additional policies specified as strings to include in the simulation. If you want to simulate only policies specified as strings, use SimulateCustomPolicy instead.
You can also optionally include one resource-based policy to be evaluated with each of the resources included in the simulation.
The simulation does not perform the API actions, it only checks the authorization to determine if the simulated policies allow or deny the actions.
Note: This API discloses information about the permissions granted to other users. If you do not want users to see other user's permissions, then consider allowing them to use SimulateCustomPolicy instead.
Context keys are variables maintained by AWS and its services that provide details about the context of an API query request. You can use the Condition element of an IAM policy to evaluate context keys. To get the list of context keys that the policies require for correct simulation, use GetContextKeysForPrincipalPolicy.
If the output is long, you can use the MaxItems and Marker parameters to paginate the results.
Changes the status of the specified access key from Active to Inactive, or vice versa. This action can be used to disable a user's key as part of a key rotation work flow.
If the UserName field is not specified, the UserName is determined implicitly based on the AWS access key ID used to sign the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users.
For information about rotating keys, see Managing Keys and Certificates in the IAM User Guide.
", + "UpdateAccountPasswordPolicy": "Updates the password policy settings for the AWS account.
This action does not support partial updates. No parameters are required, but if you do not specify a parameter, that parameter's value reverts to its default value. See the Request Parameters section for each parameter's default value.
For more information about using a password policy, see Managing an IAM Password Policy in the IAM User Guide.
", + "UpdateAssumeRolePolicy": "Updates the policy that grants an IAM entity permission to assume a role. This is typically referred to as the \"role trust policy\". For more information about roles, go to Using Roles to Delegate Permissions and Federate Identities.
", + "UpdateGroup": "Updates the name and/or the path of the specified IAM group.
You should understand the implications of changing a group's path or name. For more information, see Renaming Users and Groups in the IAM User Guide.
To change an IAM group name the requester must have appropriate permissions on both the source object and the target object. For example, to change \"Managers\" to \"MGRs\", the entity making the request must have permission on both \"Managers\" and \"MGRs\", or must have permission on all (*). For more information about permissions, see Permissions and Policies.
Changes the password for the specified IAM user.
IAM users can change their own passwords by calling ChangePassword. For more information about modifying passwords, see Managing Passwords in the IAM User Guide.
", + "UpdateOpenIDConnectProviderThumbprint": "Replaces the existing list of server certificate thumbprints associated with an OpenID Connect (OIDC) provider resource object with a new list of thumbprints.
The list that you pass with this action completely replaces the existing list of thumbprints. (The lists are not merged.)
Typically, you need to update a thumbprint only when the identity provider's certificate changes, which occurs rarely. However, if the provider's certificate does change, any attempt to assume an IAM role that specifies the OIDC provider as a principal fails until the certificate thumbprint is updated.
Because trust for the OIDC provider is ultimately derived from the provider's certificate and is validated by the thumbprint, it is a best practice to limit access to the UpdateOpenIDConnectProviderThumbprint action to highly-privileged users.
Updates the metadata document for an existing SAML provider resource object.
This operation requires Signature Version 4.
Sets the status of an IAM user's SSH public key to active or inactive. SSH public keys that are inactive cannot be used for authentication. This action can be used to disable a user's SSH public key as part of a key rotation work flow.
The SSH public key affected by this action is used only for authenticating the associated IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see Set up AWS CodeCommit for SSH Connections in the AWS CodeCommit User Guide.
", + "UpdateServerCertificate": "Updates the name and/or the path of the specified server certificate stored in IAM.
For more information about working with server certificates, including a list of AWS services that can use the server certificates that you manage with IAM, go to Working with Server Certificates in the IAM User Guide.
You should understand the implications of changing a server certificate's path or name. For more information, see Renaming a Server Certificate in the IAM User Guide.
To change a server certificate name the requester must have appropriate permissions on both the source object and the target object. For example, to change the name from \"ProductionCert\" to \"ProdCert\", the entity making the request must have permission on \"ProductionCert\" and \"ProdCert\", or must have permission on all (*). For more information about permissions, see Access Management in the IAM User Guide.
Changes the status of the specified user signing certificate from active to disabled, or vice versa. This action can be used to disable an IAM user's signing certificate as part of a certificate rotation work flow.
If the UserName field is not specified, the UserName is determined implicitly based on the AWS access key ID used to sign the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users.
Updates the name and/or the path of the specified IAM user.
You should understand the implications of changing an IAM user's path or name. For more information, see Renaming an IAM User and Renaming an IAM Group in the IAM User Guide.
To change a user name the requester must have appropriate permissions on both the source object and the target object. For example, to change Bob to Robert, the entity making the request must have permission on Bob and Robert, or must have permission on all (*). For more information about permissions, see Permissions and Policies.
Uploads an SSH public key and associates it with the specified IAM user.
The SSH public key uploaded by this action can be used only for authenticating the associated IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see Set up AWS CodeCommit for SSH Connections in the AWS CodeCommit User Guide.
", + "UploadServerCertificate": "Uploads a server certificate entity for the AWS account. The server certificate entity includes a public key certificate, a private key, and an optional certificate chain, which should all be PEM-encoded.
For more information about working with server certificates, including a list of AWS services that can use the server certificates that you manage with IAM, go to Working with Server Certificates in the IAM User Guide.
For information about the number of server certificates you can upload, see Limitations on IAM Entities and Objects in the IAM User Guide.
Because the body of the public key certificate, private key, and the certificate chain can be large, you should use POST rather than GET when calling UploadServerCertificate. For information about setting up signatures and authorization through the API, go to Signing AWS API Requests in the AWS General Reference. For general information about using the Query API with IAM, go to Calling the API by Making HTTP Query Requests in the IAM User Guide.
Uploads an X.509 signing certificate and associates it with the specified IAM user. Some AWS services use X.509 signing certificates to validate requests that are signed with a corresponding private key. When you upload the certificate, its default status is Active.
If the UserName field is not specified, the IAM user name is determined implicitly based on the AWS access key ID used to sign the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users.
Because the body of a X.509 certificate can be large, you should use POST rather than GET when calling UploadSigningCertificate. For information about setting up signatures and authorization through the API, go to Signing AWS API Requests in the AWS General Reference. For general information about using the Query API with IAM, go to Making Query Requests in the IAM User Guide.
Contains information about an AWS access key.
This data type is used as a response element in the CreateAccessKey and ListAccessKeys actions.
The SecretAccessKey value is returned only in response to CreateAccessKey. You can get a secret access key only when you first create an access key; you cannot recover the secret access key later. If you lose a secret access key, you must create a new access key.
A structure with details about the access key.
" + } + }, + "AccessKeyLastUsed": { + "base": "Contains information about the last time an AWS access key was used.
This data type is used as a response element in the GetAccessKeyLastUsed action.
", + "refs": { + "GetAccessKeyLastUsedResponse$AccessKeyLastUsed": "Contains information about the last time the access key was used.
" + } + }, + "AccessKeyMetadata": { + "base": "Contains information about an AWS access key, without its secret key.
This data type is used as a response element in the ListAccessKeys action.
", + "refs": { + "accessKeyMetadataListType$member": null + } + }, + "ActionNameListType": { + "base": null, + "refs": { + "SimulateCustomPolicyRequest$ActionNames": "A list of names of API actions to evaluate in the simulation. Each action is evaluated against each resource. Each action must include the service identifier, such as iam:CreateUser.
A list of names of API actions to evaluate in the simulation. Each action is evaluated for each resource. Each action must include the service identifier, such as iam:CreateUser.
The name of the API action tested on the indicated resource.
" + } + }, + "AddClientIDToOpenIDConnectProviderRequest": { + "base": null, + "refs": { + } + }, + "AddRoleToInstanceProfileRequest": { + "base": null, + "refs": { + } + }, + "AddUserToGroupRequest": { + "base": null, + "refs": { + } + }, + "AttachGroupPolicyRequest": { + "base": null, + "refs": { + } + }, + "AttachRolePolicyRequest": { + "base": null, + "refs": { + } + }, + "AttachUserPolicyRequest": { + "base": null, + "refs": { + } + }, + "AttachedPolicy": { + "base": "Contains information about an attached policy.
An attached policy is a managed policy that has been attached to a user, group, or role. This data type is used as a response element in the ListAttachedGroupPolicies, ListAttachedRolePolicies, ListAttachedUserPolicies, and GetAccountAuthorizationDetails actions.
For more information about managed policies, refer to Managed Policies and Inline Policies in the Using IAM guide.
", + "refs": { + "attachedPoliciesListType$member": null + } + }, + "BootstrapDatum": { + "base": null, + "refs": { + "VirtualMFADevice$Base32StringSeed": " The Base32 seed defined as specified in RFC3548. The Base32StringSeed is Base64-encoded.
A QR code PNG image that encodes otpauth://totp/$virtualMFADeviceName@$AccountName?secret=$Base32String where $virtualMFADeviceName is one of the create call arguments, AccountName is the user name if set (otherwise, the account ID otherwise), and Base32String is the seed in Base32 format. The Base32String value is Base64-encoded.
The column in the line containing the specified position in the document.
" + } + }, + "ContextEntry": { + "base": "Contains information about a condition context key. It includes the name of the key and specifies the value (or values, if the context key supports multiple values) to use in the simulation. This information is used when evaluating the Condition elements of the input policies.
This data type is used as an input parameter to SimulateCustomPolicy and SimulateCustomPolicy .
A list of context keys and corresponding values for the simulation to use. Whenever a context key is evaluated in one of the simulated IAM permission policies, the corresponding value is supplied.
", + "SimulatePrincipalPolicyRequest$ContextEntries": "A list of context keys and corresponding values for the simulation to use. Whenever a context key is evaluated in one of the simulated IAM permission policies, the corresponding value is supplied.
" + } + }, + "ContextKeyNameType": { + "base": null, + "refs": { + "ContextEntry$ContextKeyName": "The full name of a condition context key, including the service prefix. For example, aws:SourceIp or s3:VersionId.
A list of context keys that are required by the included input policies but that were not provided by one of the input parameters. This list is used when the resource in a simulation is \"*\", either explicitly, or when the ResourceArns parameter blank. If you include a list of resources, then any missing context values are instead included under the ResourceSpecificResults section. To discover the context keys used by a set of policies, you can call GetContextKeysForCustomPolicy or GetContextKeysForPrincipalPolicy.
The list of context keys that are referenced in the input policies.
", + "ResourceSpecificResult$MissingContextValues": "A list of context keys that are required by the included input policies but that were not provided by one of the input parameters. This list is used when a list of ARNs is included in the ResourceArns parameter instead of \"*\". If you do not specify individual resources, by setting ResourceArns to \"*\" or by not including the ResourceArns parameter, then any missing context values are instead included under the EvaluationResults section. To discover the context keys used by a set of policies, you can call GetContextKeysForCustomPolicy or GetContextKeysForPrincipalPolicy.
The data type of the value (or values) specified in the ContextKeyValues parameter.
The value (or values, if the condition context key supports multiple values) to provide to the simulation for use when the key is referenced by a Condition element in an input policy.
Contains the response to a successful CreateAccessKey request.
", + "refs": { + } + }, + "CreateAccountAliasRequest": { + "base": null, + "refs": { + } + }, + "CreateGroupRequest": { + "base": null, + "refs": { + } + }, + "CreateGroupResponse": { + "base": "Contains the response to a successful CreateGroup request.
", + "refs": { + } + }, + "CreateInstanceProfileRequest": { + "base": null, + "refs": { + } + }, + "CreateInstanceProfileResponse": { + "base": "Contains the response to a successful CreateInstanceProfile request.
", + "refs": { + } + }, + "CreateLoginProfileRequest": { + "base": null, + "refs": { + } + }, + "CreateLoginProfileResponse": { + "base": "Contains the response to a successful CreateLoginProfile request.
", + "refs": { + } + }, + "CreateOpenIDConnectProviderRequest": { + "base": null, + "refs": { + } + }, + "CreateOpenIDConnectProviderResponse": { + "base": "Contains the response to a successful CreateOpenIDConnectProvider request.
", + "refs": { + } + }, + "CreatePolicyRequest": { + "base": null, + "refs": { + } + }, + "CreatePolicyResponse": { + "base": "Contains the response to a successful CreatePolicy request.
", + "refs": { + } + }, + "CreatePolicyVersionRequest": { + "base": null, + "refs": { + } + }, + "CreatePolicyVersionResponse": { + "base": "Contains the response to a successful CreatePolicyVersion request.
", + "refs": { + } + }, + "CreateRoleRequest": { + "base": null, + "refs": { + } + }, + "CreateRoleResponse": { + "base": "Contains the response to a successful CreateRole request.
", + "refs": { + } + }, + "CreateSAMLProviderRequest": { + "base": null, + "refs": { + } + }, + "CreateSAMLProviderResponse": { + "base": "Contains the response to a successful CreateSAMLProvider request.
", + "refs": { + } + }, + "CreateUserRequest": { + "base": null, + "refs": { + } + }, + "CreateUserResponse": { + "base": "Contains the response to a successful CreateUser request.
", + "refs": { + } + }, + "CreateVirtualMFADeviceRequest": { + "base": null, + "refs": { + } + }, + "CreateVirtualMFADeviceResponse": { + "base": "Contains the response to a successful CreateVirtualMFADevice request.
", + "refs": { + } + }, + "CredentialReportExpiredException": { + "base": "The request was rejected because the most recent credential report has expired. To generate a new credential report, use GenerateCredentialReport. For more information about credential report expiration, see Getting Credential Reports in the IAM User Guide.
", + "refs": { + } + }, + "CredentialReportNotPresentException": { + "base": "The request was rejected because the credential report does not exist. To generate a credential report, use GenerateCredentialReport.
", + "refs": { + } + }, + "CredentialReportNotReadyException": { + "base": "The request was rejected because the credential report is still being generated.
", + "refs": { + } + }, + "DeactivateMFADeviceRequest": { + "base": null, + "refs": { + } + }, + "DeleteAccessKeyRequest": { + "base": null, + "refs": { + } + }, + "DeleteAccountAliasRequest": { + "base": null, + "refs": { + } + }, + "DeleteConflictException": { + "base": "The request was rejected because it attempted to delete a resource that has attached subordinate entities. The error message describes these entities.
", + "refs": { + } + }, + "DeleteGroupPolicyRequest": { + "base": null, + "refs": { + } + }, + "DeleteGroupRequest": { + "base": null, + "refs": { + } + }, + "DeleteInstanceProfileRequest": { + "base": null, + "refs": { + } + }, + "DeleteLoginProfileRequest": { + "base": null, + "refs": { + } + }, + "DeleteOpenIDConnectProviderRequest": { + "base": null, + "refs": { + } + }, + "DeletePolicyRequest": { + "base": null, + "refs": { + } + }, + "DeletePolicyVersionRequest": { + "base": null, + "refs": { + } + }, + "DeleteRolePolicyRequest": { + "base": null, + "refs": { + } + }, + "DeleteRoleRequest": { + "base": null, + "refs": { + } + }, + "DeleteSAMLProviderRequest": { + "base": null, + "refs": { + } + }, + "DeleteSSHPublicKeyRequest": { + "base": null, + "refs": { + } + }, + "DeleteServerCertificateRequest": { + "base": null, + "refs": { + } + }, + "DeleteSigningCertificateRequest": { + "base": null, + "refs": { + } + }, + "DeleteUserPolicyRequest": { + "base": null, + "refs": { + } + }, + "DeleteUserRequest": { + "base": null, + "refs": { + } + }, + "DeleteVirtualMFADeviceRequest": { + "base": null, + "refs": { + } + }, + "DetachGroupPolicyRequest": { + "base": null, + "refs": { + } + }, + "DetachRolePolicyRequest": { + "base": null, + "refs": { + } + }, + "DetachUserPolicyRequest": { + "base": null, + "refs": { + } + }, + "DuplicateCertificateException": { + "base": "The request was rejected because the same certificate is associated with an IAM user in the account.
", + "refs": { + } + }, + "DuplicateSSHPublicKeyException": { + "base": "The request was rejected because the SSH public key is already associated with the specified IAM user.
", + "refs": { + } + }, + "EnableMFADeviceRequest": { + "base": null, + "refs": { + } + }, + "EntityAlreadyExistsException": { + "base": "The request was rejected because it attempted to create a resource that already exists.
", + "refs": { + } + }, + "EntityTemporarilyUnmodifiableException": { + "base": "The request was rejected because it referenced an entity that is temporarily unmodifiable, such as a user name that was deleted and then recreated. The error indicates that the request is likely to succeed if you try again after waiting several minutes. The error message describes the entity.
", + "refs": { + } + }, + "EntityType": { + "base": null, + "refs": { + "ListEntitiesForPolicyRequest$EntityFilter": "The entity type to use for filtering the results.
For example, when EntityFilter is Role, only the roles that are attached to the specified policy are returned. This parameter is optional. If it is not included, all attached entities (users, groups, and roles) are returned. The argument for this parameter must be one of the valid values listed below.
Additional details about the results of the evaluation decision. When there are both IAM policies and resource policies, this parameter explains how each set of policies contributes to the final evaluation decision. When simulating cross-account access to a resource, both the resource-based policy and the caller's IAM policy must grant access. See How IAM Roles Differ from Resource-based Policies
", + "ResourceSpecificResult$EvalDecisionDetails": "Additional details about the results of the evaluation decision. When there are both IAM policies and resource policies, this parameter explains how each set of policies contributes to the final evaluation decision. When simulating cross-account access to a resource, both the resource-based policy and the caller's IAM policy must grant access.
" + } + }, + "EvalDecisionSourceType": { + "base": null, + "refs": { + "EvalDecisionDetailsType$key": null + } + }, + "EvaluationResult": { + "base": "Contains the results of a simulation.
This data type is used by the return parameter of SimulateCustomPolicy and SimulatePrincipalPolicy .
The results of the simulation.
" + } + }, + "GenerateCredentialReportResponse": { + "base": "Contains the response to a successful GenerateCredentialReport request.
", + "refs": { + } + }, + "GetAccessKeyLastUsedRequest": { + "base": null, + "refs": { + } + }, + "GetAccessKeyLastUsedResponse": { + "base": "Contains the response to a successful GetAccessKeyLastUsed request. It is also returned as a member of the AccessKeyMetaData structure returned by the ListAccessKeys action.
", + "refs": { + } + }, + "GetAccountAuthorizationDetailsRequest": { + "base": null, + "refs": { + } + }, + "GetAccountAuthorizationDetailsResponse": { + "base": "Contains the response to a successful GetAccountAuthorizationDetails request.
", + "refs": { + } + }, + "GetAccountPasswordPolicyResponse": { + "base": "Contains the response to a successful GetAccountPasswordPolicy request.
", + "refs": { + } + }, + "GetAccountSummaryResponse": { + "base": "Contains the response to a successful GetAccountSummary request.
", + "refs": { + } + }, + "GetContextKeysForCustomPolicyRequest": { + "base": null, + "refs": { + } + }, + "GetContextKeysForPolicyResponse": { + "base": "Contains the response to a successful GetContextKeysForPrincipalPolicy or GetContextKeysForCustomPolicy request.
", + "refs": { + } + }, + "GetContextKeysForPrincipalPolicyRequest": { + "base": null, + "refs": { + } + }, + "GetCredentialReportResponse": { + "base": "Contains the response to a successful GetCredentialReport request.
", + "refs": { + } + }, + "GetGroupPolicyRequest": { + "base": null, + "refs": { + } + }, + "GetGroupPolicyResponse": { + "base": "Contains the response to a successful GetGroupPolicy request.
", + "refs": { + } + }, + "GetGroupRequest": { + "base": null, + "refs": { + } + }, + "GetGroupResponse": { + "base": "Contains the response to a successful GetGroup request.
", + "refs": { + } + }, + "GetInstanceProfileRequest": { + "base": null, + "refs": { + } + }, + "GetInstanceProfileResponse": { + "base": "Contains the response to a successful GetInstanceProfile request.
", + "refs": { + } + }, + "GetLoginProfileRequest": { + "base": null, + "refs": { + } + }, + "GetLoginProfileResponse": { + "base": "Contains the response to a successful GetLoginProfile request.
", + "refs": { + } + }, + "GetOpenIDConnectProviderRequest": { + "base": null, + "refs": { + } + }, + "GetOpenIDConnectProviderResponse": { + "base": "Contains the response to a successful GetOpenIDConnectProvider request.
", + "refs": { + } + }, + "GetPolicyRequest": { + "base": null, + "refs": { + } + }, + "GetPolicyResponse": { + "base": "Contains the response to a successful GetPolicy request.
", + "refs": { + } + }, + "GetPolicyVersionRequest": { + "base": null, + "refs": { + } + }, + "GetPolicyVersionResponse": { + "base": "Contains the response to a successful GetPolicyVersion request.
", + "refs": { + } + }, + "GetRolePolicyRequest": { + "base": null, + "refs": { + } + }, + "GetRolePolicyResponse": { + "base": "Contains the response to a successful GetRolePolicy request.
", + "refs": { + } + }, + "GetRoleRequest": { + "base": null, + "refs": { + } + }, + "GetRoleResponse": { + "base": "Contains the response to a successful GetRole request.
", + "refs": { + } + }, + "GetSAMLProviderRequest": { + "base": null, + "refs": { + } + }, + "GetSAMLProviderResponse": { + "base": "Contains the response to a successful GetSAMLProvider request.
", + "refs": { + } + }, + "GetSSHPublicKeyRequest": { + "base": null, + "refs": { + } + }, + "GetSSHPublicKeyResponse": { + "base": "Contains the response to a successful GetSSHPublicKey request.
", + "refs": { + } + }, + "GetServerCertificateRequest": { + "base": null, + "refs": { + } + }, + "GetServerCertificateResponse": { + "base": "Contains the response to a successful GetServerCertificate request.
", + "refs": { + } + }, + "GetUserPolicyRequest": { + "base": null, + "refs": { + } + }, + "GetUserPolicyResponse": { + "base": "Contains the response to a successful GetUserPolicy request.
", + "refs": { + } + }, + "GetUserRequest": { + "base": null, + "refs": { + } + }, + "GetUserResponse": { + "base": "Contains the response to a successful GetUser request.
", + "refs": { + } + }, + "Group": { + "base": "Contains information about an IAM group entity.
This data type is used as a response element in the following actions:
", + "refs": { + "CreateGroupResponse$Group": "A structure containing details about the new group.
", + "GetGroupResponse$Group": "A structure that contains details about the group.
", + "groupListType$member": null + } + }, + "GroupDetail": { + "base": "Contains information about an IAM group, including all of the group's policies.
This data type is used as a response element in the GetAccountAuthorizationDetails action.
", + "refs": { + "groupDetailListType$member": null + } + }, + "InstanceProfile": { + "base": "Contains information about an instance profile.
This data type is used as a response element in the following actions:
", + "refs": { + "CreateInstanceProfileResponse$InstanceProfile": "A structure containing details about the new instance profile.
", + "GetInstanceProfileResponse$InstanceProfile": "A structure containing details about the instance profile.
", + "instanceProfileListType$member": null + } + }, + "InvalidAuthenticationCodeException": { + "base": "The request was rejected because the authentication code was not recognized. The error message describes the specific error.
", + "refs": { + } + }, + "InvalidCertificateException": { + "base": "The request was rejected because the certificate is invalid.
", + "refs": { + } + }, + "InvalidInputException": { + "base": "The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
", + "refs": { + } + }, + "InvalidPublicKeyException": { + "base": "The request was rejected because the public key is malformed or otherwise invalid.
", + "refs": { + } + }, + "InvalidUserTypeException": { + "base": "The request was rejected because the type of user for the transaction was incorrect.
", + "refs": { + } + }, + "KeyPairMismatchException": { + "base": "The request was rejected because the public key certificate and the private key do not match.
", + "refs": { + } + }, + "LimitExceededException": { + "base": "The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.
", + "refs": { + } + }, + "LineNumber": { + "base": null, + "refs": { + "Position$Line": "The line containing the specified position in the document.
" + } + }, + "ListAccessKeysRequest": { + "base": null, + "refs": { + } + }, + "ListAccessKeysResponse": { + "base": "Contains the response to a successful ListAccessKeys request.
", + "refs": { + } + }, + "ListAccountAliasesRequest": { + "base": null, + "refs": { + } + }, + "ListAccountAliasesResponse": { + "base": "Contains the response to a successful ListAccountAliases request.
", + "refs": { + } + }, + "ListAttachedGroupPoliciesRequest": { + "base": null, + "refs": { + } + }, + "ListAttachedGroupPoliciesResponse": { + "base": "Contains the response to a successful ListAttachedGroupPolicies request.
", + "refs": { + } + }, + "ListAttachedRolePoliciesRequest": { + "base": null, + "refs": { + } + }, + "ListAttachedRolePoliciesResponse": { + "base": "Contains the response to a successful ListAttachedRolePolicies request.
", + "refs": { + } + }, + "ListAttachedUserPoliciesRequest": { + "base": null, + "refs": { + } + }, + "ListAttachedUserPoliciesResponse": { + "base": "Contains the response to a successful ListAttachedUserPolicies request.
", + "refs": { + } + }, + "ListEntitiesForPolicyRequest": { + "base": null, + "refs": { + } + }, + "ListEntitiesForPolicyResponse": { + "base": "Contains the response to a successful ListEntitiesForPolicy request.
", + "refs": { + } + }, + "ListGroupPoliciesRequest": { + "base": null, + "refs": { + } + }, + "ListGroupPoliciesResponse": { + "base": "Contains the response to a successful ListGroupPolicies request.
", + "refs": { + } + }, + "ListGroupsForUserRequest": { + "base": null, + "refs": { + } + }, + "ListGroupsForUserResponse": { + "base": "Contains the response to a successful ListGroupsForUser request.
", + "refs": { + } + }, + "ListGroupsRequest": { + "base": null, + "refs": { + } + }, + "ListGroupsResponse": { + "base": "Contains the response to a successful ListGroups request.
", + "refs": { + } + }, + "ListInstanceProfilesForRoleRequest": { + "base": null, + "refs": { + } + }, + "ListInstanceProfilesForRoleResponse": { + "base": "Contains the response to a successful ListInstanceProfilesForRole request.
", + "refs": { + } + }, + "ListInstanceProfilesRequest": { + "base": null, + "refs": { + } + }, + "ListInstanceProfilesResponse": { + "base": "Contains the response to a successful ListInstanceProfiles request.
", + "refs": { + } + }, + "ListMFADevicesRequest": { + "base": null, + "refs": { + } + }, + "ListMFADevicesResponse": { + "base": "Contains the response to a successful ListMFADevices request.
", + "refs": { + } + }, + "ListOpenIDConnectProvidersRequest": { + "base": null, + "refs": { + } + }, + "ListOpenIDConnectProvidersResponse": { + "base": "Contains the response to a successful ListOpenIDConnectProviders request.
", + "refs": { + } + }, + "ListPoliciesRequest": { + "base": null, + "refs": { + } + }, + "ListPoliciesResponse": { + "base": "Contains the response to a successful ListPolicies request.
", + "refs": { + } + }, + "ListPolicyVersionsRequest": { + "base": null, + "refs": { + } + }, + "ListPolicyVersionsResponse": { + "base": "Contains the response to a successful ListPolicyVersions request.
", + "refs": { + } + }, + "ListRolePoliciesRequest": { + "base": null, + "refs": { + } + }, + "ListRolePoliciesResponse": { + "base": "Contains the response to a successful ListRolePolicies request.
", + "refs": { + } + }, + "ListRolesRequest": { + "base": null, + "refs": { + } + }, + "ListRolesResponse": { + "base": "Contains the response to a successful ListRoles request.
", + "refs": { + } + }, + "ListSAMLProvidersRequest": { + "base": null, + "refs": { + } + }, + "ListSAMLProvidersResponse": { + "base": "Contains the response to a successful ListSAMLProviders request.
", + "refs": { + } + }, + "ListSSHPublicKeysRequest": { + "base": null, + "refs": { + } + }, + "ListSSHPublicKeysResponse": { + "base": "Contains the response to a successful ListSSHPublicKeys request.
", + "refs": { + } + }, + "ListServerCertificatesRequest": { + "base": null, + "refs": { + } + }, + "ListServerCertificatesResponse": { + "base": "Contains the response to a successful ListServerCertificates request.
", + "refs": { + } + }, + "ListSigningCertificatesRequest": { + "base": null, + "refs": { + } + }, + "ListSigningCertificatesResponse": { + "base": "Contains the response to a successful ListSigningCertificates request.
", + "refs": { + } + }, + "ListUserPoliciesRequest": { + "base": null, + "refs": { + } + }, + "ListUserPoliciesResponse": { + "base": "Contains the response to a successful ListUserPolicies request.
", + "refs": { + } + }, + "ListUsersRequest": { + "base": null, + "refs": { + } + }, + "ListUsersResponse": { + "base": "Contains the response to a successful ListUsers request.
", + "refs": { + } + }, + "ListVirtualMFADevicesRequest": { + "base": null, + "refs": { + } + }, + "ListVirtualMFADevicesResponse": { + "base": "Contains the response to a successful ListVirtualMFADevices request.
", + "refs": { + } + }, + "LoginProfile": { + "base": "Contains the user name and password create date for a user.
This data type is used as a response element in the CreateLoginProfile and GetLoginProfile actions.
", + "refs": { + "CreateLoginProfileResponse$LoginProfile": "A structure containing the user name and password create date.
", + "GetLoginProfileResponse$LoginProfile": "A structure containing the user name and password create date for the user.
" + } + }, + "MFADevice": { + "base": "Contains information about an MFA device.
This data type is used as a response element in the ListMFADevices action.
", + "refs": { + "mfaDeviceListType$member": null + } + }, + "MalformedCertificateException": { + "base": "The request was rejected because the certificate was malformed or expired. The error message describes the specific error.
", + "refs": { + } + }, + "MalformedPolicyDocumentException": { + "base": "The request was rejected because the policy document was malformed. The error message describes the specific error.
", + "refs": { + } + }, + "ManagedPolicyDetail": { + "base": "Contains information about a managed policy, including the policy's ARN, versions, and the number of principal entities (users, groups, and roles) that the policy is attached to.
This data type is used as a response element in the GetAccountAuthorizationDetails action.
For more information about managed policies, see Managed Policies and Inline Policies in the Using IAM guide.
", + "refs": { + "ManagedPolicyDetailListType$member": null + } + }, + "ManagedPolicyDetailListType": { + "base": null, + "refs": { + "GetAccountAuthorizationDetailsResponse$Policies": "A list containing information about managed policies.
" + } + }, + "NoSuchEntityException": { + "base": "The request was rejected because it referenced an entity that does not exist. The error message describes the entity.
", + "refs": { + } + }, + "OpenIDConnectProviderListEntry": { + "base": "Contains the Amazon Resource Name (ARN) for an IAM OpenID Connect provider.
", + "refs": { + "OpenIDConnectProviderListType$member": null + } + }, + "OpenIDConnectProviderListType": { + "base": "Contains a list of IAM OpenID Connect providers.
", + "refs": { + "ListOpenIDConnectProvidersResponse$OpenIDConnectProviderList": "The list of IAM OIDC provider resource objects defined in the AWS account.
" + } + }, + "OpenIDConnectProviderUrlType": { + "base": "Contains a URL that specifies the endpoint for an OpenID Connect provider.
", + "refs": { + "CreateOpenIDConnectProviderRequest$Url": "The URL of the identity provider. The URL must begin with \"https://\" and should correspond to the iss claim in the provider's OpenID Connect ID tokens. Per the OIDC standard, path components are allowed but query parameters are not. Typically the URL consists of only a host name, like \"https://server.example.org\" or \"https://example.com\".
You cannot register the same provider multiple times in a single AWS account. If you try to submit a URL that has already been used for an OpenID Connect provider in the AWS account, you will get an error.
", + "GetOpenIDConnectProviderResponse$Url": "The URL that the IAM OIDC provider resource object is associated with. For more information, see CreateOpenIDConnectProvider.
" + } + }, + "PasswordPolicy": { + "base": "Contains information about the account password policy.
This data type is used as a response element in the GetAccountPasswordPolicy action.
", + "refs": { + "GetAccountPasswordPolicyResponse$PasswordPolicy": null + } + }, + "PasswordPolicyViolationException": { + "base": "The request was rejected because the provided password did not meet the requirements imposed by the account password policy.
", + "refs": { + } + }, + "Policy": { + "base": "Contains information about a managed policy.
This data type is used as a response element in the CreatePolicy, GetPolicy, and ListPolicies actions.
For more information about managed policies, refer to Managed Policies and Inline Policies in the Using IAM guide.
", + "refs": { + "CreatePolicyResponse$Policy": "A structure containing details about the new policy.
", + "GetPolicyResponse$Policy": "A structure containing details about the policy.
", + "policyListType$member": null + } + }, + "PolicyDetail": { + "base": "Contains information about an IAM policy, including the policy document.
This data type is used as a response element in the GetAccountAuthorizationDetails action.
", + "refs": { + "policyDetailListType$member": null + } + }, + "PolicyEvaluationDecisionType": { + "base": null, + "refs": { + "EvalDecisionDetailsType$value": null, + "EvaluationResult$EvalDecision": "The result of the simulation.
", + "ResourceSpecificResult$EvalResourceDecision": "The result of the simulation of the simulated API action on the resource specified in EvalResourceName.
The request failed because a provided policy could not be successfully evaluated. An additional detail message indicates the source of the failure.
", + "refs": { + } + }, + "PolicyGroup": { + "base": "Contains information about a group that a managed policy is attached to.
This data type is used as a response element in the ListEntitiesForPolicy action.
For more information about managed policies, refer to Managed Policies and Inline Policies in the Using IAM guide.
", + "refs": { + "PolicyGroupListType$member": null + } + }, + "PolicyGroupListType": { + "base": null, + "refs": { + "ListEntitiesForPolicyResponse$PolicyGroups": "A list of IAM groups that the policy is attached to.
" + } + }, + "PolicyIdentifierType": { + "base": null, + "refs": { + "Statement$SourcePolicyId": "The identifier of the policy that was provided as an input.
" + } + }, + "PolicyRole": { + "base": "Contains information about a role that a managed policy is attached to.
This data type is used as a response element in the ListEntitiesForPolicy action.
For more information about managed policies, refer to Managed Policies and Inline Policies in the Using IAM guide.
", + "refs": { + "PolicyRoleListType$member": null + } + }, + "PolicyRoleListType": { + "base": null, + "refs": { + "ListEntitiesForPolicyResponse$PolicyRoles": "A list of IAM roles that the policy is attached to.
" + } + }, + "PolicySourceType": { + "base": null, + "refs": { + "Statement$SourcePolicyType": "The type of the policy.
" + } + }, + "PolicyUser": { + "base": "Contains information about a user that a managed policy is attached to.
This data type is used as a response element in the ListEntitiesForPolicy action.
For more information about managed policies, refer to Managed Policies and Inline Policies in the Using IAM guide.
", + "refs": { + "PolicyUserListType$member": null + } + }, + "PolicyUserListType": { + "base": null, + "refs": { + "ListEntitiesForPolicyResponse$PolicyUsers": "A list of IAM users that the policy is attached to.
" + } + }, + "PolicyVersion": { + "base": "Contains information about a version of a managed policy.
This data type is used as a response element in the CreatePolicyVersion, GetPolicyVersion, ListPolicyVersions, and GetAccountAuthorizationDetails actions.
For more information about managed policies, refer to Managed Policies and Inline Policies in the Using IAM guide.
", + "refs": { + "CreatePolicyVersionResponse$PolicyVersion": "A structure containing details about the new policy version.
", + "GetPolicyVersionResponse$PolicyVersion": "A structure containing details about the policy version.
", + "policyDocumentVersionListType$member": null + } + }, + "Position": { + "base": "Contains the row and column of a location of a Statement element in a policy document.
This data type is used as a member of the Statement type.
The row and column of the beginning of the Statement in an IAM policy.
The row and column of the end of a Statement in an IAM policy.
Contains the credential report. The report is Base64-encoded.
" + } + }, + "ReportFormatType": { + "base": null, + "refs": { + "GetCredentialReportResponse$ReportFormat": "The format (MIME type) of the credential report.
" + } + }, + "ReportStateDescriptionType": { + "base": null, + "refs": { + "GenerateCredentialReportResponse$Description": "Information about the credential report.
" + } + }, + "ReportStateType": { + "base": null, + "refs": { + "GenerateCredentialReportResponse$State": "Information about the state of the credential report.
" + } + }, + "ResourceHandlingOptionType": { + "base": null, + "refs": { + "SimulateCustomPolicyRequest$ResourceHandlingOption": "Specifies the type of simulation to run. Different APIs that support resource-based policies require different combinations of resources. By specifying the type of simulation to run, you enable the policy simulator to enforce the presence of the required resources to ensure reliable simulation results. If your simulation does not match one of the following scenarios, then you can omit this parameter. The following list shows each of the supported scenario values and the resources that you must define to run the simulation.
Each of the EC2 scenarios requires that you specify instance, image, and security-group resources. If your scenario includes an EBS volume, then you must specify that volume as a resource. If the EC2 scenario includes VPC, then you must supply the network-interface resource. If it includes an IP subnet, then you must specify the subnet resource. For more information on the EC2 scenario options, see Supported Platforms in the AWS EC2 User Guide.
EC2-Classic-InstanceStore
instance, image, security-group
EC2-Classic-EBS
instance, image, security-group, volume
EC2-VPC-InstanceStore
instance, image, security-group, network-interface
EC2-VPC-InstanceStore-Subnet
instance, image, security-group, network-interface, subnet
EC2-VPC-EBS
instance, image, security-group, network-interface, volume
EC2-VPC-EBS-Subnet
instance, image, security-group, network-interface, subnet, volume
Specifies the type of simulation to run. Different APIs that support resource-based policies require different combinations of resources. By specifying the type of simulation to run, you enable the policy simulator to enforce the presence of the required resources to ensure reliable simulation results. If your simulation does not match one of the following scenarios, then you can omit this parameter. The following list shows each of the supported scenario values and the resources that you must define to run the simulation.
Each of the EC2 scenarios requires that you specify instance, image, and security-group resources. If your scenario includes an EBS volume, then you must specify that volume as a resource. If the EC2 scenario includes VPC, then you must supply the network-interface resource. If it includes an IP subnet, then you must specify the subnet resource. For more information on the EC2 scenario options, see Supported Platforms in the AWS EC2 User Guide.
EC2-Classic-InstanceStore
instance, image, security-group
EC2-Classic-EBS
instance, image, security-group, volume
EC2-VPC-InstanceStore
instance, image, security-group, network-interface
EC2-VPC-InstanceStore-Subnet
instance, image, security-group, network-interface, subnet
EC2-VPC-EBS
instance, image, security-group, network-interface, volume
EC2-VPC-EBS-Subnet
instance, image, security-group, network-interface, subnet, volume
A list of ARNs of AWS resources to include in the simulation. If this parameter is not provided then the value defaults to * (all resources). Each API in the ActionNames parameter is evaluated for each resource in this list. The simulation determines the access result (allowed or denied) of each combination and reports it in the response.
The simulation does not automatically retrieve policies for the specified resources. If you want to include a resource policy in the simulation, then you must include the policy as a string in the ResourcePolicy parameter.
If you include a ResourcePolicy, then it must be applicable to all of the resources included in the simulation or you receive an invalid input error.
For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
", + "SimulatePrincipalPolicyRequest$ResourceArns": "A list of ARNs of AWS resources to include in the simulation. If this parameter is not provided then the value defaults to * (all resources). Each API in the ActionNames parameter is evaluated for each resource in this list. The simulation determines the access result (allowed or denied) of each combination and reports it in the response.
The simulation does not automatically retrieve policies for the specified resources. If you want to include a resource policy in the simulation, then you must include the policy as a string in the ResourcePolicy parameter.
For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
" + } + }, + "ResourceNameType": { + "base": null, + "refs": { + "EvaluationResult$EvalResourceName": "The ARN of the resource that the indicated API action was tested on.
", + "ResourceNameListType$member": null, + "ResourceSpecificResult$EvalResourceName": "The name of the simulated resource, in Amazon Resource Name (ARN) format.
", + "SimulateCustomPolicyRequest$ResourceOwner": "An AWS account ID that specifies the owner of any simulated resource that does not identify its owner in the resource ARN, such as an S3 bucket or object. If ResourceOwner is specified, it is also used as the account owner of any ResourcePolicy included in the simulation. If the ResourceOwner parameter is not specified, then the owner of the resources and the resource policy defaults to the account of the identity provided in CallerArn. This parameter is required only if you specify a resource-based policy and account that owns the resource is different from the account that owns the simulated calling user CallerArn.
The ARN of the IAM user that you want to use as the simulated caller of the APIs. CallerArn is required if you include a ResourcePolicy so that the policy's Principal element has a value to use in evaluating the policy.
You can specify only the ARN of an IAM user. You cannot specify the ARN of an assumed role, federated user, or a service principal.
", + "SimulatePrincipalPolicyRequest$ResourceOwner": "An AWS account ID that specifies the owner of any simulated resource that does not identify its owner in the resource ARN, such as an S3 bucket or object. If ResourceOwner is specified, it is also used as the account owner of any ResourcePolicy included in the simulation. If the ResourceOwner parameter is not specified, then the owner of the resources and the resource policy defaults to the account of the identity provided in CallerArn. This parameter is required only if you specify a resource-based policy and account that owns the resource is different from the account that owns the simulated calling user CallerArn.
The ARN of the IAM user that you want to specify as the simulated caller of the APIs. If you do not specify a CallerArn, it defaults to the ARN of the user that you specify in PolicySourceArn, if you specified a user. If you include both a PolicySourceArn (for example, arn:aws:iam::123456789012:user/David) and a CallerArn (for example, arn:aws:iam::123456789012:user/Bob), the result is that you simulate calling the APIs as Bob, as if Bob had David's policies.
You can specify only the ARN of an IAM user. You cannot specify the ARN of an assumed role, federated user, or a service principal.
CallerArn is required if you include a ResourcePolicy and the PolicySourceArn is not the ARN for an IAM user. This is required so that the resource-based policy's Principal element has a value to use in evaluating the policy.
For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
" + } + }, + "ResourceSpecificResult": { + "base": "Contains the result of the simulation of a single API action call on a single resource.
This data type is used by a member of the EvaluationResult data type.
", + "refs": { + "ResourceSpecificResultListType$member": null + } + }, + "ResourceSpecificResultListType": { + "base": null, + "refs": { + "EvaluationResult$ResourceSpecificResults": "The individual results of the simulation of the API action specified in EvalActionName on each resource.
" + } + }, + "ResyncMFADeviceRequest": { + "base": null, + "refs": { + } + }, + "Role": { + "base": "Contains information about an IAM role.
This data type is used as a response element in the following actions:
", + "refs": { + "CreateRoleResponse$Role": "A structure containing details about the new role.
", + "GetRoleResponse$Role": "A structure containing details about the IAM role.
", + "roleListType$member": null + } + }, + "RoleDetail": { + "base": "Contains information about an IAM role, including all of the role's policies.
This data type is used as a response element in the GetAccountAuthorizationDetails action.
", + "refs": { + "roleDetailListType$member": null + } + }, + "SAMLMetadataDocumentType": { + "base": null, + "refs": { + "CreateSAMLProviderRequest$SAMLMetadataDocument": "An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your organization's IdP.
For more information, see About SAML 2.0-based Federation in the IAM User Guide
", + "GetSAMLProviderResponse$SAMLMetadataDocument": "The XML metadata document that includes information about an identity provider.
", + "UpdateSAMLProviderRequest$SAMLMetadataDocument": "An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your organization's IdP.
" + } + }, + "SAMLProviderListEntry": { + "base": "Contains the list of SAML providers for this account.
", + "refs": { + "SAMLProviderListType$member": null + } + }, + "SAMLProviderListType": { + "base": null, + "refs": { + "ListSAMLProvidersResponse$SAMLProviderList": "The list of SAML provider resource objects defined in IAM for this AWS account.
" + } + }, + "SAMLProviderNameType": { + "base": null, + "refs": { + "CreateSAMLProviderRequest$Name": "The name of the provider to create.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
" + } + }, + "SSHPublicKey": { + "base": "Contains information about an SSH public key.
This data type is used as a response element in the GetSSHPublicKey and UploadSSHPublicKey actions.
", + "refs": { + "GetSSHPublicKeyResponse$SSHPublicKey": "A structure containing details about the SSH public key.
", + "UploadSSHPublicKeyResponse$SSHPublicKey": "Contains information about the SSH public key.
" + } + }, + "SSHPublicKeyListType": { + "base": null, + "refs": { + "ListSSHPublicKeysResponse$SSHPublicKeys": "A list of the SSH public keys assigned to IAM user.
" + } + }, + "SSHPublicKeyMetadata": { + "base": "Contains information about an SSH public key, without the key's body or fingerprint.
This data type is used as a response element in the ListSSHPublicKeys action.
", + "refs": { + "SSHPublicKeyListType$member": null + } + }, + "ServerCertificate": { + "base": "Contains information about a server certificate.
This data type is used as a response element in the GetServerCertificate action.
", + "refs": { + "GetServerCertificateResponse$ServerCertificate": "A structure containing details about the server certificate.
" + } + }, + "ServerCertificateMetadata": { + "base": "Contains information about a server certificate without its certificate body, certificate chain, and private key.
This data type is used as a response element in the UploadServerCertificate and ListServerCertificates actions.
", + "refs": { + "ServerCertificate$ServerCertificateMetadata": "The meta information of the server certificate, such as its name, path, ID, and ARN.
", + "UploadServerCertificateResponse$ServerCertificateMetadata": "The meta information of the uploaded server certificate without its certificate body, certificate chain, and private key.
", + "serverCertificateMetadataListType$member": null + } + }, + "ServiceFailureException": { + "base": "The request processing has failed because of an unknown error, exception or failure.
", + "refs": { + } + }, + "SetDefaultPolicyVersionRequest": { + "base": null, + "refs": { + } + }, + "SigningCertificate": { + "base": "Contains information about an X.509 signing certificate.
This data type is used as a response element in the UploadSigningCertificate and ListSigningCertificates actions.
", + "refs": { + "UploadSigningCertificateResponse$Certificate": "Information about the certificate.
", + "certificateListType$member": null + } + }, + "SimulateCustomPolicyRequest": { + "base": null, + "refs": { + } + }, + "SimulatePolicyResponse": { + "base": "Contains the response to a successful SimulatePrincipalPolicy or SimulateCustomPolicy request.
", + "refs": { + } + }, + "SimulatePrincipalPolicyRequest": { + "base": null, + "refs": { + } + }, + "SimulationPolicyListType": { + "base": null, + "refs": { + "GetContextKeysForCustomPolicyRequest$PolicyInputList": "A list of policies for which you want the list of context keys referenced in those policies. Each document is specified as a string containing the complete, valid JSON text of an IAM policy.
The regex pattern for this parameter is a string of characters consisting of any printable ASCII character ranging from the space character (\\u0020) through end of the ASCII character range (\\u00FF). It also includes the special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D).
", + "GetContextKeysForPrincipalPolicyRequest$PolicyInputList": "An optional list of additional policies for which you want the list of context keys that are referenced.
The regex pattern for this parameter is a string of characters consisting of any printable ASCII character ranging from the space character (\\u0020) through end of the ASCII character range (\\u00FF). It also includes the special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D).
", + "SimulateCustomPolicyRequest$PolicyInputList": "A list of policy documents to include in the simulation. Each document is specified as a string containing the complete, valid JSON text of an IAM policy. Do not include any resource-based policies in this parameter. Any resource-based policy must be submitted with the ResourcePolicy parameter. The policies cannot be \"scope-down\" policies, such as you could include in a call to GetFederationToken or one of the AssumeRole APIs to restrict what a user can do while using the temporary credentials.
The regex pattern for this parameter is a string of characters consisting of any printable ASCII character ranging from the space character (\\u0020) through end of the ASCII character range (\\u00FF). It also includes the special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D).
", + "SimulatePrincipalPolicyRequest$PolicyInputList": "An optional list of additional policy documents to include in the simulation. Each document is specified as a string containing the complete, valid JSON text of an IAM policy.
The regex pattern for this parameter is a string of characters consisting of any printable ASCII character ranging from the space character (\\u0020) through end of the ASCII character range (\\u00FF). It also includes the special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D).
" + } + }, + "Statement": { + "base": "Contains a reference to a Statement element in a policy document that determines the result of the simulation.
This data type is used by the MatchedStatements member of the EvaluationResult type.
A list of the statements in the input policies that determine the result for this scenario. Remember that even if multiple statements allow the action on the resource, if only one statement denies that action, then the explicit deny overrides any allow, and the deny statement is the only entry included in the result.
", + "ResourceSpecificResult$MatchedStatements": "A list of the statements in the input policies that determine the result for this part of the simulation. Remember that even if multiple statements allow the action on the resource, if any statement denies that action, then the explicit deny overrides any allow, and the deny statement is the only entry included in the result.
" + } + }, + "UnrecognizedPublicKeyEncodingException": { + "base": "The request was rejected because the public key encoding format is unsupported or unrecognized.
", + "refs": { + } + }, + "UpdateAccessKeyRequest": { + "base": null, + "refs": { + } + }, + "UpdateAccountPasswordPolicyRequest": { + "base": null, + "refs": { + } + }, + "UpdateAssumeRolePolicyRequest": { + "base": null, + "refs": { + } + }, + "UpdateGroupRequest": { + "base": null, + "refs": { + } + }, + "UpdateLoginProfileRequest": { + "base": null, + "refs": { + } + }, + "UpdateOpenIDConnectProviderThumbprintRequest": { + "base": null, + "refs": { + } + }, + "UpdateSAMLProviderRequest": { + "base": null, + "refs": { + } + }, + "UpdateSAMLProviderResponse": { + "base": "Contains the response to a successful UpdateSAMLProvider request.
", + "refs": { + } + }, + "UpdateSSHPublicKeyRequest": { + "base": null, + "refs": { + } + }, + "UpdateServerCertificateRequest": { + "base": null, + "refs": { + } + }, + "UpdateSigningCertificateRequest": { + "base": null, + "refs": { + } + }, + "UpdateUserRequest": { + "base": null, + "refs": { + } + }, + "UploadSSHPublicKeyRequest": { + "base": null, + "refs": { + } + }, + "UploadSSHPublicKeyResponse": { + "base": "Contains the response to a successful UploadSSHPublicKey request.
", + "refs": { + } + }, + "UploadServerCertificateRequest": { + "base": null, + "refs": { + } + }, + "UploadServerCertificateResponse": { + "base": "Contains the response to a successful UploadServerCertificate request.
", + "refs": { + } + }, + "UploadSigningCertificateRequest": { + "base": null, + "refs": { + } + }, + "UploadSigningCertificateResponse": { + "base": "Contains the response to a successful UploadSigningCertificate request.
", + "refs": { + } + }, + "User": { + "base": "Contains information about an IAM user entity.
This data type is used as a response element in the following actions:
", + "refs": { + "CreateUserResponse$User": "A structure with details about the new IAM user.
", + "GetUserResponse$User": "A structure containing details about the IAM user.
", + "VirtualMFADevice$User": null, + "userListType$member": null + } + }, + "UserDetail": { + "base": "Contains information about an IAM user, including all the user's policies and all the IAM groups the user is in.
This data type is used as a response element in the GetAccountAuthorizationDetails action.
", + "refs": { + "userDetailListType$member": null + } + }, + "VirtualMFADevice": { + "base": "Contains information about a virtual MFA device.
", + "refs": { + "CreateVirtualMFADeviceResponse$VirtualMFADevice": "A structure containing details about the new virtual MFA device.
", + "virtualMFADeviceListType$member": null + } + }, + "accessKeyIdType": { + "base": null, + "refs": { + "AccessKey$AccessKeyId": "The ID for this access key.
", + "AccessKeyMetadata$AccessKeyId": "The ID for this access key.
", + "DeleteAccessKeyRequest$AccessKeyId": "The access key ID for the access key ID and secret access key you want to delete.
The regex pattern for this parameter is a string of characters that can consist of any upper or lowercased letter or digit.
", + "GetAccessKeyLastUsedRequest$AccessKeyId": "The identifier of an access key.
The regex pattern for this parameter is a string of characters that can consist of any upper or lowercased letter or digit.
", + "UpdateAccessKeyRequest$AccessKeyId": "The access key ID of the secret access key you want to update.
The regex pattern for this parameter is a string of characters that can consist of any upper or lowercased letter or digit.
" + } + }, + "accessKeyMetadataListType": { + "base": "Contains a list of access key metadata.
This data type is used as a response element in the ListAccessKeys action.
", + "refs": { + "ListAccessKeysResponse$AccessKeyMetadata": "A list of objects containing metadata about the access keys.
" + } + }, + "accessKeySecretType": { + "base": null, + "refs": { + "AccessKey$SecretAccessKey": "The secret key used to sign requests.
" + } + }, + "accountAliasListType": { + "base": null, + "refs": { + "ListAccountAliasesResponse$AccountAliases": "A list of aliases associated with the account. AWS supports only one alias per account.
" + } + }, + "accountAliasType": { + "base": null, + "refs": { + "CreateAccountAliasRequest$AccountAlias": "The account alias to create.
The regex pattern for this parameter is a string of characters consisting of lowercase letters, digits, and dashes. You cannot start or finish with a dash, nor can you have two dashes in a row.
", + "DeleteAccountAliasRequest$AccountAlias": "The name of the account alias to delete.
The regex pattern for this parameter is a string of characters consisting of lowercase letters, digits, and dashes. You cannot start or finish with a dash, nor can you have two dashes in a row.
", + "accountAliasListType$member": null + } + }, + "arnType": { + "base": "The Amazon Resource Name (ARN). ARNs are unique identifiers for AWS resources.
For more information about ARNs, go to Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
", + "refs": { + "AddClientIDToOpenIDConnectProviderRequest$OpenIDConnectProviderArn": "The Amazon Resource Name (ARN) of the IAM OpenID Connect (OIDC) provider resource to add the client ID to. You can get a list of OIDC provider ARNs by using the ListOpenIDConnectProviders action.
", + "AttachGroupPolicyRequest$PolicyArn": "The Amazon Resource Name (ARN) of the IAM policy you want to attach.
For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
", + "AttachRolePolicyRequest$PolicyArn": "The Amazon Resource Name (ARN) of the IAM policy you want to attach.
For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
", + "AttachUserPolicyRequest$PolicyArn": "The Amazon Resource Name (ARN) of the IAM policy you want to attach.
For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
", + "AttachedPolicy$PolicyArn": null, + "CreateOpenIDConnectProviderResponse$OpenIDConnectProviderArn": "The Amazon Resource Name (ARN) of the new IAM OpenID Connect provider that is created. For more information, see OpenIDConnectProviderListEntry.
", + "CreatePolicyVersionRequest$PolicyArn": "The Amazon Resource Name (ARN) of the IAM policy to which you want to add a new version.
For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
", + "CreateSAMLProviderResponse$SAMLProviderArn": "The Amazon Resource Name (ARN) of the new SAML provider resource in IAM.
", + "DeleteOpenIDConnectProviderRequest$OpenIDConnectProviderArn": "The Amazon Resource Name (ARN) of the IAM OpenID Connect provider resource object to delete. You can get a list of OpenID Connect provider resource ARNs by using the ListOpenIDConnectProviders action.
", + "DeletePolicyRequest$PolicyArn": "The Amazon Resource Name (ARN) of the IAM policy you want to delete.
For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
", + "DeletePolicyVersionRequest$PolicyArn": "The Amazon Resource Name (ARN) of the IAM policy from which you want to delete a version.
For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
", + "DeleteSAMLProviderRequest$SAMLProviderArn": "The Amazon Resource Name (ARN) of the SAML provider to delete.
", + "DetachGroupPolicyRequest$PolicyArn": "The Amazon Resource Name (ARN) of the IAM policy you want to detach.
For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
", + "DetachRolePolicyRequest$PolicyArn": "The Amazon Resource Name (ARN) of the IAM policy you want to detach.
For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
", + "DetachUserPolicyRequest$PolicyArn": "The Amazon Resource Name (ARN) of the IAM policy you want to detach.
For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
", + "GetContextKeysForPrincipalPolicyRequest$PolicySourceArn": "The ARN of a user, group, or role whose policies contain the context keys that you want listed. If you specify a user, the list includes context keys that are found in all policies attached to the user as well as to all groups that the user is a member of. If you pick a group or a role, then it includes only those context keys that are found in policies attached to that entity. Note that all parameters are shown in unencoded form here for clarity, but must be URL encoded to be included as a part of a real HTML request.
For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
", + "GetOpenIDConnectProviderRequest$OpenIDConnectProviderArn": "The Amazon Resource Name (ARN) of the OIDC provider resource object in IAM to get information for. You can get a list of OIDC provider resource ARNs by using the ListOpenIDConnectProviders action.
For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
", + "GetPolicyRequest$PolicyArn": "The Amazon Resource Name (ARN) of the managed policy that you want information about.
For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
", + "GetPolicyVersionRequest$PolicyArn": "The Amazon Resource Name (ARN) of the managed policy that you want information about.
For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
", + "GetSAMLProviderRequest$SAMLProviderArn": "The Amazon Resource Name (ARN) of the SAML provider resource object in IAM to get information about.
For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
", + "Group$Arn": "The Amazon Resource Name (ARN) specifying the group. For more information about ARNs and how to use them in policies, see IAM Identifiers in the Using IAM guide.
", + "GroupDetail$Arn": null, + "InstanceProfile$Arn": "The Amazon Resource Name (ARN) specifying the instance profile. For more information about ARNs and how to use them in policies, see IAM Identifiers in the Using IAM guide.
", + "ListEntitiesForPolicyRequest$PolicyArn": "The Amazon Resource Name (ARN) of the IAM policy for which you want the versions.
For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
", + "ListPolicyVersionsRequest$PolicyArn": "The Amazon Resource Name (ARN) of the IAM policy for which you want the versions.
For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
", + "ManagedPolicyDetail$Arn": null, + "OpenIDConnectProviderListEntry$Arn": null, + "Policy$Arn": null, + "RemoveClientIDFromOpenIDConnectProviderRequest$OpenIDConnectProviderArn": "The Amazon Resource Name (ARN) of the IAM OIDC provider resource to remove the client ID from. You can get a list of OIDC provider ARNs by using the ListOpenIDConnectProviders action.
For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
", + "Role$Arn": "The Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how to use them in policies, see IAM Identifiers in the Using IAM guide.
", + "RoleDetail$Arn": null, + "SAMLProviderListEntry$Arn": "The Amazon Resource Name (ARN) of the SAML provider.
", + "ServerCertificateMetadata$Arn": "The Amazon Resource Name (ARN) specifying the server certificate. For more information about ARNs and how to use them in policies, see IAM Identifiers in the Using IAM guide.
", + "SetDefaultPolicyVersionRequest$PolicyArn": "The Amazon Resource Name (ARN) of the IAM policy whose default version you want to set.
For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
", + "SimulatePrincipalPolicyRequest$PolicySourceArn": "The Amazon Resource Name (ARN) of a user, group, or role whose policies you want to include in the simulation. If you specify a user, group, or role, the simulation includes all policies that are associated with that entity. If you specify a user, the simulation also includes all policies that are attached to any groups the user belongs to.
For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
", + "UpdateOpenIDConnectProviderThumbprintRequest$OpenIDConnectProviderArn": "The Amazon Resource Name (ARN) of the IAM OIDC provider resource object for which you want to update the thumbprint. You can get a list of OIDC provider ARNs by using the ListOpenIDConnectProviders action.
For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
", + "UpdateSAMLProviderRequest$SAMLProviderArn": "The Amazon Resource Name (ARN) of the SAML provider to update.
For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
", + "UpdateSAMLProviderResponse$SAMLProviderArn": "The Amazon Resource Name (ARN) of the SAML provider that was updated.
", + "User$Arn": "The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and how to use ARNs in policies, see IAM Identifiers in the Using IAM guide.
", + "UserDetail$Arn": null + } + }, + "assignmentStatusType": { + "base": null, + "refs": { + "ListVirtualMFADevicesRequest$AssignmentStatus": " The status (Unassigned or Assigned) of the devices to list. If you do not specify an AssignmentStatus, the action defaults to Any which lists both assigned and unassigned virtual MFA devices.
A list of the managed policies attached to the group.
", + "ListAttachedGroupPoliciesResponse$AttachedPolicies": "A list of the attached policies.
", + "ListAttachedRolePoliciesResponse$AttachedPolicies": "A list of the attached policies.
", + "ListAttachedUserPoliciesResponse$AttachedPolicies": "A list of the attached policies.
", + "RoleDetail$AttachedManagedPolicies": "A list of managed policies attached to the role. These policies are the role's access (permissions) policies.
", + "UserDetail$AttachedManagedPolicies": "A list of the managed policies attached to the user.
" + } + }, + "attachmentCountType": { + "base": null, + "refs": { + "ManagedPolicyDetail$AttachmentCount": "The number of principal entities (users, groups, and roles) that the policy is attached to.
", + "Policy$AttachmentCount": "The number of entities (users, groups, and roles) that the policy is attached to.
" + } + }, + "authenticationCodeType": { + "base": null, + "refs": { + "EnableMFADeviceRequest$AuthenticationCode1": "An authentication code emitted by the device.
The format for this parameter is a string of 6 digits.
", + "EnableMFADeviceRequest$AuthenticationCode2": "A subsequent authentication code emitted by the device.
The format for this parameter is a string of 6 digits.
", + "ResyncMFADeviceRequest$AuthenticationCode1": "An authentication code emitted by the device.
The format for this parameter is a sequence of six digits.
", + "ResyncMFADeviceRequest$AuthenticationCode2": "A subsequent authentication code emitted by the device.
The format for this parameter is a sequence of six digits.
" + } + }, + "booleanObjectType": { + "base": null, + "refs": { + "PasswordPolicy$HardExpiry": "Specifies whether IAM users are prevented from setting a new password after their password has expired.
", + "UpdateAccountPasswordPolicyRequest$HardExpiry": "Prevents IAM users from setting a new password after their password has expired.
Default value: false
", + "UpdateLoginProfileRequest$PasswordResetRequired": "Allows this new password to be used only once by requiring the specified IAM user to set a new password on next sign-in.
" + } + }, + "booleanType": { + "base": null, + "refs": { + "CreateLoginProfileRequest$PasswordResetRequired": "Specifies whether the user is required to set a new password on next sign-in.
", + "CreatePolicyVersionRequest$SetAsDefault": "Specifies whether to set this version as the policy's default version.
When this parameter is true, the new policy version becomes the operative version; that is, the version that is in effect for the IAM users, groups, and roles that the policy is attached to.
For more information about managed policy versions, see Versioning for Managed Policies in the IAM User Guide.
", + "GetAccountAuthorizationDetailsResponse$IsTruncated": "A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all of your results.
A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all of your results.
A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all of your results.
A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all of your results.
A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all of your results.
A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all of your results.
A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all of your results.
A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all of your results.
A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all of your results.
A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all of your results.
A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all of your results.
A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all of your results.
A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all of your results.
A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all of your results.
A flag to filter the results to only the attached policies.
When OnlyAttached is true, the returned list contains only the policies that are attached to an IAM user, group, or role. When OnlyAttached is false, or when the parameter is not included, all policies are returned.
A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all of your results.
A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all of your results.
A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all of your results.
A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all of your results.
A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all of your results.
A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all of your results.
A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all of your results.
A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all of your results.
A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all of your results.
A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all of your results.
Specifies whether the user is required to set a new password on next sign-in.
", + "ManagedPolicyDetail$IsAttachable": "Specifies whether the policy can be attached to an IAM user, group, or role.
", + "PasswordPolicy$RequireSymbols": "Specifies whether to require symbols for IAM user passwords.
", + "PasswordPolicy$RequireNumbers": "Specifies whether to require numbers for IAM user passwords.
", + "PasswordPolicy$RequireUppercaseCharacters": "Specifies whether to require uppercase characters for IAM user passwords.
", + "PasswordPolicy$RequireLowercaseCharacters": "Specifies whether to require lowercase characters for IAM user passwords.
", + "PasswordPolicy$AllowUsersToChangePassword": "Specifies whether IAM users are allowed to change their own password.
", + "PasswordPolicy$ExpirePasswords": "Indicates whether passwords in the account expire. Returns true if MaxPasswordAge is contains a value greater than 0. Returns false if MaxPasswordAge is 0 or not present.
", + "Policy$IsAttachable": "Specifies whether the policy can be attached to an IAM user, group, or role.
", + "PolicyVersion$IsDefaultVersion": "Specifies whether the policy version is set as the policy's default version.
", + "SimulatePolicyResponse$IsTruncated": "A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all of your results.
Specifies whether IAM user passwords must contain at least one of the following non-alphanumeric characters:
! @ # $ % ^ & * ( ) _ + - = [ ] { } | '
Default value: false
", + "UpdateAccountPasswordPolicyRequest$RequireNumbers": "Specifies whether IAM user passwords must contain at least one numeric character (0 to 9).
Default value: false
", + "UpdateAccountPasswordPolicyRequest$RequireUppercaseCharacters": "Specifies whether IAM user passwords must contain at least one uppercase character from the ISO basic Latin alphabet (A to Z).
Default value: false
", + "UpdateAccountPasswordPolicyRequest$RequireLowercaseCharacters": "Specifies whether IAM user passwords must contain at least one lowercase character from the ISO basic Latin alphabet (a to z).
Default value: false
", + "UpdateAccountPasswordPolicyRequest$AllowUsersToChangePassword": "Allows all IAM users in your account to use the AWS Management Console to change their own passwords. For more information, see Letting IAM Users Change Their Own Passwords in the IAM User Guide.
Default value: false
" + } + }, + "certificateBodyType": { + "base": null, + "refs": { + "ServerCertificate$CertificateBody": "The contents of the public key certificate.
", + "SigningCertificate$CertificateBody": "The contents of the signing certificate.
", + "UploadServerCertificateRequest$CertificateBody": "The contents of the public key certificate in PEM-encoded format.
The regex pattern for this parameter is a string of characters consisting of any printable ASCII character ranging from the space character (\\u0020) through end of the ASCII character range (\\u00FF). It also includes the special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D).
", + "UploadSigningCertificateRequest$CertificateBody": "The contents of the signing certificate.
The regex pattern for this parameter is a string of characters consisting of any printable ASCII character ranging from the space character (\\u0020) through end of the ASCII character range (\\u00FF). It also includes the special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D).
" + } + }, + "certificateChainType": { + "base": null, + "refs": { + "ServerCertificate$CertificateChain": "The contents of the public key certificate chain.
", + "UploadServerCertificateRequest$CertificateChain": "The contents of the certificate chain. This is typically a concatenation of the PEM-encoded public key certificates of the chain.
The regex pattern for this parameter is a string of characters consisting of any printable ASCII character ranging from the space character (\\u0020) through end of the ASCII character range (\\u00FF). It also includes the special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D).
" + } + }, + "certificateIdType": { + "base": null, + "refs": { + "DeleteSigningCertificateRequest$CertificateId": "The ID of the signing certificate to delete.
The format of this parameter, as described by its regex pattern, is a string of characters that can be upper- or lower-cased letters or digits.
", + "SigningCertificate$CertificateId": "The ID for the signing certificate.
", + "UpdateSigningCertificateRequest$CertificateId": "The ID of the signing certificate you want to update.
The regex pattern for this parameter is a string of characters that can consist of any upper or lowercased letter or digit.
" + } + }, + "certificateListType": { + "base": "Contains a list of signing certificates.
This data type is used as a response element in the ListSigningCertificates action.
", + "refs": { + "ListSigningCertificatesResponse$Certificates": "A list of the user's signing certificate information.
" + } + }, + "clientIDListType": { + "base": null, + "refs": { + "CreateOpenIDConnectProviderRequest$ClientIDList": "A list of client IDs (also known as audiences). When a mobile or web app registers with an OpenID Connect provider, they establish a value that identifies the application. (This is the value that's sent as the client_id parameter on OAuth requests.)
You can register multiple client IDs with the same provider. For example, you might have multiple applications that use the same OIDC provider. You cannot register more than 100 client IDs with a single IAM OIDC provider.
There is no defined format for a client ID. The CreateOpenIDConnectProviderRequest action accepts client IDs up to 255 characters long.
A list of client IDs (also known as audiences) that are associated with the specified IAM OIDC provider resource object. For more information, see CreateOpenIDConnectProvider.
" + } + }, + "clientIDType": { + "base": null, + "refs": { + "AddClientIDToOpenIDConnectProviderRequest$ClientID": "The client ID (also known as audience) to add to the IAM OpenID Connect provider resource.
", + "RemoveClientIDFromOpenIDConnectProviderRequest$ClientID": "The client ID (also known as audience) to remove from the IAM OIDC provider resource. For more information about client IDs, see CreateOpenIDConnectProvider.
", + "clientIDListType$member": null + } + }, + "credentialReportExpiredExceptionMessage": { + "base": null, + "refs": { + "CredentialReportExpiredException$message": null + } + }, + "credentialReportNotPresentExceptionMessage": { + "base": null, + "refs": { + "CredentialReportNotPresentException$message": null + } + }, + "credentialReportNotReadyExceptionMessage": { + "base": null, + "refs": { + "CredentialReportNotReadyException$message": null + } + }, + "dateType": { + "base": null, + "refs": { + "AccessKey$CreateDate": "The date when the access key was created.
", + "AccessKeyLastUsed$LastUsedDate": "The date and time, in ISO 8601 date-time format, when the access key was most recently used. This field is null when:
The user does not have an access key.
An access key exists but has never been used, at least not since IAM started tracking this information on April 22nd, 2015.
There is no sign-in data associated with the user
The date when the access key was created.
", + "GetCredentialReportResponse$GeneratedTime": "The date and time when the credential report was created, in ISO 8601 date-time format.
", + "GetOpenIDConnectProviderResponse$CreateDate": "The date and time when the IAM OIDC provider resource object was created in the AWS account.
", + "GetSAMLProviderResponse$CreateDate": "The date and time when the SAML provider was created.
", + "GetSAMLProviderResponse$ValidUntil": "The expiration date and time for the SAML provider.
", + "Group$CreateDate": "The date and time, in ISO 8601 date-time format, when the group was created.
", + "GroupDetail$CreateDate": "The date and time, in ISO 8601 date-time format, when the group was created.
", + "InstanceProfile$CreateDate": "The date when the instance profile was created.
", + "LoginProfile$CreateDate": "The date when the password for the user was created.
", + "MFADevice$EnableDate": "The date when the MFA device was enabled for the user.
", + "ManagedPolicyDetail$CreateDate": "The date and time, in ISO 8601 date-time format, when the policy was created.
", + "ManagedPolicyDetail$UpdateDate": "The date and time, in ISO 8601 date-time format, when the policy was last updated.
When a policy has only one version, this field contains the date and time when the policy was created. When a policy has more than one version, this field contains the date and time when the most recent policy version was created.
", + "Policy$CreateDate": "The date and time, in ISO 8601 date-time format, when the policy was created.
", + "Policy$UpdateDate": "The date and time, in ISO 8601 date-time format, when the policy was last updated.
When a policy has only one version, this field contains the date and time when the policy was created. When a policy has more than one version, this field contains the date and time when the most recent policy version was created.
", + "PolicyVersion$CreateDate": "The date and time, in ISO 8601 date-time format, when the policy version was created.
", + "Role$CreateDate": "The date and time, in ISO 8601 date-time format, when the role was created.
", + "RoleDetail$CreateDate": "The date and time, in ISO 8601 date-time format, when the role was created.
", + "SAMLProviderListEntry$ValidUntil": "The expiration date and time for the SAML provider.
", + "SAMLProviderListEntry$CreateDate": "The date and time when the SAML provider was created.
", + "SSHPublicKey$UploadDate": "The date and time, in ISO 8601 date-time format, when the SSH public key was uploaded.
", + "SSHPublicKeyMetadata$UploadDate": "The date and time, in ISO 8601 date-time format, when the SSH public key was uploaded.
", + "ServerCertificateMetadata$UploadDate": "The date when the server certificate was uploaded.
", + "ServerCertificateMetadata$Expiration": "The date on which the certificate is set to expire.
", + "SigningCertificate$UploadDate": "The date when the signing certificate was uploaded.
", + "User$CreateDate": "The date and time, in ISO 8601 date-time format, when the user was created.
", + "User$PasswordLastUsed": "The date and time, in ISO 8601 date-time format, when the user's password was last used to sign in to an AWS website. For a list of AWS websites that capture a user's last sign-in time, see the Credential Reports topic in the Using IAM guide. If a password is used more than once in a five-minute span, only the first use is returned in this field. This field is null (not present) when:
The user does not have a password
The password exists but has never been used (at least not since IAM started tracking this information on October 20th, 2014
there is no sign-in data associated with the user
This value is returned only in the GetUser and ListUsers actions.
", + "UserDetail$CreateDate": "The date and time, in ISO 8601 date-time format, when the user was created.
", + "VirtualMFADevice$EnableDate": "The date and time on which the virtual MFA device was enabled.
" + } + }, + "deleteConflictMessage": { + "base": null, + "refs": { + "DeleteConflictException$message": null + } + }, + "duplicateCertificateMessage": { + "base": null, + "refs": { + "DuplicateCertificateException$message": null + } + }, + "duplicateSSHPublicKeyMessage": { + "base": null, + "refs": { + "DuplicateSSHPublicKeyException$message": null + } + }, + "encodingType": { + "base": null, + "refs": { + "GetSSHPublicKeyRequest$Encoding": "Specifies the public key encoding format to use in the response. To retrieve the public key in ssh-rsa format, use SSH. To retrieve the public key in PEM format, use PEM.
A list of entity types used to filter the results. Only the entities that match the types you specify are included in the output. Use the value LocalManagedPolicy to include customer managed policies.
The format for this parameter is a comma-separated (if more than one) list of strings. Each string value in the list must be one of the valid values listed below.
" + } + }, + "entityTemporarilyUnmodifiableMessage": { + "base": null, + "refs": { + "EntityTemporarilyUnmodifiableException$message": null + } + }, + "existingUserNameType": { + "base": null, + "refs": { + "AddUserToGroupRequest$UserName": "The name of the user to add.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "CreateAccessKeyRequest$UserName": "The name of the IAM user that the new key will belong to.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "DeactivateMFADeviceRequest$UserName": "The name of the user whose MFA device you want to deactivate.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "DeleteAccessKeyRequest$UserName": "The name of the user whose access key pair you want to delete.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "DeleteSigningCertificateRequest$UserName": "The name of the user the signing certificate belongs to.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "DeleteUserPolicyRequest$UserName": "The name (friendly name, not ARN) identifying the user that the policy is embedded in.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "DeleteUserRequest$UserName": "The name of the user to delete.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "EnableMFADeviceRequest$UserName": "The name of the IAM user for whom you want to enable the MFA device.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "GetAccessKeyLastUsedResponse$UserName": "The name of the AWS IAM user that owns this access key.
", + "GetUserPolicyRequest$UserName": "The name of the user who the policy is associated with.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "GetUserPolicyResponse$UserName": "The user the policy is associated with.
", + "GetUserRequest$UserName": "The name of the user to get information about.
This parameter is optional. If it is not included, it defaults to the user making the request. The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "ListAccessKeysRequest$UserName": "The name of the user.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "ListGroupsForUserRequest$UserName": "The name of the user to list groups for.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "ListMFADevicesRequest$UserName": "The name of the user whose MFA devices you want to list.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "ListSigningCertificatesRequest$UserName": "The name of the IAM user whose signing certificates you want to examine.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "ListUserPoliciesRequest$UserName": "The name of the user to list policies for.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "PutUserPolicyRequest$UserName": "The name of the user to associate the policy with.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "RemoveUserFromGroupRequest$UserName": "The name of the user to remove.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "ResyncMFADeviceRequest$UserName": "The name of the user whose MFA device you want to resynchronize.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "UpdateAccessKeyRequest$UserName": "The name of the user whose key you want to update.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "UpdateSigningCertificateRequest$UserName": "The name of the IAM user the signing certificate belongs to.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "UpdateUserRequest$UserName": "Name of the user to update. If you're changing the name of the user, this is the original user name.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "UploadSigningCertificateRequest$UserName": "The name of the user the signing certificate is for.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
" + } + }, + "groupDetailListType": { + "base": null, + "refs": { + "GetAccountAuthorizationDetailsResponse$GroupDetailList": "A list containing information about IAM groups.
" + } + }, + "groupListType": { + "base": "Contains a list of IAM groups.
This data type is used as a response element in the ListGroups action.
", + "refs": { + "ListGroupsForUserResponse$Groups": "A list of groups.
", + "ListGroupsResponse$Groups": "A list of groups.
" + } + }, + "groupNameListType": { + "base": null, + "refs": { + "UserDetail$GroupList": "A list of IAM groups that the user is in.
" + } + }, + "groupNameType": { + "base": null, + "refs": { + "AddUserToGroupRequest$GroupName": "The name of the group to update.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "AttachGroupPolicyRequest$GroupName": "The name (friendly name, not ARN) of the group to attach the policy to.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "CreateGroupRequest$GroupName": "The name of the group to create. Do not include the path in this value.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "DeleteGroupPolicyRequest$GroupName": "The name (friendly name, not ARN) identifying the group that the policy is embedded in.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "DeleteGroupRequest$GroupName": "The name of the IAM group to delete.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "DetachGroupPolicyRequest$GroupName": "The name (friendly name, not ARN) of the IAM group to detach the policy from.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "GetGroupPolicyRequest$GroupName": "The name of the group the policy is associated with.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "GetGroupPolicyResponse$GroupName": "The group the policy is associated with.
", + "GetGroupRequest$GroupName": "The name of the group.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "Group$GroupName": "The friendly name that identifies the group.
", + "GroupDetail$GroupName": "The friendly name that identifies the group.
", + "ListAttachedGroupPoliciesRequest$GroupName": "The name (friendly name, not ARN) of the group to list attached policies for.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "ListGroupPoliciesRequest$GroupName": "The name of the group to list policies for.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "PolicyGroup$GroupName": "The name (friendly name, not ARN) identifying the group.
", + "PutGroupPolicyRequest$GroupName": "The name of the group to associate the policy with.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "RemoveUserFromGroupRequest$GroupName": "The name of the group to update.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "UpdateGroupRequest$GroupName": "Name of the IAM group to update. If you're changing the name of the group, this is the original name.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "UpdateGroupRequest$NewGroupName": "New name for the IAM group. Only include this if changing the group's name.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "groupNameListType$member": null + } + }, + "idType": { + "base": null, + "refs": { + "Group$GroupId": "The stable and unique string identifying the group. For more information about IDs, see IAM Identifiers in the Using IAM guide.
", + "GroupDetail$GroupId": "The stable and unique string identifying the group. For more information about IDs, see IAM Identifiers in the Using IAM guide.
", + "InstanceProfile$InstanceProfileId": "The stable and unique string identifying the instance profile. For more information about IDs, see IAM Identifiers in the Using IAM guide.
", + "ManagedPolicyDetail$PolicyId": "The stable and unique string identifying the policy.
For more information about IDs, see IAM Identifiers in the Using IAM guide.
", + "Policy$PolicyId": "The stable and unique string identifying the policy.
For more information about IDs, see IAM Identifiers in the Using IAM guide.
", + "PolicyGroup$GroupId": "The stable and unique string identifying the group. For more information about IDs, see IAM Identifiers in the IAM User Guide.
", + "PolicyRole$RoleId": "The stable and unique string identifying the role. For more information about IDs, see IAM Identifiers in the IAM User Guide.
", + "PolicyUser$UserId": "The stable and unique string identifying the user. For more information about IDs, see IAM Identifiers in the IAM User Guide.
", + "Role$RoleId": "The stable and unique string identifying the role. For more information about IDs, see IAM Identifiers in the Using IAM guide.
", + "RoleDetail$RoleId": "The stable and unique string identifying the role. For more information about IDs, see IAM Identifiers in the Using IAM guide.
", + "ServerCertificateMetadata$ServerCertificateId": "The stable and unique string identifying the server certificate. For more information about IDs, see IAM Identifiers in the Using IAM guide.
", + "User$UserId": "The stable and unique string identifying the user. For more information about IDs, see IAM Identifiers in the Using IAM guide.
", + "UserDetail$UserId": "The stable and unique string identifying the user. For more information about IDs, see IAM Identifiers in the Using IAM guide.
" + } + }, + "instanceProfileListType": { + "base": "Contains a list of instance profiles.
", + "refs": { + "ListInstanceProfilesForRoleResponse$InstanceProfiles": "A list of instance profiles.
", + "ListInstanceProfilesResponse$InstanceProfiles": "A list of instance profiles.
", + "RoleDetail$InstanceProfileList": null + } + }, + "instanceProfileNameType": { + "base": null, + "refs": { + "AddRoleToInstanceProfileRequest$InstanceProfileName": "The name of the instance profile to update.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "CreateInstanceProfileRequest$InstanceProfileName": "The name of the instance profile to create.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "DeleteInstanceProfileRequest$InstanceProfileName": "The name of the instance profile to delete.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "GetInstanceProfileRequest$InstanceProfileName": "The name of the instance profile to get information about.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "InstanceProfile$InstanceProfileName": "The name identifying the instance profile.
", + "RemoveRoleFromInstanceProfileRequest$InstanceProfileName": "The name of the instance profile to update.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
" + } + }, + "invalidAuthenticationCodeMessage": { + "base": null, + "refs": { + "InvalidAuthenticationCodeException$message": null + } + }, + "invalidCertificateMessage": { + "base": null, + "refs": { + "InvalidCertificateException$message": null + } + }, + "invalidInputMessage": { + "base": null, + "refs": { + "InvalidInputException$message": null + } + }, + "invalidPublicKeyMessage": { + "base": null, + "refs": { + "InvalidPublicKeyException$message": null + } + }, + "invalidUserTypeMessage": { + "base": null, + "refs": { + "InvalidUserTypeException$message": null + } + }, + "keyPairMismatchMessage": { + "base": null, + "refs": { + "KeyPairMismatchException$message": null + } + }, + "limitExceededMessage": { + "base": null, + "refs": { + "LimitExceededException$message": null + } + }, + "malformedCertificateMessage": { + "base": null, + "refs": { + "MalformedCertificateException$message": null + } + }, + "malformedPolicyDocumentMessage": { + "base": null, + "refs": { + "MalformedPolicyDocumentException$message": null + } + }, + "markerType": { + "base": null, + "refs": { + "GetAccountAuthorizationDetailsRequest$Marker": "Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.
When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.
When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.
When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.
When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.
When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.
When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.
When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.
When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.
When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.
When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.
When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.
When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.
When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.
When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.
When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.
When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.
When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.
When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.
When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.
When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.
When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.
When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.
When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.
When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.
When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.
Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true and Marker contains a value to include in the subsequent call that tells the service where to continue from.
The number of days that an IAM user password is valid.
", + "UpdateAccountPasswordPolicyRequest$MaxPasswordAge": "The number of days that an IAM user password is valid. The default value of 0 means IAM user passwords never expire.
Default value: 0
" + } + }, + "mfaDeviceListType": { + "base": "Contains a list of MFA devices.
This data type is used as a response element in the ListMFADevices and ListVirtualMFADevices actions.
", + "refs": { + "ListMFADevicesResponse$MFADevices": "A list of MFA devices.
" + } + }, + "minimumPasswordLengthType": { + "base": null, + "refs": { + "PasswordPolicy$MinimumPasswordLength": "Minimum length to require for IAM user passwords.
", + "UpdateAccountPasswordPolicyRequest$MinimumPasswordLength": "The minimum number of characters allowed in an IAM user password.
Default value: 6
" + } + }, + "noSuchEntityMessage": { + "base": null, + "refs": { + "NoSuchEntityException$message": null + } + }, + "passwordPolicyViolationMessage": { + "base": null, + "refs": { + "PasswordPolicyViolationException$message": null + } + }, + "passwordReusePreventionType": { + "base": null, + "refs": { + "PasswordPolicy$PasswordReusePrevention": "Specifies the number of previous passwords that IAM users are prevented from reusing.
", + "UpdateAccountPasswordPolicyRequest$PasswordReusePrevention": "Specifies the number of previous passwords that IAM users are prevented from reusing. The default value of 0 means IAM users are not prevented from reusing previous passwords.
Default value: 0
" + } + }, + "passwordType": { + "base": null, + "refs": { + "ChangePasswordRequest$OldPassword": "The IAM user's current password.
", + "ChangePasswordRequest$NewPassword": "The new password. The new password must conform to the AWS account's password policy, if one exists.
The regex pattern for this parameter is a string of characters consisting of almost any printable ASCII character from the space (\\u0020) through the end of the ASCII character range (\\u00FF). You can also include the tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D) characters. Although any of these characters are valid in a password, note that many tools, such as the AWS Management Console, might restrict the ability to enter certain characters because they have special meaning within that tool.
", + "CreateLoginProfileRequest$Password": "The new password for the user.
The regex pattern for this parameter is a string of characters consisting of almost any printable ASCII character from the space (\\u0020) through the end of the ASCII character range (\\u00FF). You can also include the tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D) characters. Although any of these characters are valid in a password, note that many tools, such as the AWS Management Console, might restrict the ability to enter certain characters because they have special meaning within that tool.
", + "UpdateLoginProfileRequest$Password": "The new password for the specified IAM user.
The regex pattern for this parameter is a string of characters consisting of any printable ASCII character ranging from the space character (\\u0020) through end of the ASCII character range (\\u00FF). It also includes the special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D). However, the format can be further restricted by the account administrator by setting a password policy on the AWS account. For more information, see UpdateAccountPasswordPolicy.
" + } + }, + "pathPrefixType": { + "base": null, + "refs": { + "ListGroupsRequest$PathPrefix": " The path prefix for filtering the results. For example, the prefix /division_abc/subdivision_xyz/ gets all groups whose path starts with /division_abc/subdivision_xyz/.
This parameter is optional. If it is not included, it defaults to a slash (/), listing all groups. The regex pattern for this parameter is a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (\\u0021) thru the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.
", + "ListInstanceProfilesRequest$PathPrefix": " The path prefix for filtering the results. For example, the prefix /application_abc/component_xyz/ gets all instance profiles whose path starts with /application_abc/component_xyz/.
This parameter is optional. If it is not included, it defaults to a slash (/), listing all instance profiles. The regex pattern for this parameter is a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (\\u0021) thru the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.
", + "ListRolesRequest$PathPrefix": " The path prefix for filtering the results. For example, the prefix /application_abc/component_xyz/ gets all roles whose path starts with /application_abc/component_xyz/.
This parameter is optional. If it is not included, it defaults to a slash (/), listing all roles. The regex pattern for this parameter is a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (\\u0021) thru the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.
", + "ListServerCertificatesRequest$PathPrefix": " The path prefix for filtering the results. For example: /company/servercerts would get all server certificates for which the path starts with /company/servercerts.
This parameter is optional. If it is not included, it defaults to a slash (/), listing all server certificates. The regex pattern for this parameter is a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (\\u0021) thru the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.
", + "ListUsersRequest$PathPrefix": " The path prefix for filtering the results. For example: /division_abc/subdivision_xyz/, which would get all user names whose path starts with /division_abc/subdivision_xyz/.
This parameter is optional. If it is not included, it defaults to a slash (/), listing all user names. The regex pattern for this parameter is a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (\\u0021) thru the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.
" + } + }, + "pathType": { + "base": null, + "refs": { + "CreateGroupRequest$Path": "The path to the group. For more information about paths, see IAM Identifiers in the IAM User Guide.
This parameter is optional. If it is not included, it defaults to a slash (/).
The regex pattern for this parameter is a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (\\u0021) thru the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.
", + "CreateInstanceProfileRequest$Path": "The path to the instance profile. For more information about paths, see IAM Identifiers in the IAM User Guide.
This parameter is optional. If it is not included, it defaults to a slash (/).
The regex pattern for this parameter is a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (\\u0021) thru the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.
", + "CreateRoleRequest$Path": "The path to the role. For more information about paths, see IAM Identifiers in the IAM User Guide.
This parameter is optional. If it is not included, it defaults to a slash (/).
The regex pattern for this parameter is a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (\\u0021) thru the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.
", + "CreateUserRequest$Path": "The path for the user name. For more information about paths, see IAM Identifiers in the IAM User Guide.
This parameter is optional. If it is not included, it defaults to a slash (/).
The regex pattern for this parameter is a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (\\u0021) thru the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.
", + "CreateVirtualMFADeviceRequest$Path": "The path for the virtual MFA device. For more information about paths, see IAM Identifiers in the IAM User Guide.
This parameter is optional. If it is not included, it defaults to a slash (/).
The regex pattern for this parameter is a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (\\u0021) thru the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.
", + "Group$Path": "The path to the group. For more information about paths, see IAM Identifiers in the Using IAM guide.
", + "GroupDetail$Path": "The path to the group. For more information about paths, see IAM Identifiers in the Using IAM guide.
", + "InstanceProfile$Path": "The path to the instance profile. For more information about paths, see IAM Identifiers in the Using IAM guide.
", + "ListEntitiesForPolicyRequest$PathPrefix": "The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all entities.
The regex pattern for this parameter is a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (\\u0021) thru the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.
", + "Role$Path": "The path to the role. For more information about paths, see IAM Identifiers in the Using IAM guide.
", + "RoleDetail$Path": "The path to the role. For more information about paths, see IAM Identifiers in the Using IAM guide.
", + "ServerCertificateMetadata$Path": "The path to the server certificate. For more information about paths, see IAM Identifiers in the Using IAM guide.
", + "UpdateGroupRequest$NewPath": "New path for the IAM group. Only include this if changing the group's path.
The regex pattern for this parameter is a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (\\u0021) thru the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.
", + "UpdateServerCertificateRequest$NewPath": "The new path for the server certificate. Include this only if you are updating the server certificate's path.
The regex pattern for this parameter is a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (\\u0021) thru the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.
", + "UpdateUserRequest$NewPath": "New path for the IAM user. Include this parameter only if you're changing the user's path.
The regex pattern for this parameter is a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (\\u0021) thru the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.
", + "UploadServerCertificateRequest$Path": "The path for the server certificate. For more information about paths, see IAM Identifiers in the IAM User Guide.
This parameter is optional. If it is not included, it defaults to a slash (/). The regex pattern for this parameter is a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (\\u0021) thru the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.
If you are uploading a server certificate specifically for use with Amazon CloudFront distributions, you must specify a path using the --path option. The path must begin with /cloudfront and must include a trailing slash (for example, /cloudfront/test/).
The path to the user. For more information about paths, see IAM Identifiers in the Using IAM guide.
", + "UserDetail$Path": "The path to the user. For more information about paths, see IAM Identifiers in the Using IAM guide.
" + } + }, + "policyDescriptionType": { + "base": null, + "refs": { + "CreatePolicyRequest$Description": "A friendly description of the policy.
Typically used to store information about the permissions defined in the policy. For example, \"Grants access to production DynamoDB tables.\"
The policy description is immutable. After a value is assigned, it cannot be changed.
", + "ManagedPolicyDetail$Description": "A friendly description of the policy.
", + "Policy$Description": "A friendly description of the policy.
This element is included in the response to the GetPolicy operation. It is not included in the response to the ListPolicies operation.
" + } + }, + "policyDetailListType": { + "base": null, + "refs": { + "GroupDetail$GroupPolicyList": "A list of the inline policies embedded in the group.
", + "RoleDetail$RolePolicyList": "A list of inline policies embedded in the role. These policies are the role's access (permissions) policies.
", + "UserDetail$UserPolicyList": "A list of the inline policies embedded in the user.
" + } + }, + "policyDocumentType": { + "base": null, + "refs": { + "CreatePolicyRequest$PolicyDocument": "The JSON policy document that you want to use as the content for the new policy.
The regex pattern for this parameter is a string of characters consisting of any printable ASCII character ranging from the space character (\\u0020) through end of the ASCII character range (\\u00FF). It also includes the special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D).
", + "CreatePolicyVersionRequest$PolicyDocument": "The JSON policy document that you want to use as the content for this new version of the policy.
The regex pattern for this parameter is a string of characters consisting of any printable ASCII character ranging from the space character (\\u0020) through end of the ASCII character range (\\u00FF). It also includes the special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D).
", + "CreateRoleRequest$AssumeRolePolicyDocument": "The trust relationship policy document that grants an entity permission to assume the role.
The regex pattern for this parameter is a string of characters consisting of any printable ASCII character ranging from the space character (\\u0020) through end of the ASCII character range (\\u00FF). It also includes the special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D).
", + "GetGroupPolicyResponse$PolicyDocument": "The policy document.
", + "GetRolePolicyResponse$PolicyDocument": "The policy document.
", + "GetUserPolicyResponse$PolicyDocument": "The policy document.
", + "PolicyDetail$PolicyDocument": "The policy document.
", + "PolicyVersion$Document": "The policy document.
The policy document is returned in the response to the GetPolicyVersion and GetAccountAuthorizationDetails operations. It is not returned in the response to the CreatePolicyVersion or ListPolicyVersions operations.
", + "PutGroupPolicyRequest$PolicyDocument": "The policy document.
The regex pattern for this parameter is a string of characters consisting of any printable ASCII character ranging from the space character (\\u0020) through end of the ASCII character range (\\u00FF). It also includes the special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D).
", + "PutRolePolicyRequest$PolicyDocument": "The policy document.
The regex pattern for this parameter is a string of characters consisting of any printable ASCII character ranging from the space character (\\u0020) through end of the ASCII character range (\\u00FF). It also includes the special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D).
", + "PutUserPolicyRequest$PolicyDocument": "The policy document.
The regex pattern for this parameter is a string of characters consisting of any printable ASCII character ranging from the space character (\\u0020) through end of the ASCII character range (\\u00FF). It also includes the special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D).
", + "Role$AssumeRolePolicyDocument": "The policy that grants an entity permission to assume the role.
", + "RoleDetail$AssumeRolePolicyDocument": "The trust policy that grants permission to assume the role.
", + "SimulateCustomPolicyRequest$ResourcePolicy": "A resource-based policy to include in the simulation provided as a string. Each resource in the simulation is treated as if it had this policy attached. You can include only one resource-based policy in a simulation.
The regex pattern for this parameter is a string of characters consisting of any printable ASCII character ranging from the space character (\\u0020) through end of the ASCII character range (\\u00FF). It also includes the special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D).
", + "SimulatePrincipalPolicyRequest$ResourcePolicy": "A resource-based policy to include in the simulation provided as a string. Each resource in the simulation is treated as if it had this policy attached. You can include only one resource-based policy in a simulation.
The regex pattern for this parameter is a string of characters consisting of any printable ASCII character ranging from the space character (\\u0020) through end of the ASCII character range (\\u00FF). It also includes the special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D).
", + "SimulationPolicyListType$member": null, + "UpdateAssumeRolePolicyRequest$PolicyDocument": "The policy that grants an entity permission to assume the role.
The regex pattern for this parameter is a string of characters consisting of any printable ASCII character ranging from the space character (\\u0020) through end of the ASCII character range (\\u00FF). It also includes the special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D).
" + } + }, + "policyDocumentVersionListType": { + "base": null, + "refs": { + "ListPolicyVersionsResponse$Versions": "A list of policy versions.
For more information about managed policy versions, see Versioning for Managed Policies in the IAM User Guide.
", + "ManagedPolicyDetail$PolicyVersionList": "A list containing information about the versions of the policy.
" + } + }, + "policyEvaluationErrorMessage": { + "base": null, + "refs": { + "PolicyEvaluationException$message": null + } + }, + "policyListType": { + "base": null, + "refs": { + "ListPoliciesResponse$Policies": "A list of policies.
" + } + }, + "policyNameListType": { + "base": "Contains a list of policy names.
This data type is used as a response element in the ListPolicies action.
", + "refs": { + "ListGroupPoliciesResponse$PolicyNames": "A list of policy names.
", + "ListRolePoliciesResponse$PolicyNames": "A list of policy names.
", + "ListUserPoliciesResponse$PolicyNames": "A list of policy names.
" + } + }, + "policyNameType": { + "base": null, + "refs": { + "AttachedPolicy$PolicyName": "The friendly name of the attached policy.
", + "CreatePolicyRequest$PolicyName": "The friendly name of the policy.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "DeleteGroupPolicyRequest$PolicyName": "The name identifying the policy document to delete.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "DeleteRolePolicyRequest$PolicyName": "The name of the inline policy to delete from the specified IAM role.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "DeleteUserPolicyRequest$PolicyName": "The name identifying the policy document to delete.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "GetGroupPolicyRequest$PolicyName": "The name of the policy document to get.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "GetGroupPolicyResponse$PolicyName": "The name of the policy.
", + "GetRolePolicyRequest$PolicyName": "The name of the policy document to get.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "GetRolePolicyResponse$PolicyName": "The name of the policy.
", + "GetUserPolicyRequest$PolicyName": "The name of the policy document to get.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "GetUserPolicyResponse$PolicyName": "The name of the policy.
", + "ManagedPolicyDetail$PolicyName": "The friendly name (not ARN) identifying the policy.
", + "Policy$PolicyName": "The friendly name (not ARN) identifying the policy.
", + "PolicyDetail$PolicyName": "The name of the policy.
", + "PutGroupPolicyRequest$PolicyName": "The name of the policy document.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "PutRolePolicyRequest$PolicyName": "The name of the policy document.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "PutUserPolicyRequest$PolicyName": "The name of the policy document.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "policyNameListType$member": null + } + }, + "policyPathType": { + "base": null, + "refs": { + "CreatePolicyRequest$Path": "The path for the policy.
For more information about paths, see IAM Identifiers in the IAM User Guide.
This parameter is optional. If it is not included, it defaults to a slash (/).
The regex pattern for this parameter is a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (\\u0021) thru the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.
", + "ListAttachedGroupPoliciesRequest$PathPrefix": "The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies.
The regex pattern for this parameter is a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (\\u0021) thru the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.
", + "ListAttachedRolePoliciesRequest$PathPrefix": "The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies.
The regex pattern for this parameter is a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (\\u0021) thru the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.
", + "ListAttachedUserPoliciesRequest$PathPrefix": "The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies.
The regex pattern for this parameter is a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (\\u0021) thru the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.
", + "ListPoliciesRequest$PathPrefix": "The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies. The regex pattern for this parameter is a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (\\u0021) thru the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.
", + "ManagedPolicyDetail$Path": "The path to the policy.
For more information about paths, see IAM Identifiers in the Using IAM guide.
", + "Policy$Path": "The path to the policy.
For more information about paths, see IAM Identifiers in the Using IAM guide.
" + } + }, + "policyScopeType": { + "base": null, + "refs": { + "ListPoliciesRequest$Scope": "The scope to use for filtering the results.
To list only AWS managed policies, set Scope to AWS. To list only the customer managed policies in your AWS account, set Scope to Local.
This parameter is optional. If it is not included, or if it is set to All, all policies are returned.
The policy version to delete.
The regex pattern for this parameter is a string of characters that consists of the lowercase letter 'v' followed by one or two digits, and optionally followed by a period '.' and a string of letters and digits.
For more information about managed policy versions, see Versioning for Managed Policies in the IAM User Guide.
", + "GetPolicyVersionRequest$VersionId": "Identifies the policy version to retrieve.
The regex pattern for this parameter is a string of characters that consists of the lowercase letter 'v' followed by one or two digits, and optionally followed by a period '.' and a string of letters and digits.
", + "ManagedPolicyDetail$DefaultVersionId": "The identifier for the version of the policy that is set as the default (operative) version.
For more information about policy versions, see Versioning for Managed Policies in the Using IAM guide.
", + "Policy$DefaultVersionId": "The identifier for the version of the policy that is set as the default version.
", + "PolicyVersion$VersionId": "The identifier for the policy version.
Policy version identifiers always begin with v (always lowercase). When a policy is created, the first policy version is v1.
The version of the policy to set as the default (operative) version.
For more information about managed policy versions, see Versioning for Managed Policies in the IAM User Guide.
" + } + }, + "privateKeyType": { + "base": null, + "refs": { + "UploadServerCertificateRequest$PrivateKey": "The contents of the private key in PEM-encoded format.
The regex pattern for this parameter is a string of characters consisting of any printable ASCII character ranging from the space character (\\u0020) through end of the ASCII character range (\\u00FF). It also includes the special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D).
" + } + }, + "publicKeyFingerprintType": { + "base": null, + "refs": { + "SSHPublicKey$Fingerprint": "The MD5 message digest of the SSH public key.
" + } + }, + "publicKeyIdType": { + "base": null, + "refs": { + "DeleteSSHPublicKeyRequest$SSHPublicKeyId": "The unique identifier for the SSH public key.
The regex pattern for this parameter is a string of characters that can consist of any upper or lowercased letter or digit.
", + "GetSSHPublicKeyRequest$SSHPublicKeyId": "The unique identifier for the SSH public key.
The regex pattern for this parameter is a string of characters that can consist of any upper or lowercased letter or digit.
", + "SSHPublicKey$SSHPublicKeyId": "The unique identifier for the SSH public key.
", + "SSHPublicKeyMetadata$SSHPublicKeyId": "The unique identifier for the SSH public key.
", + "UpdateSSHPublicKeyRequest$SSHPublicKeyId": "The unique identifier for the SSH public key.
The regex pattern for this parameter is a string of characters that can consist of any upper or lowercased letter or digit.
" + } + }, + "publicKeyMaterialType": { + "base": null, + "refs": { + "SSHPublicKey$SSHPublicKeyBody": "The SSH public key.
", + "UploadSSHPublicKeyRequest$SSHPublicKeyBody": "The SSH public key. The public key must be encoded in ssh-rsa format or PEM format.
The regex pattern for this parameter is a string of characters consisting of any printable ASCII character ranging from the space character (\\u0020) through end of the ASCII character range (\\u00FF). It also includes the special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D).
" + } + }, + "roleDetailListType": { + "base": null, + "refs": { + "GetAccountAuthorizationDetailsResponse$RoleDetailList": "A list containing information about IAM roles.
" + } + }, + "roleListType": { + "base": "Contains a list of IAM roles.
This data type is used as a response element in the ListRoles action.
", + "refs": { + "InstanceProfile$Roles": "The role associated with the instance profile.
", + "ListRolesResponse$Roles": "A list of roles.
" + } + }, + "roleNameType": { + "base": null, + "refs": { + "AddRoleToInstanceProfileRequest$RoleName": "The name of the role to add.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "AttachRolePolicyRequest$RoleName": "The name (friendly name, not ARN) of the role to attach the policy to.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "CreateRoleRequest$RoleName": "The name of the role to create.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "DeleteRolePolicyRequest$RoleName": "The name (friendly name, not ARN) identifying the role that the policy is embedded in.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "DeleteRoleRequest$RoleName": "The name of the role to delete.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "DetachRolePolicyRequest$RoleName": "The name (friendly name, not ARN) of the IAM role to detach the policy from.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "GetRolePolicyRequest$RoleName": "The name of the role associated with the policy.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "GetRolePolicyResponse$RoleName": "The role the policy is associated with.
", + "GetRoleRequest$RoleName": "The name of the IAM role to get information about.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "ListAttachedRolePoliciesRequest$RoleName": "The name (friendly name, not ARN) of the role to list attached policies for.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "ListInstanceProfilesForRoleRequest$RoleName": "The name of the role to list instance profiles for.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "ListRolePoliciesRequest$RoleName": "The name of the role to list policies for.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "PolicyRole$RoleName": "The name (friendly name, not ARN) identifying the role.
", + "PutRolePolicyRequest$RoleName": "The name of the role to associate the policy with.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "RemoveRoleFromInstanceProfileRequest$RoleName": "The name of the role to remove.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "Role$RoleName": "The friendly name that identifies the role.
", + "RoleDetail$RoleName": "The friendly name that identifies the role.
", + "UpdateAssumeRolePolicyRequest$RoleName": "The name of the role to update with the new policy.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
" + } + }, + "serialNumberType": { + "base": null, + "refs": { + "DeactivateMFADeviceRequest$SerialNumber": "The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the device ARN.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =/:,.@-
", + "DeleteVirtualMFADeviceRequest$SerialNumber": "The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the same as the ARN.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =/:,.@-
", + "EnableMFADeviceRequest$SerialNumber": "The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the device ARN.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =/:,.@-
", + "MFADevice$SerialNumber": "The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the device ARN.
", + "ResyncMFADeviceRequest$SerialNumber": "Serial number that uniquely identifies the MFA device.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "VirtualMFADevice$SerialNumber": "The serial number associated with VirtualMFADevice.
A list of server certificates.
" + } + }, + "serverCertificateNameType": { + "base": null, + "refs": { + "DeleteServerCertificateRequest$ServerCertificateName": "The name of the server certificate you want to delete.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "GetServerCertificateRequest$ServerCertificateName": "The name of the server certificate you want to retrieve information about.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "ServerCertificateMetadata$ServerCertificateName": "The name that identifies the server certificate.
", + "UpdateServerCertificateRequest$ServerCertificateName": "The name of the server certificate that you want to update.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "UpdateServerCertificateRequest$NewServerCertificateName": "The new name for the server certificate. Include this only if you are updating the server certificate's name. The name of the certificate cannot contain any spaces.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "UploadServerCertificateRequest$ServerCertificateName": "The name for the server certificate. Do not include the path in this value. The name of the certificate cannot contain any spaces.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
" + } + }, + "serviceFailureExceptionMessage": { + "base": null, + "refs": { + "ServiceFailureException$message": null + } + }, + "statusType": { + "base": null, + "refs": { + "AccessKey$Status": "The status of the access key. Active means the key is valid for API calls, while Inactive means it is not.
The status of the access key. Active means the key is valid for API calls; Inactive means it is not.
The status of the SSH public key. Active means the key can be used for authentication with an AWS CodeCommit repository. Inactive means the key cannot be used.
The status of the SSH public key. Active means the key can be used for authentication with an AWS CodeCommit repository. Inactive means the key cannot be used.
The status of the signing certificate. Active means the key is valid for API calls, while Inactive means it is not.
The status you want to assign to the secret access key. Active means the key can be used for API calls to AWS, while Inactive means the key cannot be used.
The status to assign to the SSH public key. Active means the key can be used for authentication with an AWS CodeCommit repository. Inactive means the key cannot be used.
The status you want to assign to the certificate. Active means the certificate can be used for API calls to AWS, while Inactive means the certificate cannot be used.
The name of the AWS service with which this access key was most recently used. This field is null when:
The user does not have an access key.
An access key exists but has never been used, at least not since IAM started tracking this information on April 22nd, 2015.
There is no sign-in data associated with the user
The AWS region where this access key was most recently used. This field is null when:
The user does not have an access key.
An access key exists but has never been used, at least not since IAM started tracking this information on April 22nd, 2015.
There is no sign-in data associated with the user
For more information about AWS regions, see Regions and Endpoints in the Amazon Web Services General Reference.
" + } + }, + "summaryKeyType": { + "base": null, + "refs": { + "summaryMapType$key": null + } + }, + "summaryMapType": { + "base": null, + "refs": { + "GetAccountSummaryResponse$SummaryMap": "A set of key value pairs containing information about IAM entity usage and IAM quotas.
" + } + }, + "summaryValueType": { + "base": null, + "refs": { + "summaryMapType$value": null + } + }, + "thumbprintListType": { + "base": "Contains a list of thumbprints of identity provider server certificates.
", + "refs": { + "CreateOpenIDConnectProviderRequest$ThumbprintList": "A list of server certificate thumbprints for the OpenID Connect (OIDC) identity provider's server certificate(s). Typically this list includes only one entry. However, IAM lets you have up to five thumbprints for an OIDC provider. This lets you maintain multiple thumbprints if the identity provider is rotating certificates.
The server certificate thumbprint is the hex-encoded SHA-1 hash value of the X.509 certificate used by the domain where the OpenID Connect provider makes its keys available. It is always a 40-character string.
You must provide at least one thumbprint when creating an IAM OIDC provider. For example, if the OIDC provider is server.example.com and the provider stores its keys at \"https://keys.server.example.com/openid-connect\", the thumbprint string would be the hex-encoded SHA-1 hash value of the certificate used by https://keys.server.example.com.
For more information about obtaining the OIDC provider's thumbprint, see Obtaining the Thumbprint for an OpenID Connect Provider in the IAM User Guide.
", + "GetOpenIDConnectProviderResponse$ThumbprintList": "A list of certificate thumbprints that are associated with the specified IAM OIDC provider resource object. For more information, see CreateOpenIDConnectProvider.
", + "UpdateOpenIDConnectProviderThumbprintRequest$ThumbprintList": "A list of certificate thumbprints that are associated with the specified IAM OpenID Connect provider. For more information, see CreateOpenIDConnectProvider.
" + } + }, + "thumbprintType": { + "base": "Contains a thumbprint for an identity provider's server certificate.
The identity provider's server certificate thumbprint is the hex-encoded SHA-1 hash value of the self-signed X.509 certificate used by the domain where the OpenID Connect provider makes its keys available. It is always a 40-character string.
", + "refs": { + "thumbprintListType$member": null + } + }, + "unrecognizedPublicKeyEncodingMessage": { + "base": null, + "refs": { + "UnrecognizedPublicKeyEncodingException$message": null + } + }, + "userDetailListType": { + "base": null, + "refs": { + "GetAccountAuthorizationDetailsResponse$UserDetailList": "A list containing information about IAM users.
" + } + }, + "userListType": { + "base": "Contains a list of users.
This data type is used as a response element in the GetGroup and ListUsers actions.
", + "refs": { + "GetGroupResponse$Users": "A list of users in the group.
", + "ListUsersResponse$Users": "A list of users.
" + } + }, + "userNameType": { + "base": null, + "refs": { + "AccessKey$UserName": "The name of the IAM user that the access key is associated with.
", + "AccessKeyMetadata$UserName": "The name of the IAM user that the key is associated with.
", + "AttachUserPolicyRequest$UserName": "The name (friendly name, not ARN) of the IAM user to attach the policy to.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "CreateLoginProfileRequest$UserName": "The name of the IAM user to create a password for. The user must already exist.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "CreateUserRequest$UserName": "The name of the user to create.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "DeleteLoginProfileRequest$UserName": "The name of the user whose password you want to delete.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "DeleteSSHPublicKeyRequest$UserName": "The name of the IAM user associated with the SSH public key.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "DetachUserPolicyRequest$UserName": "The name (friendly name, not ARN) of the IAM user to detach the policy from.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "GetLoginProfileRequest$UserName": "The name of the user whose login profile you want to retrieve.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "GetSSHPublicKeyRequest$UserName": "The name of the IAM user associated with the SSH public key.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "ListAttachedUserPoliciesRequest$UserName": "The name (friendly name, not ARN) of the user to list attached policies for.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "ListSSHPublicKeysRequest$UserName": "The name of the IAM user to list SSH public keys for. If none is specified, the UserName field is determined implicitly based on the AWS access key used to sign the request.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "LoginProfile$UserName": "The name of the user, which can be used for signing in to the AWS Management Console.
", + "MFADevice$UserName": "The user with whom the MFA device is associated.
", + "PolicyUser$UserName": "The name (friendly name, not ARN) identifying the user.
", + "SSHPublicKey$UserName": "The name of the IAM user associated with the SSH public key.
", + "SSHPublicKeyMetadata$UserName": "The name of the IAM user associated with the SSH public key.
", + "SigningCertificate$UserName": "The name of the user the signing certificate is associated with.
", + "UpdateLoginProfileRequest$UserName": "The name of the user whose password you want to update.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "UpdateSSHPublicKeyRequest$UserName": "The name of the IAM user associated with the SSH public key.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "UpdateUserRequest$NewUserName": "New name for the user. Include this parameter only if you're changing the user's name.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "UploadSSHPublicKeyRequest$UserName": "The name of the IAM user to associate the SSH public key with.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "User$UserName": "The friendly name identifying the user.
", + "UserDetail$UserName": "The friendly name identifying the user.
" + } + }, + "virtualMFADeviceListType": { + "base": null, + "refs": { + "ListVirtualMFADevicesResponse$VirtualMFADevices": " The list of virtual MFA devices in the current account that match the AssignmentStatus value that was passed in the request.
The name of the virtual MFA device. Use with path to uniquely identify a virtual MFA device.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
" + } + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/iam/2010-05-08/examples-1.json b/vendor/github.com/aws/aws-sdk-go/models/apis/iam/2010-05-08/examples-1.json new file mode 100644 index 000000000..0ea7e3b0b --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/iam/2010-05-08/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/iam/2010-05-08/paginators-1.json b/vendor/github.com/aws/aws-sdk-go/models/apis/iam/2010-05-08/paginators-1.json new file mode 100644 index 000000000..c476fe16b --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/iam/2010-05-08/paginators-1.json @@ -0,0 +1,198 @@ +{ + "pagination": { + "GetAccountAuthorizationDetails": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": [ + "UserDetailList", + "GroupDetailList", + "RoleDetailList", + "Policies" + ] + }, + "GetGroup": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "Users" + }, + "ListAccessKeys": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "AccessKeyMetadata" + }, + "ListAccountAliases": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "AccountAliases" + }, + "ListAttachedGroupPolicies": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "AttachedPolicies" + }, + "ListAttachedRolePolicies": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "AttachedPolicies" + }, + "ListAttachedUserPolicies": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "AttachedPolicies" + }, + "ListEntitiesForPolicy": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": [ + "PolicyGroups", + "PolicyUsers", + "PolicyRoles" + ] + }, + "ListGroupPolicies": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "PolicyNames" + }, + "ListGroups": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "Groups" + }, + "ListGroupsForUser": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "Groups" + }, + "ListInstanceProfiles": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "InstanceProfiles" + }, + "ListInstanceProfilesForRole": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "InstanceProfiles" + }, + "ListMFADevices": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "MFADevices" + }, + "ListPolicies": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "Policies" + }, + "ListPolicyVersions": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "Versions" + }, + "ListRolePolicies": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "PolicyNames" + }, + "ListRoles": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "Roles" + }, + "ListSAMLProviders": { + "result_key": "SAMLProviderList" + }, + "ListServerCertificates": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "ServerCertificateMetadataList" + }, + "ListSigningCertificates": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "Certificates" + }, + "ListSSHPublicKeys": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "SSHPublicKeys" + }, + "ListUserPolicies": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "PolicyNames" + }, + "ListUsers": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "Users" + }, + "ListVirtualMFADevices": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "VirtualMFADevices" + }, + "SimulateCustomPolicy": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "EvaluationResults" + }, + "SimulatePrincipalPolicy": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "EvaluationResults" + } + } +} \ No newline at end of file diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/iam/2010-05-08/waiters-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/iam/2010-05-08/waiters-2.json new file mode 100644 index 000000000..ba4538269 --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/iam/2010-05-08/waiters-2.json @@ -0,0 +1,39 @@ +{ + "version": 2, + "waiters": { + "InstanceProfileExists": { + "delay": 1, + "operation": "GetInstanceProfile", + "maxAttempts": 40, + "acceptors": [ + { + "expected": 200, + "matcher": "status", + "state": "success" + }, + { + "state": "retry", + "matcher": "status", + "expected": 404 + } + ] + }, + "UserExists": { + "delay": 1, + "operation": "GetUser", + "maxAttempts": 20, + "acceptors": [ + { + "state": "success", + "matcher": "status", + "expected": 200 + }, + { + "state": "retry", + "matcher": "error", + "expected": "NoSuchEntity" + } + ] + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/importexport/2010-06-01/api-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/importexport/2010-06-01/api-2.json new file mode 100644 index 000000000..308dd9eea --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/importexport/2010-06-01/api-2.json @@ -0,0 +1,666 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2010-06-01", + "endpointPrefix":"importexport", + "globalEndpoint":"importexport.amazonaws.com", + "serviceFullName":"AWS Import/Export", + "signatureVersion":"v2", + "xmlNamespace":"http://importexport.amazonaws.com/doc/2010-06-01/", + "protocol":"query" + }, + "operations":{ + "CancelJob":{ + "name":"CancelJob", + "http":{ + "method":"POST", + "requestUri":"/?Operation=CancelJob" + }, + "input":{"shape":"CancelJobInput"}, + "output":{ + "shape":"CancelJobOutput", + "resultWrapper":"CancelJobResult" + }, + "errors":[ + { + "shape":"InvalidJobIdException", + "exception":true + }, + { + "shape":"ExpiredJobIdException", + "exception":true + }, + { + "shape":"CanceledJobIdException", + "exception":true + }, + { + "shape":"UnableToCancelJobIdException", + "exception":true + }, + { + "shape":"InvalidAccessKeyIdException", + "exception":true + }, + { + "shape":"InvalidVersionException", + "exception":true + } + ] + }, + "CreateJob":{ + "name":"CreateJob", + "http":{ + "method":"POST", + "requestUri":"/?Operation=CreateJob" + }, + "input":{"shape":"CreateJobInput"}, + "output":{ + "shape":"CreateJobOutput", + "resultWrapper":"CreateJobResult" + }, + "errors":[ + { + "shape":"MissingParameterException", + "exception":true + }, + { + "shape":"InvalidParameterException", + "exception":true + }, + { + "shape":"InvalidAccessKeyIdException", + "exception":true + }, + { + "shape":"InvalidAddressException", + "exception":true + }, + { + "shape":"InvalidManifestFieldException", + "exception":true + }, + { + "shape":"MissingManifestFieldException", + "exception":true + }, + { + "shape":"NoSuchBucketException", + "exception":true + }, + { + "shape":"MissingCustomsException", + "exception":true + }, + { + "shape":"InvalidCustomsException", + "exception":true + }, + { + "shape":"InvalidFileSystemException", + "exception":true + }, + { + "shape":"MultipleRegionsException", + "exception":true + }, + { + "shape":"BucketPermissionException", + "exception":true + }, + { + "shape":"MalformedManifestException", + "exception":true + }, + { + "shape":"CreateJobQuotaExceededException", + "exception":true + }, + { + "shape":"InvalidJobIdException", + "exception":true + }, + { + "shape":"InvalidVersionException", + "exception":true + } + ] + }, + "GetShippingLabel":{ + "name":"GetShippingLabel", + "http":{ + "method":"POST", + "requestUri":"/?Operation=GetShippingLabel" + }, + "input":{"shape":"GetShippingLabelInput"}, + "output":{ + "shape":"GetShippingLabelOutput", + "resultWrapper":"GetShippingLabelResult" + }, + "errors":[ + { + "shape":"InvalidJobIdException", + "exception":true + }, + { + "shape":"ExpiredJobIdException", + "exception":true + }, + { + "shape":"CanceledJobIdException", + "exception":true + }, + { + "shape":"InvalidAccessKeyIdException", + "exception":true + }, + { + "shape":"InvalidAddressException", + "exception":true + }, + { + "shape":"InvalidVersionException", + "exception":true + }, + { + "shape":"InvalidParameterException", + "exception":true + } + ] + }, + "GetStatus":{ + "name":"GetStatus", + "http":{ + "method":"POST", + "requestUri":"/?Operation=GetStatus" + }, + "input":{"shape":"GetStatusInput"}, + "output":{ + "shape":"GetStatusOutput", + "resultWrapper":"GetStatusResult" + }, + "errors":[ + { + "shape":"InvalidJobIdException", + "exception":true + }, + { + "shape":"ExpiredJobIdException", + "exception":true + }, + { + "shape":"CanceledJobIdException", + "exception":true + }, + { + "shape":"InvalidAccessKeyIdException", + "exception":true + }, + { + "shape":"InvalidVersionException", + "exception":true + } + ] + }, + "ListJobs":{ + "name":"ListJobs", + "http":{ + "method":"POST", + "requestUri":"/?Operation=ListJobs" + }, + "input":{"shape":"ListJobsInput"}, + "output":{ + "shape":"ListJobsOutput", + "resultWrapper":"ListJobsResult" + }, + "errors":[ + { + "shape":"InvalidParameterException", + "exception":true + }, + { + "shape":"InvalidAccessKeyIdException", + "exception":true + }, + { + "shape":"InvalidVersionException", + "exception":true + } + ] + }, + "UpdateJob":{ + "name":"UpdateJob", + "http":{ + "method":"POST", + "requestUri":"/?Operation=UpdateJob" + }, + "input":{"shape":"UpdateJobInput"}, + "output":{ + "shape":"UpdateJobOutput", + "resultWrapper":"UpdateJobResult" + }, + "errors":[ + { + "shape":"MissingParameterException", + "exception":true + }, + { + "shape":"InvalidParameterException", + "exception":true + }, + { + "shape":"InvalidAccessKeyIdException", + "exception":true + }, + { + "shape":"InvalidAddressException", + "exception":true + }, + { + "shape":"InvalidManifestFieldException", + "exception":true + }, + { + "shape":"InvalidJobIdException", + "exception":true + }, + { + "shape":"MissingManifestFieldException", + "exception":true + }, + { + "shape":"NoSuchBucketException", + "exception":true + }, + { + "shape":"ExpiredJobIdException", + "exception":true + }, + { + "shape":"CanceledJobIdException", + "exception":true + }, + { + "shape":"MissingCustomsException", + "exception":true + }, + { + "shape":"InvalidCustomsException", + "exception":true + }, + { + "shape":"InvalidFileSystemException", + "exception":true + }, + { + "shape":"MultipleRegionsException", + "exception":true + }, + { + "shape":"BucketPermissionException", + "exception":true + }, + { + "shape":"MalformedManifestException", + "exception":true + }, + { + "shape":"UnableToUpdateJobIdException", + "exception":true + }, + { + "shape":"InvalidVersionException", + "exception":true + } + ] + } + }, + "shapes":{ + "APIVersion":{"type":"string"}, + "Artifact":{ + "type":"structure", + "members":{ + "Description":{"shape":"Description"}, + "URL":{"shape":"URL"} + } + }, + "ArtifactList":{ + "type":"list", + "member":{"shape":"Artifact"} + }, + "BucketPermissionException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true + }, + "CancelJobInput":{ + "type":"structure", + "required":["JobId"], + "members":{ + "JobId":{"shape":"JobId"}, + "APIVersion":{"shape":"APIVersion"} + } + }, + "CancelJobOutput":{ + "type":"structure", + "members":{ + "Success":{"shape":"Success"} + } + }, + "CanceledJobIdException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true + }, + "Carrier":{"type":"string"}, + "CreateJobInput":{ + "type":"structure", + "required":[ + "JobType", + "Manifest", + "ValidateOnly" + ], + "members":{ + "JobType":{"shape":"JobType"}, + "Manifest":{"shape":"Manifest"}, + "ManifestAddendum":{"shape":"ManifestAddendum"}, + "ValidateOnly":{"shape":"ValidateOnly"}, + "APIVersion":{"shape":"APIVersion"} + } + }, + "CreateJobOutput":{ + "type":"structure", + "members":{ + "JobId":{"shape":"JobId"}, + "JobType":{"shape":"JobType"}, + "Signature":{"shape":"Signature"}, + "SignatureFileContents":{"shape":"SignatureFileContents"}, + "WarningMessage":{"shape":"WarningMessage"}, + "ArtifactList":{"shape":"ArtifactList"} + } + }, + "CreateJobQuotaExceededException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true + }, + "CreationDate":{"type":"timestamp"}, + "CurrentManifest":{"type":"string"}, + "Description":{"type":"string"}, + "ErrorCount":{"type":"integer"}, + "ErrorMessage":{"type":"string"}, + "ExpiredJobIdException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true + }, + "GenericString":{"type":"string"}, + "GetShippingLabelInput":{ + "type":"structure", + "required":["jobIds"], + "members":{ + "jobIds":{"shape":"JobIdList"}, + "name":{"shape":"name"}, + "company":{"shape":"company"}, + "phoneNumber":{"shape":"phoneNumber"}, + "country":{"shape":"country"}, + "stateOrProvince":{"shape":"stateOrProvince"}, + "city":{"shape":"city"}, + "postalCode":{"shape":"postalCode"}, + "street1":{"shape":"street1"}, + "street2":{"shape":"street2"}, + "street3":{"shape":"street3"}, + "APIVersion":{"shape":"APIVersion"} + } + }, + "GetShippingLabelOutput":{ + "type":"structure", + "members":{ + "ShippingLabelURL":{"shape":"GenericString"}, + "Warning":{"shape":"GenericString"} + } + }, + "GetStatusInput":{ + "type":"structure", + "required":["JobId"], + "members":{ + "JobId":{"shape":"JobId"}, + "APIVersion":{"shape":"APIVersion"} + } + }, + "GetStatusOutput":{ + "type":"structure", + "members":{ + "JobId":{"shape":"JobId"}, + "JobType":{"shape":"JobType"}, + "LocationCode":{"shape":"LocationCode"}, + "LocationMessage":{"shape":"LocationMessage"}, + "ProgressCode":{"shape":"ProgressCode"}, + "ProgressMessage":{"shape":"ProgressMessage"}, + "Carrier":{"shape":"Carrier"}, + "TrackingNumber":{"shape":"TrackingNumber"}, + "LogBucket":{"shape":"LogBucket"}, + "LogKey":{"shape":"LogKey"}, + "ErrorCount":{"shape":"ErrorCount"}, + "Signature":{"shape":"Signature"}, + "SignatureFileContents":{"shape":"Signature"}, + "CurrentManifest":{"shape":"CurrentManifest"}, + "CreationDate":{"shape":"CreationDate"}, + "ArtifactList":{"shape":"ArtifactList"} + } + }, + "InvalidAccessKeyIdException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true + }, + "InvalidAddressException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true + }, + "InvalidCustomsException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true + }, + "InvalidFileSystemException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true + }, + "InvalidJobIdException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true + }, + "InvalidManifestFieldException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true + }, + "InvalidParameterException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true + }, + "InvalidVersionException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true + }, + "IsCanceled":{"type":"boolean"}, + "IsTruncated":{"type":"boolean"}, + "Job":{ + "type":"structure", + "members":{ + "JobId":{"shape":"JobId"}, + "CreationDate":{"shape":"CreationDate"}, + "IsCanceled":{"shape":"IsCanceled"}, + "JobType":{"shape":"JobType"} + } + }, + "JobId":{"type":"string"}, + "JobIdList":{ + "type":"list", + "member":{"shape":"GenericString"} + }, + "JobType":{ + "type":"string", + "enum":[ + "Import", + "Export" + ] + }, + "JobsList":{ + "type":"list", + "member":{"shape":"Job"} + }, + "ListJobsInput":{ + "type":"structure", + "members":{ + "MaxJobs":{"shape":"MaxJobs"}, + "Marker":{"shape":"Marker"}, + "APIVersion":{"shape":"APIVersion"} + } + }, + "ListJobsOutput":{ + "type":"structure", + "members":{ + "Jobs":{"shape":"JobsList"}, + "IsTruncated":{"shape":"IsTruncated"} + } + }, + "LocationCode":{"type":"string"}, + "LocationMessage":{"type":"string"}, + "LogBucket":{"type":"string"}, + "LogKey":{"type":"string"}, + "MalformedManifestException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true + }, + "Manifest":{"type":"string"}, + "ManifestAddendum":{"type":"string"}, + "Marker":{"type":"string"}, + "MaxJobs":{"type":"integer"}, + "MissingCustomsException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true + }, + "MissingManifestFieldException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true + }, + "MissingParameterException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true + }, + "MultipleRegionsException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true + }, + "NoSuchBucketException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true + }, + "ProgressCode":{"type":"string"}, + "ProgressMessage":{"type":"string"}, + "Signature":{"type":"string"}, + "SignatureFileContents":{"type":"string"}, + "Success":{"type":"boolean"}, + "TrackingNumber":{"type":"string"}, + "URL":{"type":"string"}, + "UnableToCancelJobIdException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true + }, + "UnableToUpdateJobIdException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true + }, + "UpdateJobInput":{ + "type":"structure", + "required":[ + "JobId", + "Manifest", + "JobType", + "ValidateOnly" + ], + "members":{ + "JobId":{"shape":"JobId"}, + "Manifest":{"shape":"Manifest"}, + "JobType":{"shape":"JobType"}, + "ValidateOnly":{"shape":"ValidateOnly"}, + "APIVersion":{"shape":"APIVersion"} + } + }, + "UpdateJobOutput":{ + "type":"structure", + "members":{ + "Success":{"shape":"Success"}, + "WarningMessage":{"shape":"WarningMessage"}, + "ArtifactList":{"shape":"ArtifactList"} + } + }, + "ValidateOnly":{"type":"boolean"}, + "WarningMessage":{"type":"string"}, + "city":{"type":"string"}, + "company":{"type":"string"}, + "country":{"type":"string"}, + "name":{"type":"string"}, + "phoneNumber":{"type":"string"}, + "postalCode":{"type":"string"}, + "stateOrProvince":{"type":"string"}, + "street1":{"type":"string"}, + "street2":{"type":"string"}, + "street3":{"type":"string"} + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/importexport/2010-06-01/docs-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/importexport/2010-06-01/docs-2.json new file mode 100644 index 000000000..601090e96 --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/importexport/2010-06-01/docs-2.json @@ -0,0 +1,482 @@ +{ + "version": "2.0", + "operations": { + "CancelJob": "This operation cancels a specified job. Only the job owner can cancel it. The operation fails if the job has already started or is complete.", + "CreateJob": "This operation initiates the process of scheduling an upload or download of your data. You include in the request a manifest that describes the data transfer specifics. The response to the request includes a job ID, which you can use in other operations, a signature that you use to identify your storage device, and the address where you should ship your storage device.", + "GetShippingLabel": "This operation generates a pre-paid UPS shipping label that you will use to ship your device to AWS for processing.", + "GetStatus": "This operation returns information about a job, including where the job is in the processing pipeline, the status of the results, and the signature value associated with the job. You can only return information about jobs you own.", + "ListJobs": "This operation returns the jobs associated with the requester. AWS Import/Export lists the jobs in reverse chronological order based on the date of creation. For example if Job Test1 was created 2009Dec30 and Test2 was created 2010Feb05, the ListJobs operation would return Test2 followed by Test1.", + "UpdateJob": "You use this operation to change the parameters specified in the original manifest file by supplying a new manifest file. The manifest file attached to this request replaces the original manifest file. You can only use the operation after a CreateJob request but before the data transfer starts and you can only use it on jobs you own." + }, + "service": "Amazon Inspector enables you to analyze the behavior of the applications you run in AWS and to identify potential security issues. For more information, see Amazon Inspector User Guide.
", + "operations": { + "AddAttributesToFindings": "Assigns attributes (key and value pair) to the findings specified by the findings' ARNs.
", + "AttachAssessmentAndRulesPackage": "Attaches the rules package specified by the rules package ARN to the assessment specified by the assessment ARN.
", + "CreateApplication": "Creates a new application using the resource group ARN generated by CreateResourceGroup. You can create up to 50 applications per AWS account. You can run up to 500 concurrent agents per AWS account. For more information, see Inspector Applications.
", + "CreateAssessment": "Creates an assessment for the application specified by the application ARN. You can create up to 500 assessments per AWS account.
", + "CreateResourceGroup": "Creates a resource group using the specified set of tags (key and value pairs) that are used to select the EC2 instances to be included in an Inspector application. The created resource group is then used to create an Inspector application.
", + "DeleteApplication": "Deletes the application specified by the application ARN.
", + "DeleteAssessment": "Deletes the assessment specified by the assessment ARN.
", + "DeleteRun": "Deletes the assessment run specified by the run ARN.
", + "DescribeApplication": "Describes the application specified by the application ARN.
", + "DescribeAssessment": "Describes the assessment specified by the assessment ARN.
", + "DescribeCrossAccountAccessRole": "Describes the IAM role that enables Inspector to access your AWS account.
", + "DescribeFinding": "Describes the finding specified by the finding ARN.
", + "DescribeResourceGroup": "Describes the resource group specified by the resource group ARN.
", + "DescribeRulesPackage": "Describes the rules package specified by the rules package ARN.
", + "DescribeRun": "Describes the assessment run specified by the run ARN.
", + "DetachAssessmentAndRulesPackage": "Detaches the rules package specified by the rules package ARN from the assessment specified by the assessment ARN.
", + "GetAssessmentTelemetry": "Returns the metadata about the telemetry (application behavioral data) for the assessment specified by the assessment ARN.
", + "ListApplications": "Lists the ARNs of the applications within this AWS account. For more information about applications, see Inspector Applications.
", + "ListAssessmentAgents": "Lists the agents of the assessment specified by the assessment ARN.
", + "ListAssessments": "Lists the assessments corresponding to applications specified by the applications' ARNs.
", + "ListAttachedAssessments": "Lists the assessments attached to the rules package specified by the rules package ARN.
", + "ListAttachedRulesPackages": "Lists the rules packages attached to the assessment specified by the assessment ARN.
", + "ListFindings": "Lists findings generated by the assessment run specified by the run ARNs.
", + "ListRulesPackages": "Lists all available Inspector rules packages.
", + "ListRuns": "Lists the assessment runs associated with the assessments specified by the assessment ARNs.
", + "ListTagsForResource": "Lists all tags associated with a resource.
", + "LocalizeText": "Translates a textual identifier into a user-readable text in a specified locale.
", + "PreviewAgentsForResourceGroup": "Previews the agents installed on the EC2 instances that are included in the application created with the specified resource group.
", + "RegisterCrossAccountAccessRole": "Register the role that Inspector uses to list your EC2 instances during the assessment.
", + "RemoveAttributesFromFindings": "Removes the entire attribute (key and value pair) from the findings specified by the finding ARNs where an attribute with the specified key exists.
", + "RunAssessment": "Starts the analysis of the application’s behavior against selected rule packages for the assessment specified by the assessment ARN.
", + "SetTagsForResource": "Sets tags (key and value pairs) to the assessment specified by the assessment ARN.
", + "StartDataCollection": "Starts data collection for the assessment specified by the assessment ARN. For this API to function properly, you must not exceed the limit of running up to 500 concurrent agents per AWS account.
", + "StopDataCollection": "Stop data collection for the assessment specified by the assessment ARN.
", + "UpdateApplication": "Updates application specified by the application ARN.
", + "UpdateAssessment": "Updates the assessment specified by the assessment ARN.
" + }, + "shapes": { + "AccessDeniedException": { + "base": null, + "refs": { + } + }, + "AddAttributesToFindingsRequest": { + "base": null, + "refs": { + } + }, + "AddAttributesToFindingsResponse": { + "base": null, + "refs": { + } + }, + "Agent": { + "base": "Contains information about an Inspector agent. This data type is used as a response element in the ListAssessmentAgents action.
", + "refs": { + "AgentList$member": null + } + }, + "AgentHealth": { + "base": null, + "refs": { + "Agent$agentHealth": "The current health state of the agent. Values can be set to HEALTHY or UNHEALTHY.
", + "AgentHealthList$member": null + } + }, + "AgentHealthCode": { + "base": null, + "refs": { + "Agent$agentHealthCode": "The detailed health state of the agent. Values can be set to RUNNING, HEALTHY, UNHEALTHY, UNKNOWN, BLACKLISTED, SHUTDOWN, THROTTLED.
" + } + }, + "AgentHealthDetails": { + "base": null, + "refs": { + "Agent$agentHealthDetails": "The description for the agent health code.
" + } + }, + "AgentHealthList": { + "base": null, + "refs": { + "AgentsFilter$agentHealthList": "For a record to match a filter, the value specified for this data type property must be the exact match of the value of the agentHealth property of the Agent data type.
" + } + }, + "AgentId": { + "base": null, + "refs": { + "Agent$agentId": "The EC2 instance ID where the agent is installed.
", + "AgentPreview$agentId": "The id of the EC2 instance where the agent is intalled.
", + "Finding$agentId": "The EC2 instance ID where the agent is installed that is used during the assessment that generates the finding.
" + } + }, + "AgentList": { + "base": null, + "refs": { + "ListAssessmentAgentsResponse$agentList": "A list of ARNs specifying the agents returned by the action.
" + } + }, + "AgentPreview": { + "base": "This data type is used as a response element in the PreviewAgentsForResourceGroup action.
", + "refs": { + "AgentPreviewList$member": null + } + }, + "AgentPreviewList": { + "base": null, + "refs": { + "PreviewAgentsForResourceGroupResponse$agentPreviewList": "The resulting list of agents.
" + } + }, + "AgentsFilter": { + "base": "This data type is used as a response element in the ListAssessmentAgents action.
", + "refs": { + "ListAssessmentAgentsRequest$filter": "You can use this parameter to specify a subset of data to be included in the action's response.
For a record to match a filter, all specified filter attributes must match. When multiple values are specified for a filter attribute, any of the values can match.
" + } + }, + "Application": { + "base": "Contains information about an Inspector application.
This data type is used as the response element in the DescribeApplication action.
", + "refs": { + "DescribeApplicationResponse$application": "Information about the application.
" + } + }, + "ApplicationsFilter": { + "base": "This data type is used as the request parameter in the ListApplications action.
", + "refs": { + "ListApplicationsRequest$filter": "You can use this parameter to specify a subset of data to be included in the action's response.
For a record to match a filter, all specified filter attributes must match. When multiple values are specified for a filter attribute, any of the values can match.
" + } + }, + "Arn": { + "base": null, + "refs": { + "Agent$assessmentArn": "The ARN of the assessment that is associated with the agent.
", + "Application$applicationArn": "The ARN specifying the Inspector application.
", + "Application$resourceGroupArn": "The ARN specifying the resource group that is associated with the application.
", + "ArnList$member": null, + "Assessment$assessmentArn": "The ARN of the assessment.
", + "Assessment$applicationArn": "The ARN of the application that corresponds to this assessment.
", + "AttachAssessmentAndRulesPackageRequest$assessmentArn": "The ARN specifying the assessment to which you want to attach a rules package.
", + "AttachAssessmentAndRulesPackageRequest$rulesPackageArn": "The ARN specifying the rules package that you want to attach to the assessment.
", + "CreateApplicationRequest$resourceGroupArn": "The ARN specifying the resource group that is used to create the application.
", + "CreateApplicationResponse$applicationArn": "The ARN specifying the application that is created.
", + "CreateAssessmentRequest$applicationArn": "The ARN specifying the application for which you want to create an assessment.
", + "CreateAssessmentResponse$assessmentArn": "The ARN specifying the assessment that is created.
", + "CreateResourceGroupResponse$resourceGroupArn": "The ARN specifying the resource group that is created.
", + "DeleteApplicationRequest$applicationArn": "The ARN specifying the application that you want to delete.
", + "DeleteAssessmentRequest$assessmentArn": "The ARN specifying the assessment that you want to delete.
", + "DeleteRunRequest$runArn": "The ARN specifying the assessment run that you want to delete.
", + "DescribeApplicationRequest$applicationArn": "The ARN specifying the application that you want to describe.
", + "DescribeAssessmentRequest$assessmentArn": "The ARN specifying the assessment that you want to describe.
", + "DescribeCrossAccountAccessRoleResponse$roleArn": "The ARN specifying the IAM role that Inspector uses to access your AWS account.
", + "DescribeFindingRequest$findingArn": "The ARN specifying the finding that you want to describe.
", + "DescribeResourceGroupRequest$resourceGroupArn": "The ARN specifying the resource group that you want to describe.
", + "DescribeRulesPackageRequest$rulesPackageArn": "The ARN specifying the rules package that you want to describe.
", + "DescribeRunRequest$runArn": "The ARN specifying the assessment run that you want to describe.
", + "DetachAssessmentAndRulesPackageRequest$assessmentArn": "The ARN specifying the assessment from which you want to detach a rules package.
", + "DetachAssessmentAndRulesPackageRequest$rulesPackageArn": "The ARN specifying the rules package that you want to detach from the assessment.
", + "Finding$findingArn": "The ARN specifying the finding.
", + "Finding$runArn": "The ARN of the assessment run that generated the finding.
", + "Finding$rulesPackageArn": "The ARN of the rules package that is used to generate the finding.
", + "GetAssessmentTelemetryRequest$assessmentArn": "The ARN specifying the assessment the telemetry of which you want to obtain.
", + "ListAssessmentAgentsRequest$assessmentArn": "The ARN specifying the assessment whose agents you want to list.
", + "ListAttachedAssessmentsRequest$rulesPackageArn": "The ARN specifying the rules package whose assessments you want to list.
", + "ListAttachedRulesPackagesRequest$assessmentArn": "The ARN specifying the assessment whose rules packages you want to list.
", + "ListTagsForResourceRequest$resourceArn": "The ARN specifying the resource whose tags you want to list.
", + "PreviewAgentsForResourceGroupRequest$resourceGroupArn": "The ARN of the resource group that is used to create an application.
", + "RegisterCrossAccountAccessRoleRequest$roleArn": "The ARN of the IAM role that Inspector uses to list your EC2 instances during the assessment.", + "ResourceGroup$resourceGroupArn": "The ARN of the resource group.
", + "RulesPackage$rulesPackageArn": "The ARN of the rules package.
", + "Run$runArn": "The ARN of the run.
", + "Run$assessmentArn": "The ARN of the assessment that is associated with the run.
", + "RunAssessmentRequest$assessmentArn": "The ARN of the assessment that you want to run.
", + "RunAssessmentResponse$runArn": "The ARN specifying the run of the assessment.
", + "SetTagsForResourceRequest$resourceArn": "The ARN of the assessment that you want to set tags to.
", + "StartDataCollectionRequest$assessmentArn": "The ARN of the assessment for which you want to start the data collection process.
", + "StopDataCollectionRequest$assessmentArn": "The ARN of the assessment for which you want to stop the data collection process.
", + "UpdateApplicationRequest$applicationArn": "Application ARN that you want to update.
", + "UpdateApplicationRequest$resourceGroupArn": "The resource group ARN that you want to update.
", + "UpdateAssessmentRequest$assessmentArn": "Asessment ARN that you want to update.
" + } + }, + "ArnList": { + "base": null, + "refs": { + "AddAttributesToFindingsRequest$findingArns": "The ARNs specifying the findings that you want to assign attributes to.
", + "FindingsFilter$rulesPackageArns": "For a record to match a filter, the value specified for this data type property must be the exact match of the value of the rulesPackageArn property of the Finding data type.
", + "ListApplicationsResponse$applicationArnList": "A list of ARNs specifying the applications returned by the action.
", + "ListAssessmentsRequest$applicationArns": "A list of ARNs specifying the applications the assessments of which you want to list.
", + "ListAssessmentsResponse$assessmentArnList": "A list of ARNs specifying the assessments returned by the action.
", + "ListAttachedAssessmentsResponse$assessmentArnList": "A list of ARNs specifying the assessments returned by the action.
", + "ListAttachedRulesPackagesResponse$rulesPackageArnList": "A list of ARNs specifying the rules packages returned by the action.
", + "ListFindingsRequest$runArns": "The ARNs of the assessment runs that generate the findings that you want to list.
", + "ListFindingsResponse$findingArnList": "A list of ARNs specifying the findings returned by the action.
", + "ListRulesPackagesResponse$rulesPackageArnList": "The list of ARNs specifying the rules packages returned by the action.
", + "ListRunsRequest$assessmentArns": "The ARNs specifying the assessments whose runs you want to list.
", + "ListRunsResponse$runArnList": "A list of ARNs specifying the assessment runs returned by the action.
", + "RemoveAttributesFromFindingsRequest$findingArns": "The ARNs specifying the findings that you want to remove attributes from.
", + "Run$rulesPackages": "Rules packages selected for the run of the assessment.
", + "RunsFilter$rulesPackages": "For a record to match a filter, the value specified for this data type property must match a list of values of the rulesPackages property of the Run data type.
" + } + }, + "Assessment": { + "base": "Contains information about an Inspector assessment.
This data type is used as the response element in the DescribeAssessment action.
", + "refs": { + "DescribeAssessmentResponse$assessment": "Information about the assessment.
" + } + }, + "AssessmentState": { + "base": null, + "refs": { + "Assessment$assessmentState": "The state of the assessment. Values can be set to Created, Collecting Data, Stopping, and Completed.
", + "AssessmentStateList$member": null + } + }, + "AssessmentStateList": { + "base": null, + "refs": { + "AssessmentsFilter$assessmentStates": "For a record to match a filter, the value specified for this data type property must be the exact match of the value of the assessmentState property of the Assessment data type.
" + } + }, + "AssessmentsFilter": { + "base": "This data type is used as the request parameter in the ListAssessments and ListAttachedAssessments actions.
", + "refs": { + "ListAssessmentsRequest$filter": "You can use this parameter to specify a subset of data to be included in the action's response.
For a record to match a filter, all specified filter attributes must match. When multiple values are specified for a filter attribute, any of the values can match.
", + "ListAttachedAssessmentsRequest$filter": "You can use this parameter to specify a subset of data to be included in the action's response.
For a record to match a filter, all specified filter attributes must match. When multiple values are specified for a filter attribute, any of the values can match.
" + } + }, + "AttachAssessmentAndRulesPackageRequest": { + "base": null, + "refs": { + } + }, + "AttachAssessmentAndRulesPackageResponse": { + "base": null, + "refs": { + } + }, + "Attribute": { + "base": "This data type is used as a response element in the AddAttributesToFindings action and a request parameter in the CreateAssessment action.
", + "refs": { + "AttributeList$member": null + } + }, + "AttributeKey": { + "base": null, + "refs": { + "Attribute$key": "The attribute key.
", + "AttributeKeyList$member": null + } + }, + "AttributeKeyList": { + "base": null, + "refs": { + "RemoveAttributesFromFindingsRequest$attributeKeys": "The array of attribute keys that you want to remove from specified findings.
" + } + }, + "AttributeList": { + "base": null, + "refs": { + "AddAttributesToFindingsRequest$attributes": "The array of attributes that you want to assign to specified findings.
", + "Assessment$userAttributesForFindings": "The user-defined attributes that are assigned to every generated finding.
", + "CreateAssessmentRequest$userAttributesForFindings": "The user-defined attributes that are assigned to every finding generated by running this assessment.
", + "Finding$attributes": "The system-defined attributes for the finding.
", + "Finding$userAttributes": "The user-defined attributes that are assigned to the finding.
", + "FindingsFilter$attributes": "For a record to match a filter, the value specified for this data type property must be the exact match of the value of the attributes property of the Finding data type.
", + "FindingsFilter$userAttributes": "For a record to match a filter, the value specified for this data type property must be the exact match of the value of the userAttributes property of the Finding data type.
" + } + }, + "AttributeValue": { + "base": null, + "refs": { + "Attribute$value": "The value assigned to the attribute key.
" + } + }, + "AutoScalingGroup": { + "base": null, + "refs": { + "Agent$autoScalingGroup": "This data type property is currently not used.
", + "AgentPreview$autoScalingGroup": "The autoscaling group for the EC2 instance where the agent is installed.
", + "Finding$autoScalingGroup": "The autoscaling group of the EC2 instance where the agent is installed that is used during the assessment that generates the finding.
" + } + }, + "AwsAccount": { + "base": null, + "refs": { + "Agent$accountId": "AWS account of the EC2 instance where the agent is installed.
" + } + }, + "Bool": { + "base": null, + "refs": { + "Assessment$dataCollected": "Boolean value (true or false) specifying whether the data collection process is completed.
", + "AssessmentsFilter$dataCollected": "For a record to match a filter, the value specified for this data type property must be the exact match of the value of the dataCollected property of the Assessment data type.
", + "DescribeCrossAccountAccessRoleResponse$valid": "A Boolean value that specifies whether the IAM role has the necessary policies attached to enable Inspector to access your AWS account.
" + } + }, + "CreateApplicationRequest": { + "base": null, + "refs": { + } + }, + "CreateApplicationResponse": { + "base": null, + "refs": { + } + }, + "CreateAssessmentRequest": { + "base": null, + "refs": { + } + }, + "CreateAssessmentResponse": { + "base": null, + "refs": { + } + }, + "CreateResourceGroupRequest": { + "base": null, + "refs": { + } + }, + "CreateResourceGroupResponse": { + "base": null, + "refs": { + } + }, + "DeleteApplicationRequest": { + "base": null, + "refs": { + } + }, + "DeleteApplicationResponse": { + "base": null, + "refs": { + } + }, + "DeleteAssessmentRequest": { + "base": null, + "refs": { + } + }, + "DeleteAssessmentResponse": { + "base": null, + "refs": { + } + }, + "DeleteRunRequest": { + "base": null, + "refs": { + } + }, + "DeleteRunResponse": { + "base": null, + "refs": { + } + }, + "DescribeApplicationRequest": { + "base": null, + "refs": { + } + }, + "DescribeApplicationResponse": { + "base": null, + "refs": { + } + }, + "DescribeAssessmentRequest": { + "base": null, + "refs": { + } + }, + "DescribeAssessmentResponse": { + "base": null, + "refs": { + } + }, + "DescribeCrossAccountAccessRoleResponse": { + "base": null, + "refs": { + } + }, + "DescribeFindingRequest": { + "base": null, + "refs": { + } + }, + "DescribeFindingResponse": { + "base": null, + "refs": { + } + }, + "DescribeResourceGroupRequest": { + "base": null, + "refs": { + } + }, + "DescribeResourceGroupResponse": { + "base": null, + "refs": { + } + }, + "DescribeRulesPackageRequest": { + "base": null, + "refs": { + } + }, + "DescribeRulesPackageResponse": { + "base": null, + "refs": { + } + }, + "DescribeRunRequest": { + "base": null, + "refs": { + } + }, + "DescribeRunResponse": { + "base": null, + "refs": { + } + }, + "DetachAssessmentAndRulesPackageRequest": { + "base": null, + "refs": { + } + }, + "DetachAssessmentAndRulesPackageResponse": { + "base": null, + "refs": { + } + }, + "Duration": { + "base": null, + "refs": { + "Assessment$durationInSeconds": "The assessment duration in seconds. The default value is 3600 seconds (one hour). The maximum value is 86400 seconds (one day).
", + "CreateAssessmentRequest$durationInSeconds": "The duration of the assessment in seconds. The default value is 3600 seconds (one hour). The maximum value is 86400 seconds (one day).
", + "DurationRange$minimum": "The minimum value of the duration range. Must be greater than zero.
", + "DurationRange$maximum": "The maximum value of the duration range. Must be less than or equal to 604800 seconds (1 week).
", + "UpdateAssessmentRequest$durationInSeconds": "Assessment duration in seconds that you want to update. The default value is 3600 seconds (one hour). The maximum value is 86400 seconds (one day).
" + } + }, + "DurationRange": { + "base": "This data type is used in the AssessmentsFilter data type.
", + "refs": { + "AssessmentsFilter$durationRange": "For a record to match a filter, the value specified for this data type property must inclusively match any value between the specified minimum and maximum values of the durationInSeconds property of the Assessment data type.
" + } + }, + "FailureMessage": { + "base": null, + "refs": { + "Assessment$failureMessage": "This data type property is not currently used.
" + } + }, + "Finding": { + "base": "Contains information about an Inspector finding.
This data type is used as the response element in the DescribeFinding action.
", + "refs": { + "DescribeFindingResponse$finding": "Information about the finding.
" + } + }, + "FindingsFilter": { + "base": "This data type is used as a request parameter in the ListFindings action.
", + "refs": { + "ListFindingsRequest$filter": "You can use this parameter to specify a subset of data to be included in the action's response.
For a record to match a filter, all specified filter attributes must match. When multiple values are specified for a filter attribute, any of the values can match.
" + } + }, + "GetAssessmentTelemetryRequest": { + "base": null, + "refs": { + } + }, + "GetAssessmentTelemetryResponse": { + "base": null, + "refs": { + } + }, + "Integer": { + "base": null, + "refs": { + "ListApplicationsRequest$maxResults": "You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.
", + "ListAssessmentAgentsRequest$maxResults": "You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.
", + "ListAssessmentsRequest$maxResults": "You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.
", + "ListAttachedAssessmentsRequest$maxResults": "You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.
", + "ListAttachedRulesPackagesRequest$maxResults": "You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.
", + "ListFindingsRequest$maxResults": "You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.
", + "ListRulesPackagesRequest$maxResults": "You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.
", + "ListRunsRequest$maxResults": "You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.
", + "PreviewAgentsForResourceGroupRequest$maxResults": "You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.
" + } + }, + "InternalException": { + "base": null, + "refs": { + } + }, + "InvalidCrossAccountRoleException": { + "base": null, + "refs": { + } + }, + "InvalidInputException": { + "base": null, + "refs": { + } + }, + "ListApplicationsRequest": { + "base": null, + "refs": { + } + }, + "ListApplicationsResponse": { + "base": null, + "refs": { + } + }, + "ListAssessmentAgentsRequest": { + "base": null, + "refs": { + } + }, + "ListAssessmentAgentsResponse": { + "base": null, + "refs": { + } + }, + "ListAssessmentsRequest": { + "base": null, + "refs": { + } + }, + "ListAssessmentsResponse": { + "base": null, + "refs": { + } + }, + "ListAttachedAssessmentsRequest": { + "base": null, + "refs": { + } + }, + "ListAttachedAssessmentsResponse": { + "base": null, + "refs": { + } + }, + "ListAttachedRulesPackagesRequest": { + "base": null, + "refs": { + } + }, + "ListAttachedRulesPackagesResponse": { + "base": null, + "refs": { + } + }, + "ListFindingsRequest": { + "base": null, + "refs": { + } + }, + "ListFindingsResponse": { + "base": null, + "refs": { + } + }, + "ListRulesPackagesRequest": { + "base": null, + "refs": { + } + }, + "ListRulesPackagesResponse": { + "base": null, + "refs": { + } + }, + "ListRunsRequest": { + "base": null, + "refs": { + } + }, + "ListRunsResponse": { + "base": null, + "refs": { + } + }, + "ListTagsForResourceRequest": { + "base": null, + "refs": { + } + }, + "ListTagsForResourceResponse": { + "base": null, + "refs": { + } + }, + "Locale": { + "base": null, + "refs": { + "LocalizeTextRequest$locale": "The locale that you want to translate a textual identifier into.
" + } + }, + "LocalizeTextRequest": { + "base": null, + "refs": { + } + }, + "LocalizeTextResponse": { + "base": null, + "refs": { + } + }, + "LocalizedFacility": { + "base": null, + "refs": { + "LocalizedTextKey$facility": "The module response source of the text.
" + } + }, + "LocalizedText": { + "base": "The textual identifier. This data type is used as the request parameter in the LocalizeText action.
", + "refs": { + "Finding$finding": "A short description that identifies the finding.
", + "Finding$description": "The description of the finding.
", + "Finding$recommendation": "The recommendation for the finding.
", + "LocalizedTextList$member": null, + "RulesPackage$description": "The description of the rules package.
" + } + }, + "LocalizedTextId": { + "base": null, + "refs": { + "LocalizedTextKey$id": "Part of the module response source of the text.
" + } + }, + "LocalizedTextKey": { + "base": "This data type is used in the LocalizedText data type.
", + "refs": { + "LocalizedText$key": "The facility and id properties of the LocalizedTextKey data type.
" + } + }, + "LocalizedTextList": { + "base": null, + "refs": { + "LocalizeTextRequest$localizedTexts": "A list of textual identifiers.
" + } + }, + "Long": { + "base": null, + "refs": { + "MessageTypeTelemetry$count": "The number of times that the behavioral data is collected by the agent during an assessment.
", + "MessageTypeTelemetry$dataSize": "The total size of the behavioral data that is collected by the agent during an assessment.
" + } + }, + "Message": { + "base": null, + "refs": { + "AddAttributesToFindingsResponse$message": "Confirmation details of the action performed.
", + "AttachAssessmentAndRulesPackageResponse$message": "Confirmation details of the action performed.
", + "DeleteApplicationResponse$message": "Confirmation details of the action performed.
", + "DeleteAssessmentResponse$message": "Confirmation details of the action performed.
", + "DeleteRunResponse$message": "Confirmation details of the action performed.
", + "DetachAssessmentAndRulesPackageResponse$message": "Confirmation details of the action performed.
", + "LocalizeTextResponse$message": "Confirmation details of the action performed.
", + "RegisterCrossAccountAccessRoleResponse$message": "Confirmation details of the action performed.
", + "RemoveAttributesFromFindingsResponse$message": "Confirmation details of the action performed.
", + "SetTagsForResourceResponse$message": "Confirmation details of the action performed.
", + "StartDataCollectionResponse$message": "Confirmation details of the action performed.
", + "StopDataCollectionResponse$message": "Confirmation details of the action performed.
", + "UpdateApplicationResponse$message": "Confirmation details of the action performed.
", + "UpdateAssessmentResponse$message": "Confirmation details of the action performed.
" + } + }, + "MessageType": { + "base": null, + "refs": { + "MessageTypeTelemetry$messageType": "A specific type of behavioral data that is collected by the agent.
" + } + }, + "MessageTypeTelemetry": { + "base": "This data type is used in the Telemetry data type.
This is metadata about the behavioral data collected by the Inspector agent on your EC2 instances during an assessment and passed to the Inspector service for analysis.
", + "refs": { + "MessageTypeTelemetryList$member": null + } + }, + "MessageTypeTelemetryList": { + "base": null, + "refs": { + "Telemetry$messageTypeTelemetries": "Counts of individual metrics received by Inspector from the agent.
" + } + }, + "Name": { + "base": null, + "refs": { + "Application$applicationName": "The name of the Inspector application.
", + "Assessment$assessmentName": "The name of the assessment.
", + "CreateApplicationRequest$applicationName": "The user-defined name identifying the application that you want to create. The name must be unique within the AWS account.
", + "CreateAssessmentRequest$assessmentName": "The user-defined name identifying the assessment that you want to create. You can create several assessments for an application. The names of the assessments corresponding to a particular application must be unique.
", + "Finding$ruleName": "The rule name that is used to generate the finding.
", + "NameList$member": null, + "RulesPackage$rulesPackageName": "The name of the rules package.
", + "RulesPackage$provider": "The provider of the rules package.
", + "Run$runName": "The auto-generated name for the run.
", + "RunAssessmentRequest$runName": "A name specifying the run of the assessment.
", + "UpdateApplicationRequest$applicationName": "Application name that you want to update.
", + "UpdateAssessmentRequest$assessmentName": "Assessment name that you want to update.
" + } + }, + "NameList": { + "base": null, + "refs": { + "FindingsFilter$ruleNames": "For a record to match a filter, the value specified for this data type property must be the exact match of the value of the ruleName property of the Finding data type.
" + } + }, + "NamePattern": { + "base": null, + "refs": { + "NamePatternList$member": null + } + }, + "NamePatternList": { + "base": null, + "refs": { + "ApplicationsFilter$applicationNamePatterns": "For a record to match a filter, an explicit value or a string containing a wildcard specified for this data type property must match the value of the applicationName property of the Application data type.
", + "AssessmentsFilter$assessmentNamePatterns": "For a record to match a filter, an explicit value or a string containing a wildcard specified for this data type property must match the value of the assessmentName property of the Assessment data type.
", + "RunsFilter$runNamePatterns": "For a record to match a filter, an explicit value or a string containing a wildcard specified for this data type property must match the value of the runName property of the Run data type.
" + } + }, + "NoSuchEntityException": { + "base": null, + "refs": { + } + }, + "OperationInProgressException": { + "base": null, + "refs": { + } + }, + "PaginationToken": { + "base": null, + "refs": { + "ListApplicationsRequest$nextToken": "You can use this parameter when paginating results. Set the value of this parameter to 'null' on your first call to the ListApplications action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from previous response to continue listing data.
", + "ListApplicationsResponse$nextToken": "When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to 'null'.
", + "ListAssessmentAgentsRequest$nextToken": "You can use this parameter when paginating results. Set the value of this parameter to 'null' on your first call to the ListAssessmentAgents action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from previous response to continue listing data.
", + "ListAssessmentAgentsResponse$nextToken": "When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to 'null'.
", + "ListAssessmentsRequest$nextToken": "You can use this parameter when paginating results. Set the value of this parameter to 'null' on your first call to the ListAssessments action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from previous response to continue listing data.
", + "ListAssessmentsResponse$nextToken": "When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to 'null'.
", + "ListAttachedAssessmentsRequest$nextToken": "You can use this parameter when paginating results. Set the value of this parameter to 'null' on your first call to the ListAttachedAssessments action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from previous response to continue listing data.
", + "ListAttachedAssessmentsResponse$nextToken": "When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to 'null'.
", + "ListAttachedRulesPackagesRequest$nextToken": "You can use this parameter when paginating results. Set the value of this parameter to 'null' on your first call to the ListAttachedRulesPackages action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from previous response to continue listing data.
", + "ListAttachedRulesPackagesResponse$nextToken": "When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to 'null'.
", + "ListFindingsRequest$nextToken": "You can use this parameter when paginating results. Set the value of this parameter to 'null' on your first call to the ListFindings action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from previous response to continue listing data.
", + "ListFindingsResponse$nextToken": "When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to 'null'.
", + "ListRulesPackagesRequest$nextToken": "You can use this parameter when paginating results. Set the value of this parameter to 'null' on your first call to the ListRulesPackages action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from previous response to continue listing data.
", + "ListRulesPackagesResponse$nextToken": "When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to 'null'.
", + "ListRunsRequest$nextToken": "You can use this parameter when paginating results. Set the value of this parameter to 'null' on your first call to the ListRuns action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from previous response to continue listing data.
", + "ListRunsResponse$nextToken": "When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to 'null'.
", + "PreviewAgentsForResourceGroupRequest$nextToken": "You can use this parameter when paginating results. Set the value of this parameter to 'null' on your first call to the PreviewAgentsForResourceGroup action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from previous response to continue listing data.
", + "PreviewAgentsForResourceGroupResponse$nextToken": "When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to 'null'.
" + } + }, + "Parameter": { + "base": "This data type is used in the LocalizedText data type.
", + "refs": { + "ParameterList$member": null + } + }, + "ParameterList": { + "base": null, + "refs": { + "LocalizedText$parameters": "Values for the dynamic elements of the string specified by the textual identifier.
" + } + }, + "ParameterName": { + "base": null, + "refs": { + "Parameter$name": "The name of the variable that is being replaced.
" + } + }, + "ParameterValue": { + "base": null, + "refs": { + "Parameter$value": "The value assigned to the variable that is being replaced.
" + } + }, + "PreviewAgentsForResourceGroupRequest": { + "base": null, + "refs": { + } + }, + "PreviewAgentsForResourceGroupResponse": { + "base": null, + "refs": { + } + }, + "RegisterCrossAccountAccessRoleRequest": { + "base": null, + "refs": { + } + }, + "RegisterCrossAccountAccessRoleResponse": { + "base": null, + "refs": { + } + }, + "RemoveAttributesFromFindingsRequest": { + "base": null, + "refs": { + } + }, + "RemoveAttributesFromFindingsResponse": { + "base": null, + "refs": { + } + }, + "ResourceGroup": { + "base": "Contains information about a resource group. The resource group defines a set of tags that, when queried, identify the AWS resources that comprise the application.
This data type is used as the response element in the DescribeResourceGroup action.
", + "refs": { + "DescribeResourceGroupResponse$resourceGroup": "Information about the resource group.
" + } + }, + "ResourceGroupTags": { + "base": null, + "refs": { + "CreateResourceGroupRequest$resourceGroupTags": "A collection of keys and an array of possible values in JSON format.
For example, [{ \"key1\" : [\"Value1\",\"Value2\"]},{\"Key2\": [\"Value3\"]}]
", + "ResourceGroup$resourceGroupTags": "The tags (key and value pairs) of the resource group.
This data type property is used in the CreateResourceGroup action.
A collection of keys and an array of possible values in JSON format.
For example, [{ \"key1\" : [\"Value1\",\"Value2\"]},{\"Key2\": [\"Value3\"]}]
" + } + }, + "RulesPackage": { + "base": "Contains information about an Inspector rules package.
This data type is used as the response element in the DescribeRulesPackage action.
", + "refs": { + "DescribeRulesPackageResponse$rulesPackage": "Information about the rules package.
" + } + }, + "Run": { + "base": "A snapshot of an Inspector assessment that contains the assessment's findings.
This data type is used as the response element in the DescribeRun action.
", + "refs": { + "DescribeRunResponse$run": "Information about the assessment run.
" + } + }, + "RunAssessmentRequest": { + "base": null, + "refs": { + } + }, + "RunAssessmentResponse": { + "base": null, + "refs": { + } + }, + "RunState": { + "base": null, + "refs": { + "Run$runState": "The state of the run. Values can be set to DataCollectionComplete, EvaluatingPolicies, EvaluatingPoliciesErrorCanRetry, Completed, Failed, TombStoned.
", + "RunStateList$member": null + } + }, + "RunStateList": { + "base": null, + "refs": { + "RunsFilter$runStates": "For a record to match a filter, the value specified for this data type property must be the exact match of the value of the runState property of the Run data type.
" + } + }, + "RunsFilter": { + "base": "This data type is used as the request parameter in the ListRuns action.
", + "refs": { + "ListRunsRequest$filter": "You can use this parameter to specify a subset of data to be included in the action's response.
For a record to match a filter, all specified filter attributes must match. When multiple values are specified for a filter attribute, any of the values can match.
" + } + }, + "SetTagsForResourceRequest": { + "base": null, + "refs": { + } + }, + "SetTagsForResourceResponse": { + "base": null, + "refs": { + } + }, + "Severity": { + "base": null, + "refs": { + "Finding$severity": "The finding severity. Values can be set to High, Medium, Low, and Informational.
", + "SeverityList$member": null + } + }, + "SeverityList": { + "base": null, + "refs": { + "FindingsFilter$severities": "For a record to match a filter, the value specified for this data type property must be the exact match of the value of the severity property of the Finding data type.
" + } + }, + "StartDataCollectionRequest": { + "base": null, + "refs": { + } + }, + "StartDataCollectionResponse": { + "base": null, + "refs": { + } + }, + "StopDataCollectionRequest": { + "base": null, + "refs": { + } + }, + "StopDataCollectionResponse": { + "base": null, + "refs": { + } + }, + "Tag": { + "base": "A key and value pair.
This data type is used as a request parameter in the SetTagsForResource action and a response element in the ListTagsForResource action.
", + "refs": { + "TagList$member": null + } + }, + "TagKey": { + "base": null, + "refs": { + "Tag$Key": "The tag key.
" + } + }, + "TagList": { + "base": null, + "refs": { + "ListTagsForResourceResponse$tagList": "A collection of key and value pairs.
", + "SetTagsForResourceRequest$tags": "A collection of key and value pairs that you want to set to an assessment.
" + } + }, + "TagValue": { + "base": null, + "refs": { + "Tag$Value": "The value assigned to a tag key.
" + } + }, + "Telemetry": { + "base": "The metadata about the Inspector application data metrics collected by the agent.
This data type is used as the response element in the GetAssessmentTelemetry action.
", + "refs": { + "TelemetryList$member": null + } + }, + "TelemetryList": { + "base": null, + "refs": { + "Agent$telemetry": "The Inspector application data metrics collected by the agent.
", + "GetAssessmentTelemetryResponse$telemetry": "Telemetry details.
" + } + }, + "TelemetryStatus": { + "base": null, + "refs": { + "Telemetry$status": "The category of the individual metrics that together constitute the telemetry that Inspector received from the agent.
" + } + }, + "Text": { + "base": null, + "refs": { + "TextList$member": null + } + }, + "TextList": { + "base": null, + "refs": { + "LocalizeTextResponse$results": "The resulting list of user-readable texts.
" + } + }, + "Timestamp": { + "base": null, + "refs": { + "Assessment$startTime": "The assessment start time.
", + "Assessment$endTime": "The assessment end time.
", + "Run$creationTime": "Run creation time that corresponds to the data collection completion time or failure.
", + "Run$completionTime": "Run completion time that corresponds to the rules packages evaluation completion time or failure.
", + "TimestampRange$minimum": "The minimum value of the timestamp range.
", + "TimestampRange$maximum": "The maximum value of the timestamp range.
" + } + }, + "TimestampRange": { + "base": "This data type is used in the AssessmentsFilter and RunsFilter data types.
", + "refs": { + "AssessmentsFilter$startTimeRange": "For a record to match a filter, the value specified for this data type property must inclusively match any value between the specified minimum and maximum values of the startTime property of the Assessment data type.
", + "AssessmentsFilter$endTimeRange": "For a record to match a filter, the value specified for this data type property must inclusively match any value between the specified minimum and maximum values of the endTime property of the Assessment data type.
", + "RunsFilter$creationTime": "For a record to match a filter, the value specified for this data type property must inclusively match any value between the specified minimum and maximum values of the creationTime property of the Run data type.
", + "RunsFilter$completionTime": "For a record to match a filter, the value specified for this data type property must inclusively match any value between the specified minimum and maximum values of the completionTime property of the Run data type.
" + } + }, + "UpdateApplicationRequest": { + "base": null, + "refs": { + } + }, + "UpdateApplicationResponse": { + "base": null, + "refs": { + } + }, + "UpdateAssessmentRequest": { + "base": null, + "refs": { + } + }, + "UpdateAssessmentResponse": { + "base": null, + "refs": { + } + }, + "Version": { + "base": null, + "refs": { + "RulesPackage$version": "The version id of the rules package.
" + } + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/inspector/2015-08-18/examples-1.json b/vendor/github.com/aws/aws-sdk-go/models/apis/inspector/2015-08-18/examples-1.json new file mode 100644 index 000000000..0ea7e3b0b --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/inspector/2015-08-18/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/inspector/2016-02-16/api-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/inspector/2016-02-16/api-2.json new file mode 100644 index 000000000..43e7b62be --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/inspector/2016-02-16/api-2.json @@ -0,0 +1,1964 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2016-02-16", + "endpointPrefix":"inspector", + "jsonVersion":"1.1", + "protocol":"json", + "serviceFullName":"Amazon Inspector", + "signatureVersion":"v4", + "targetPrefix":"InspectorService" + }, + "operations":{ + "AddAttributesToFindings":{ + "name":"AddAttributesToFindings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddAttributesToFindingsRequest"}, + "output":{"shape":"AddAttributesToFindingsResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"} + ] + }, + "CreateAssessmentTarget":{ + "name":"CreateAssessmentTarget", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateAssessmentTargetRequest"}, + "output":{"shape":"CreateAssessmentTargetResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"} + ] + }, + "CreateAssessmentTemplate":{ + "name":"CreateAssessmentTemplate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateAssessmentTemplateRequest"}, + "output":{"shape":"CreateAssessmentTemplateResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"} + ] + }, + "CreateResourceGroup":{ + "name":"CreateResourceGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateResourceGroupRequest"}, + "output":{"shape":"CreateResourceGroupResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"} + ] + }, + "DeleteAssessmentRun":{ + "name":"DeleteAssessmentRun", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteAssessmentRunRequest"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AssessmentRunInProgressException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"} + ] + }, + "DeleteAssessmentTarget":{ + "name":"DeleteAssessmentTarget", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteAssessmentTargetRequest"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AssessmentRunInProgressException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"} + ] + }, + "DeleteAssessmentTemplate":{ + "name":"DeleteAssessmentTemplate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteAssessmentTemplateRequest"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AssessmentRunInProgressException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"} + ] + }, + "DescribeAssessmentRuns":{ + "name":"DescribeAssessmentRuns", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAssessmentRunsRequest"}, + "output":{"shape":"DescribeAssessmentRunsResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"} + ] + }, + "DescribeAssessmentTargets":{ + "name":"DescribeAssessmentTargets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAssessmentTargetsRequest"}, + "output":{"shape":"DescribeAssessmentTargetsResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"} + ] + }, + "DescribeAssessmentTemplates":{ + "name":"DescribeAssessmentTemplates", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAssessmentTemplatesRequest"}, + "output":{"shape":"DescribeAssessmentTemplatesResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"} + ] + }, + "DescribeCrossAccountAccessRole":{ + "name":"DescribeCrossAccountAccessRole", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "output":{"shape":"DescribeCrossAccountAccessRoleResponse"}, + "errors":[ + {"shape":"InternalException"} + ] + }, + "DescribeFindings":{ + "name":"DescribeFindings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeFindingsRequest"}, + "output":{"shape":"DescribeFindingsResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"} + ] + }, + "DescribeResourceGroups":{ + "name":"DescribeResourceGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeResourceGroupsRequest"}, + "output":{"shape":"DescribeResourceGroupsResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"} + ] + }, + "DescribeRulesPackages":{ + "name":"DescribeRulesPackages", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeRulesPackagesRequest"}, + "output":{"shape":"DescribeRulesPackagesResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"} + ] + }, + "GetTelemetryMetadata":{ + "name":"GetTelemetryMetadata", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetTelemetryMetadataRequest"}, + "output":{"shape":"GetTelemetryMetadataResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"} + ] + }, + "ListAssessmentRunAgents":{ + "name":"ListAssessmentRunAgents", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAssessmentRunAgentsRequest"}, + "output":{"shape":"ListAssessmentRunAgentsResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"} + ] + }, + "ListAssessmentRuns":{ + "name":"ListAssessmentRuns", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAssessmentRunsRequest"}, + "output":{"shape":"ListAssessmentRunsResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"} + ] + }, + "ListAssessmentTargets":{ + "name":"ListAssessmentTargets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAssessmentTargetsRequest"}, + "output":{"shape":"ListAssessmentTargetsResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"} + ] + }, + "ListAssessmentTemplates":{ + "name":"ListAssessmentTemplates", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAssessmentTemplatesRequest"}, + "output":{"shape":"ListAssessmentTemplatesResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"} + ] + }, + "ListEventSubscriptions":{ + "name":"ListEventSubscriptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListEventSubscriptionsRequest"}, + "output":{"shape":"ListEventSubscriptionsResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"} + ] + }, + "ListFindings":{ + "name":"ListFindings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListFindingsRequest"}, + "output":{"shape":"ListFindingsResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"} + ] + }, + "ListRulesPackages":{ + "name":"ListRulesPackages", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListRulesPackagesRequest"}, + "output":{"shape":"ListRulesPackagesResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"} + ] + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"} + ] + }, + "PreviewAgents":{ + "name":"PreviewAgents", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PreviewAgentsRequest"}, + "output":{"shape":"PreviewAgentsResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"}, + {"shape":"InvalidCrossAccountRoleException"} + ] + }, + "RegisterCrossAccountAccessRole":{ + "name":"RegisterCrossAccountAccessRole", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RegisterCrossAccountAccessRoleRequest"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InvalidCrossAccountRoleException"} + ] + }, + "RemoveAttributesFromFindings":{ + "name":"RemoveAttributesFromFindings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RemoveAttributesFromFindingsRequest"}, + "output":{"shape":"RemoveAttributesFromFindingsResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"} + ] + }, + "SetTagsForResource":{ + "name":"SetTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SetTagsForResourceRequest"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"} + ] + }, + "StartAssessmentRun":{ + "name":"StartAssessmentRun", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartAssessmentRunRequest"}, + "output":{"shape":"StartAssessmentRunResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"}, + {"shape":"InvalidCrossAccountRoleException"}, + {"shape":"AgentsAlreadyRunningAssessmentException"} + ] + }, + "StopAssessmentRun":{ + "name":"StopAssessmentRun", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopAssessmentRunRequest"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"} + ] + }, + "SubscribeToEvent":{ + "name":"SubscribeToEvent", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SubscribeToEventRequest"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"} + ] + }, + "UnsubscribeFromEvent":{ + "name":"UnsubscribeFromEvent", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UnsubscribeFromEventRequest"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"} + ] + }, + "UpdateAssessmentTarget":{ + "name":"UpdateAssessmentTarget", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateAssessmentTargetRequest"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"} + ] + } + }, + "shapes":{ + "AccessDeniedErrorCode":{ + "type":"string", + "enum":[ + "ACCESS_DENIED_TO_ASSESSMENT_TARGET", + "ACCESS_DENIED_TO_ASSESSMENT_TEMPLATE", + "ACCESS_DENIED_TO_ASSESSMENT_RUN", + "ACCESS_DENIED_TO_FINDING", + "ACCESS_DENIED_TO_RESOURCE_GROUP", + "ACCESS_DENIED_TO_RULES_PACKAGE", + "ACCESS_DENIED_TO_SNS_TOPIC", + "ACCESS_DENIED_TO_IAM_ROLE" + ] + }, + "AccessDeniedException":{ + "type":"structure", + "required":[ + "message", + "errorCode", + "canRetry" + ], + "members":{ + "message":{"shape":"ErrorMessage"}, + "errorCode":{"shape":"AccessDeniedErrorCode"}, + "canRetry":{"shape":"Bool"} + }, + "exception":true + }, + "AddAttributesToFindingsRequest":{ + "type":"structure", + "required":[ + "findingArns", + "attributes" + ], + "members":{ + "findingArns":{"shape":"AddRemoveAttributesFindingArnList"}, + "attributes":{"shape":"UserAttributeList"} + } + }, + "AddAttributesToFindingsResponse":{ + "type":"structure", + "required":["failedItems"], + "members":{ + "failedItems":{"shape":"FailedItems"} + } + }, + "AddRemoveAttributesFindingArnList":{ + "type":"list", + "member":{"shape":"Arn"}, + "max":10, + "min":1 + }, + "AgentAlreadyRunningAssessment":{ + "type":"structure", + "required":[ + "agentId", + "assessmentRunArn" + ], + "members":{ + "agentId":{"shape":"AgentId"}, + "assessmentRunArn":{"shape":"Arn"} + } + }, + "AgentAlreadyRunningAssessmentList":{ + "type":"list", + "member":{"shape":"AgentAlreadyRunningAssessment"}, + "max":10, + "min":1 + }, + "AgentFilter":{ + "type":"structure", + "required":[ + "agentHealths", + "agentHealthCodes" + ], + "members":{ + "agentHealths":{"shape":"AgentHealthList"}, + "agentHealthCodes":{"shape":"AgentHealthCodeList"} + } + }, + "AgentHealth":{ + "type":"string", + "enum":[ + "HEALTHY", + "UNHEALTHY" + ] + }, + "AgentHealthCode":{ + "type":"string", + "enum":[ + "IDLE", + "RUNNING", + "SHUTDOWN", + "UNHEALTHY", + "THROTTLED", + "UNKNOWN" + ] + }, + "AgentHealthCodeList":{ + "type":"list", + "member":{"shape":"AgentHealthCode"}, + "max":10, + "min":0 + }, + "AgentHealthList":{ + "type":"list", + "member":{"shape":"AgentHealth"}, + "max":10, + "min":0 + }, + "AgentId":{ + "type":"string", + "max":128, + "min":1 + }, + "AgentIdList":{ + "type":"list", + "member":{"shape":"AgentId"}, + "max":500, + "min":0 + }, + "AgentPreview":{ + "type":"structure", + "required":["agentId"], + "members":{ + "agentId":{"shape":"AgentId"}, + "autoScalingGroup":{"shape":"AutoScalingGroup"} + } + }, + "AgentPreviewList":{ + "type":"list", + "member":{"shape":"AgentPreview"}, + "max":100, + "min":0 + }, + "AgentsAlreadyRunningAssessmentException":{ + "type":"structure", + "required":[ + "message", + "agents", + "agentsTruncated", + "canRetry" + ], + "members":{ + "message":{"shape":"ErrorMessage"}, + "agents":{"shape":"AgentAlreadyRunningAssessmentList"}, + "agentsTruncated":{"shape":"Bool"}, + "canRetry":{"shape":"Bool"} + }, + "exception":true + }, + "AmiId":{ + "type":"string", + "max":256, + "min":0 + }, + "Arn":{ + "type":"string", + "max":300, + "min":1 + }, + "AssessmentRulesPackageArnList":{ + "type":"list", + "member":{"shape":"Arn"}, + "max":50, + "min":1 + }, + "AssessmentRun":{ + "type":"structure", + "required":[ + "arn", + "name", + "assessmentTemplateArn", + "state", + "durationInSeconds", + "rulesPackageArns", + "userAttributesForFindings", + "createdAt", + "stateChangedAt", + "dataCollected", + "stateChanges", + "notifications" + ], + "members":{ + "arn":{"shape":"Arn"}, + "name":{"shape":"AssessmentRunName"}, + "assessmentTemplateArn":{"shape":"Arn"}, + "state":{"shape":"AssessmentRunState"}, + "durationInSeconds":{"shape":"AssessmentRunDuration"}, + "rulesPackageArns":{"shape":"AssessmentRulesPackageArnList"}, + "userAttributesForFindings":{"shape":"UserAttributeList"}, + "createdAt":{"shape":"Timestamp"}, + "startedAt":{"shape":"Timestamp"}, + "completedAt":{"shape":"Timestamp"}, + "stateChangedAt":{"shape":"Timestamp"}, + "dataCollected":{"shape":"Bool"}, + "stateChanges":{"shape":"AssessmentRunStateChangeList"}, + "notifications":{"shape":"AssessmentRunNotificationList"} + } + }, + "AssessmentRunAgent":{ + "type":"structure", + "required":[ + "agentId", + "assessmentRunArn", + "agentHealth", + "agentHealthCode", + "telemetryMetadata" + ], + "members":{ + "agentId":{"shape":"AgentId"}, + "assessmentRunArn":{"shape":"Arn"}, + "agentHealth":{"shape":"AgentHealth"}, + "agentHealthCode":{"shape":"AgentHealthCode"}, + "agentHealthDetails":{"shape":"Message"}, + "autoScalingGroup":{"shape":"AutoScalingGroup"}, + "telemetryMetadata":{"shape":"TelemetryMetadataList"} + } + }, + "AssessmentRunAgentList":{ + "type":"list", + "member":{"shape":"AssessmentRunAgent"}, + "max":500, + "min":0 + }, + "AssessmentRunDuration":{ + "type":"integer", + "max":86400, + "min":180 + }, + "AssessmentRunFilter":{ + "type":"structure", + "members":{ + "namePattern":{"shape":"NamePattern"}, + "states":{"shape":"AssessmentRunStateList"}, + "durationRange":{"shape":"DurationRange"}, + "rulesPackageArns":{"shape":"FilterRulesPackageArnList"}, + "startTimeRange":{"shape":"TimestampRange"}, + "completionTimeRange":{"shape":"TimestampRange"}, + "stateChangeTimeRange":{"shape":"TimestampRange"} + } + }, + "AssessmentRunInProgressArnList":{ + "type":"list", + "member":{"shape":"Arn"}, + "max":10, + "min":1 + }, + "AssessmentRunInProgressException":{ + "type":"structure", + "required":[ + "message", + "assessmentRunArns", + "assessmentRunArnsTruncated", + "canRetry" + ], + "members":{ + "message":{"shape":"ErrorMessage"}, + "assessmentRunArns":{"shape":"AssessmentRunInProgressArnList"}, + "assessmentRunArnsTruncated":{"shape":"Bool"}, + "canRetry":{"shape":"Bool"} + }, + "exception":true + }, + "AssessmentRunList":{ + "type":"list", + "member":{"shape":"AssessmentRun"}, + "max":10, + "min":0 + }, + "AssessmentRunName":{ + "type":"string", + "max":140, + "min":1 + }, + "AssessmentRunNotification":{ + "type":"structure", + "required":[ + "date", + "event", + "error" + ], + "members":{ + "date":{"shape":"Timestamp"}, + "event":{"shape":"InspectorEvent"}, + "message":{"shape":"Message"}, + "error":{"shape":"Bool"}, + "snsTopicArn":{"shape":"Arn"}, + "snsPublishStatusCode":{"shape":"AssessmentRunNotificationSnsStatusCode"} + } + }, + "AssessmentRunNotificationList":{ + "type":"list", + "member":{"shape":"AssessmentRunNotification"}, + "max":50, + "min":0 + }, + "AssessmentRunNotificationSnsStatusCode":{ + "type":"string", + "enum":[ + "SUCCESS", + "TOPIC_DOES_NOT_EXIST", + "ACCESS_DENIED", + "INTERNAL_ERROR" + ] + }, + "AssessmentRunState":{ + "type":"string", + "enum":[ + "CREATED", + "START_DATA_COLLECTION_PENDING", + "START_DATA_COLLECTION_IN_PROGRESS", + "COLLECTING_DATA", + "STOP_DATA_COLLECTION_PENDING", + "DATA_COLLECTED", + "EVALUATING_RULES", + "FAILED", + "COMPLETED", + "COMPLETED_WITH_ERRORS" + ] + }, + "AssessmentRunStateChange":{ + "type":"structure", + "required":[ + "stateChangedAt", + "state" + ], + "members":{ + "stateChangedAt":{"shape":"Timestamp"}, + "state":{"shape":"AssessmentRunState"} + } + }, + "AssessmentRunStateChangeList":{ + "type":"list", + "member":{"shape":"AssessmentRunStateChange"}, + "max":50, + "min":0 + }, + "AssessmentRunStateList":{ + "type":"list", + "member":{"shape":"AssessmentRunState"}, + "max":50, + "min":0 + }, + "AssessmentTarget":{ + "type":"structure", + "required":[ + "arn", + "name", + "resourceGroupArn", + "createdAt", + "updatedAt" + ], + "members":{ + "arn":{"shape":"Arn"}, + "name":{"shape":"AssessmentTargetName"}, + "resourceGroupArn":{"shape":"Arn"}, + "createdAt":{"shape":"Timestamp"}, + "updatedAt":{"shape":"Timestamp"} + } + }, + "AssessmentTargetFilter":{ + "type":"structure", + "members":{ + "assessmentTargetNamePattern":{"shape":"NamePattern"} + } + }, + "AssessmentTargetList":{ + "type":"list", + "member":{"shape":"AssessmentTarget"}, + "max":10, + "min":0 + }, + "AssessmentTargetName":{ + "type":"string", + "max":140, + "min":1 + }, + "AssessmentTemplate":{ + "type":"structure", + "required":[ + "arn", + "name", + "assessmentTargetArn", + "durationInSeconds", + "rulesPackageArns", + "userAttributesForFindings", + "createdAt" + ], + "members":{ + "arn":{"shape":"Arn"}, + "name":{"shape":"AssessmentTemplateName"}, + "assessmentTargetArn":{"shape":"Arn"}, + "durationInSeconds":{"shape":"AssessmentRunDuration"}, + "rulesPackageArns":{"shape":"AssessmentTemplateRulesPackageArnList"}, + "userAttributesForFindings":{"shape":"UserAttributeList"}, + "createdAt":{"shape":"Timestamp"} + } + }, + "AssessmentTemplateFilter":{ + "type":"structure", + "members":{ + "namePattern":{"shape":"NamePattern"}, + "durationRange":{"shape":"DurationRange"}, + "rulesPackageArns":{"shape":"FilterRulesPackageArnList"} + } + }, + "AssessmentTemplateList":{ + "type":"list", + "member":{"shape":"AssessmentTemplate"}, + "max":10, + "min":0 + }, + "AssessmentTemplateName":{ + "type":"string", + "max":140, + "min":1 + }, + "AssessmentTemplateRulesPackageArnList":{ + "type":"list", + "member":{"shape":"Arn"}, + "max":50, + "min":0 + }, + "AssetAttributes":{ + "type":"structure", + "required":["schemaVersion"], + "members":{ + "schemaVersion":{"shape":"NumericVersion"}, + "agentId":{"shape":"AgentId"}, + "autoScalingGroup":{"shape":"AutoScalingGroup"}, + "amiId":{"shape":"AmiId"}, + "hostname":{"shape":"Hostname"}, + "ipv4Addresses":{"shape":"Ipv4AddressList"} + } + }, + "AssetType":{ + "type":"string", + "enum":["ec2-instance"] + }, + "Attribute":{ + "type":"structure", + "required":["key"], + "members":{ + "key":{"shape":"AttributeKey"}, + "value":{"shape":"AttributeValue"} + } + }, + "AttributeKey":{ + "type":"string", + "max":128, + "min":1 + }, + "AttributeList":{ + "type":"list", + "member":{"shape":"Attribute"}, + "max":50, + "min":0 + }, + "AttributeValue":{ + "type":"string", + "max":256, + "min":1 + }, + "AutoScalingGroup":{ + "type":"string", + "max":256, + "min":1 + }, + "AutoScalingGroupList":{ + "type":"list", + "member":{"shape":"AutoScalingGroup"}, + "max":20, + "min":0 + }, + "BatchDescribeArnList":{ + "type":"list", + "member":{"shape":"Arn"}, + "max":10, + "min":1 + }, + "Bool":{"type":"boolean"}, + "CreateAssessmentTargetRequest":{ + "type":"structure", + "required":[ + "assessmentTargetName", + "resourceGroupArn" + ], + "members":{ + "assessmentTargetName":{"shape":"AssessmentTargetName"}, + "resourceGroupArn":{"shape":"Arn"} + } + }, + "CreateAssessmentTargetResponse":{ + "type":"structure", + "required":["assessmentTargetArn"], + "members":{ + "assessmentTargetArn":{"shape":"Arn"} + } + }, + "CreateAssessmentTemplateRequest":{ + "type":"structure", + "required":[ + "assessmentTargetArn", + "assessmentTemplateName", + "durationInSeconds", + "rulesPackageArns" + ], + "members":{ + "assessmentTargetArn":{"shape":"Arn"}, + "assessmentTemplateName":{"shape":"AssessmentTemplateName"}, + "durationInSeconds":{"shape":"AssessmentRunDuration"}, + "rulesPackageArns":{"shape":"AssessmentTemplateRulesPackageArnList"}, + "userAttributesForFindings":{"shape":"UserAttributeList"} + } + }, + "CreateAssessmentTemplateResponse":{ + "type":"structure", + "required":["assessmentTemplateArn"], + "members":{ + "assessmentTemplateArn":{"shape":"Arn"} + } + }, + "CreateResourceGroupRequest":{ + "type":"structure", + "required":["resourceGroupTags"], + "members":{ + "resourceGroupTags":{"shape":"ResourceGroupTags"} + } + }, + "CreateResourceGroupResponse":{ + "type":"structure", + "required":["resourceGroupArn"], + "members":{ + "resourceGroupArn":{"shape":"Arn"} + } + }, + "DeleteAssessmentRunRequest":{ + "type":"structure", + "required":["assessmentRunArn"], + "members":{ + "assessmentRunArn":{"shape":"Arn"} + } + }, + "DeleteAssessmentTargetRequest":{ + "type":"structure", + "required":["assessmentTargetArn"], + "members":{ + "assessmentTargetArn":{"shape":"Arn"} + } + }, + "DeleteAssessmentTemplateRequest":{ + "type":"structure", + "required":["assessmentTemplateArn"], + "members":{ + "assessmentTemplateArn":{"shape":"Arn"} + } + }, + "DescribeAssessmentRunsRequest":{ + "type":"structure", + "required":["assessmentRunArns"], + "members":{ + "assessmentRunArns":{"shape":"BatchDescribeArnList"} + } + }, + "DescribeAssessmentRunsResponse":{ + "type":"structure", + "required":[ + "assessmentRuns", + "failedItems" + ], + "members":{ + "assessmentRuns":{"shape":"AssessmentRunList"}, + "failedItems":{"shape":"FailedItems"} + } + }, + "DescribeAssessmentTargetsRequest":{ + "type":"structure", + "required":["assessmentTargetArns"], + "members":{ + "assessmentTargetArns":{"shape":"BatchDescribeArnList"} + } + }, + "DescribeAssessmentTargetsResponse":{ + "type":"structure", + "required":[ + "assessmentTargets", + "failedItems" + ], + "members":{ + "assessmentTargets":{"shape":"AssessmentTargetList"}, + "failedItems":{"shape":"FailedItems"} + } + }, + "DescribeAssessmentTemplatesRequest":{ + "type":"structure", + "required":["assessmentTemplateArns"], + "members":{ + "assessmentTemplateArns":{"shape":"BatchDescribeArnList"} + } + }, + "DescribeAssessmentTemplatesResponse":{ + "type":"structure", + "required":[ + "assessmentTemplates", + "failedItems" + ], + "members":{ + "assessmentTemplates":{"shape":"AssessmentTemplateList"}, + "failedItems":{"shape":"FailedItems"} + } + }, + "DescribeCrossAccountAccessRoleResponse":{ + "type":"structure", + "required":[ + "roleArn", + "valid", + "registeredAt" + ], + "members":{ + "roleArn":{"shape":"Arn"}, + "valid":{"shape":"Bool"}, + "registeredAt":{"shape":"Timestamp"} + } + }, + "DescribeFindingsRequest":{ + "type":"structure", + "required":["findingArns"], + "members":{ + "findingArns":{"shape":"BatchDescribeArnList"}, + "locale":{"shape":"Locale"} + } + }, + "DescribeFindingsResponse":{ + "type":"structure", + "required":[ + "findings", + "failedItems" + ], + "members":{ + "findings":{"shape":"FindingList"}, + "failedItems":{"shape":"FailedItems"} + } + }, + "DescribeResourceGroupsRequest":{ + "type":"structure", + "required":["resourceGroupArns"], + "members":{ + "resourceGroupArns":{"shape":"BatchDescribeArnList"} + } + }, + "DescribeResourceGroupsResponse":{ + "type":"structure", + "required":[ + "resourceGroups", + "failedItems" + ], + "members":{ + "resourceGroups":{"shape":"ResourceGroupList"}, + "failedItems":{"shape":"FailedItems"} + } + }, + "DescribeRulesPackagesRequest":{ + "type":"structure", + "required":["rulesPackageArns"], + "members":{ + "rulesPackageArns":{"shape":"BatchDescribeArnList"}, + "locale":{"shape":"Locale"} + } + }, + "DescribeRulesPackagesResponse":{ + "type":"structure", + "required":[ + "rulesPackages", + "failedItems" + ], + "members":{ + "rulesPackages":{"shape":"RulesPackageList"}, + "failedItems":{"shape":"FailedItems"} + } + }, + "DurationRange":{ + "type":"structure", + "members":{ + "minSeconds":{"shape":"AssessmentRunDuration"}, + "maxSeconds":{"shape":"AssessmentRunDuration"} + } + }, + "ErrorMessage":{ + "type":"string", + "max":1000, + "min":0 + }, + "EventSubscription":{ + "type":"structure", + "required":[ + "event", + "subscribedAt" + ], + "members":{ + "event":{"shape":"InspectorEvent"}, + "subscribedAt":{"shape":"Timestamp"} + } + }, + "EventSubscriptionList":{ + "type":"list", + "member":{"shape":"EventSubscription"}, + "max":50, + "min":1 + }, + "FailedItemDetails":{ + "type":"structure", + "required":[ + "failureCode", + "retryable" + ], + "members":{ + "failureCode":{"shape":"FailedItemErrorCode"}, + "retryable":{"shape":"Bool"} + } + }, + "FailedItemErrorCode":{ + "type":"string", + "enum":[ + "INVALID_ARN", + "DUPLICATE_ARN", + "ITEM_DOES_NOT_EXIST", + "ACCESS_DENIED", + "LIMIT_EXCEEDED", + "INTERNAL_ERROR" + ] + }, + "FailedItems":{ + "type":"map", + "key":{"shape":"Arn"}, + "value":{"shape":"FailedItemDetails"} + }, + "FilterRulesPackageArnList":{ + "type":"list", + "member":{"shape":"Arn"}, + "max":50, + "min":0 + }, + "Finding":{ + "type":"structure", + "required":[ + "arn", + "attributes", + "userAttributes", + "createdAt", + "updatedAt" + ], + "members":{ + "arn":{"shape":"Arn"}, + "schemaVersion":{"shape":"NumericVersion"}, + "service":{"shape":"ServiceName"}, + "serviceAttributes":{"shape":"InspectorServiceAttributes"}, + "assetType":{"shape":"AssetType"}, + "assetAttributes":{"shape":"AssetAttributes"}, + "id":{"shape":"FindingId"}, + "title":{"shape":"Text"}, + "description":{"shape":"Text"}, + "recommendation":{"shape":"Text"}, + "severity":{"shape":"Severity"}, + "numericSeverity":{"shape":"NumericSeverity"}, + "confidence":{"shape":"IocConfidence"}, + "indicatorOfCompromise":{"shape":"Bool"}, + "attributes":{"shape":"AttributeList"}, + "userAttributes":{"shape":"UserAttributeList"}, + "createdAt":{"shape":"Timestamp"}, + "updatedAt":{"shape":"Timestamp"} + } + }, + "FindingFilter":{ + "type":"structure", + "members":{ + "agentIds":{"shape":"AgentIdList"}, + "autoScalingGroups":{"shape":"AutoScalingGroupList"}, + "ruleNames":{"shape":"RuleNameList"}, + "severities":{"shape":"SeverityList"}, + "rulesPackageArns":{"shape":"FilterRulesPackageArnList"}, + "attributes":{"shape":"AttributeList"}, + "userAttributes":{"shape":"AttributeList"}, + "creationTimeRange":{"shape":"TimestampRange"} + } + }, + "FindingId":{ + "type":"string", + "max":128, + "min":0 + }, + "FindingList":{ + "type":"list", + "member":{"shape":"Finding"}, + "max":10, + "min":0 + }, + "GetTelemetryMetadataRequest":{ + "type":"structure", + "required":["assessmentRunArn"], + "members":{ + "assessmentRunArn":{"shape":"Arn"} + } + }, + "GetTelemetryMetadataResponse":{ + "type":"structure", + "required":["telemetryMetadata"], + "members":{ + "telemetryMetadata":{"shape":"TelemetryMetadataList"} + } + }, + "Hostname":{ + "type":"string", + "max":256, + "min":0 + }, + "InspectorEvent":{ + "type":"string", + "enum":[ + "ASSESSMENT_RUN_STARTED", + "ASSESSMENT_RUN_COMPLETED", + "ASSESSMENT_RUN_STATE_CHANGED", + "FINDING_REPORTED", + "OTHER" + ] + }, + "InspectorServiceAttributes":{ + "type":"structure", + "required":["schemaVersion"], + "members":{ + "schemaVersion":{"shape":"NumericVersion"}, + "assessmentRunArn":{"shape":"Arn"}, + "rulesPackageArn":{"shape":"Arn"} + } + }, + "InternalException":{ + "type":"structure", + "required":[ + "message", + "canRetry" + ], + "members":{ + "message":{"shape":"ErrorMessage"}, + "canRetry":{"shape":"Bool"} + }, + "exception":true, + "fault":true + }, + "InvalidCrossAccountRoleErrorCode":{ + "type":"string", + "enum":[ + "ROLE_DOES_NOT_EXIST_OR_INVALID_TRUST_RELATIONSHIP", + "ROLE_DOES_NOT_HAVE_CORRECT_POLICY" + ] + }, + "InvalidCrossAccountRoleException":{ + "type":"structure", + "required":[ + "message", + "errorCode", + "canRetry" + ], + "members":{ + "message":{"shape":"ErrorMessage"}, + "errorCode":{"shape":"InvalidCrossAccountRoleErrorCode"}, + "canRetry":{"shape":"Bool"} + }, + "exception":true + }, + "InvalidInputErrorCode":{ + "type":"string", + "enum":[ + "INVALID_ASSESSMENT_TARGET_ARN", + "INVALID_ASSESSMENT_TEMPLATE_ARN", + "INVALID_ASSESSMENT_RUN_ARN", + "INVALID_FINDING_ARN", + "INVALID_RESOURCE_GROUP_ARN", + "INVALID_RULES_PACKAGE_ARN", + "INVALID_RESOURCE_ARN", + "INVALID_SNS_TOPIC_ARN", + "INVALID_IAM_ROLE_ARN", + "INVALID_ASSESSMENT_TARGET_NAME", + "INVALID_ASSESSMENT_TARGET_NAME_PATTERN", + "INVALID_ASSESSMENT_TEMPLATE_NAME", + "INVALID_ASSESSMENT_TEMPLATE_NAME_PATTERN", + "INVALID_ASSESSMENT_TEMPLATE_DURATION", + "INVALID_ASSESSMENT_TEMPLATE_DURATION_RANGE", + "INVALID_ASSESSMENT_RUN_DURATION_RANGE", + "INVALID_ASSESSMENT_RUN_START_TIME_RANGE", + "INVALID_ASSESSMENT_RUN_COMPLETION_TIME_RANGE", + "INVALID_ASSESSMENT_RUN_STATE_CHANGE_TIME_RANGE", + "INVALID_ASSESSMENT_RUN_STATE", + "INVALID_TAG", + "INVALID_TAG_KEY", + "INVALID_TAG_VALUE", + "INVALID_RESOURCE_GROUP_TAG_KEY", + "INVALID_RESOURCE_GROUP_TAG_VALUE", + "INVALID_ATTRIBUTE", + "INVALID_USER_ATTRIBUTE", + "INVALID_USER_ATTRIBUTE_KEY", + "INVALID_USER_ATTRIBUTE_VALUE", + "INVALID_PAGINATION_TOKEN", + "INVALID_MAX_RESULTS", + "INVALID_AGENT_ID", + "INVALID_AUTO_SCALING_GROUP", + "INVALID_RULE_NAME", + "INVALID_SEVERITY", + "INVALID_LOCALE", + "INVALID_EVENT", + "ASSESSMENT_TARGET_NAME_ALREADY_TAKEN", + "ASSESSMENT_TEMPLATE_NAME_ALREADY_TAKEN", + "INVALID_NUMBER_OF_ASSESSMENT_TARGET_ARNS", + "INVALID_NUMBER_OF_ASSESSMENT_TEMPLATE_ARNS", + "INVALID_NUMBER_OF_ASSESSMENT_RUN_ARNS", + "INVALID_NUMBER_OF_FINDING_ARNS", + "INVALID_NUMBER_OF_RESOURCE_GROUP_ARNS", + "INVALID_NUMBER_OF_RULES_PACKAGE_ARNS", + "INVALID_NUMBER_OF_ASSESSMENT_RUN_STATES", + "INVALID_NUMBER_OF_TAGS", + "INVALID_NUMBER_OF_RESOURCE_GROUP_TAGS", + "INVALID_NUMBER_OF_ATTRIBUTES", + "INVALID_NUMBER_OF_USER_ATTRIBUTES", + "INVALID_NUMBER_OF_AGENT_IDS", + "INVALID_NUMBER_OF_AUTO_SCALING_GROUPS", + "INVALID_NUMBER_OF_RULE_NAMES", + "INVALID_NUMBER_OF_SEVERITIES" + ] + }, + "InvalidInputException":{ + "type":"structure", + "required":[ + "message", + "errorCode", + "canRetry" + ], + "members":{ + "message":{"shape":"ErrorMessage"}, + "errorCode":{"shape":"InvalidInputErrorCode"}, + "canRetry":{"shape":"Bool"} + }, + "exception":true + }, + "IocConfidence":{ + "type":"integer", + "max":10, + "min":0 + }, + "Ipv4Address":{ + "type":"string", + "max":15, + "min":7 + }, + "Ipv4AddressList":{ + "type":"list", + "member":{"shape":"Ipv4Address"}, + "max":50, + "min":0 + }, + "LimitExceededErrorCode":{ + "type":"string", + "enum":[ + "ASSESSMENT_TARGET_LIMIT_EXCEEDED", + "ASSESSMENT_TEMPLATE_LIMIT_EXCEEDED", + "ASSESSMENT_RUN_LIMIT_EXCEEDED", + "RESOURCE_GROUP_LIMIT_EXCEEDED", + "EVENT_SUBSCRIPTION_LIMIT_EXCEEDED" + ] + }, + "LimitExceededException":{ + "type":"structure", + "required":[ + "message", + "errorCode", + "canRetry" + ], + "members":{ + "message":{"shape":"ErrorMessage"}, + "errorCode":{"shape":"LimitExceededErrorCode"}, + "canRetry":{"shape":"Bool"} + }, + "exception":true + }, + "ListAssessmentRunAgentsRequest":{ + "type":"structure", + "required":["assessmentRunArn"], + "members":{ + "assessmentRunArn":{"shape":"Arn"}, + "filter":{"shape":"AgentFilter"}, + "nextToken":{"shape":"PaginationToken"}, + "maxResults":{"shape":"ListMaxResults"} + } + }, + "ListAssessmentRunAgentsResponse":{ + "type":"structure", + "required":["assessmentRunAgents"], + "members":{ + "assessmentRunAgents":{"shape":"AssessmentRunAgentList"}, + "nextToken":{"shape":"PaginationToken"} + } + }, + "ListAssessmentRunsRequest":{ + "type":"structure", + "members":{ + "assessmentTemplateArns":{"shape":"ListParentArnList"}, + "filter":{"shape":"AssessmentRunFilter"}, + "nextToken":{"shape":"PaginationToken"}, + "maxResults":{"shape":"ListMaxResults"} + } + }, + "ListAssessmentRunsResponse":{ + "type":"structure", + "required":["assessmentRunArns"], + "members":{ + "assessmentRunArns":{"shape":"ListReturnedArnList"}, + "nextToken":{"shape":"PaginationToken"} + } + }, + "ListAssessmentTargetsRequest":{ + "type":"structure", + "members":{ + "filter":{"shape":"AssessmentTargetFilter"}, + "nextToken":{"shape":"PaginationToken"}, + "maxResults":{"shape":"ListMaxResults"} + } + }, + "ListAssessmentTargetsResponse":{ + "type":"structure", + "required":["assessmentTargetArns"], + "members":{ + "assessmentTargetArns":{"shape":"ListReturnedArnList"}, + "nextToken":{"shape":"PaginationToken"} + } + }, + "ListAssessmentTemplatesRequest":{ + "type":"structure", + "members":{ + "assessmentTargetArns":{"shape":"ListParentArnList"}, + "filter":{"shape":"AssessmentTemplateFilter"}, + "nextToken":{"shape":"PaginationToken"}, + "maxResults":{"shape":"ListMaxResults"} + } + }, + "ListAssessmentTemplatesResponse":{ + "type":"structure", + "required":["assessmentTemplateArns"], + "members":{ + "assessmentTemplateArns":{"shape":"ListReturnedArnList"}, + "nextToken":{"shape":"PaginationToken"} + } + }, + "ListEventSubscriptionsMaxResults":{"type":"integer"}, + "ListEventSubscriptionsRequest":{ + "type":"structure", + "members":{ + "resourceArn":{"shape":"Arn"}, + "nextToken":{"shape":"PaginationToken"}, + "maxResults":{"shape":"ListEventSubscriptionsMaxResults"} + } + }, + "ListEventSubscriptionsResponse":{ + "type":"structure", + "required":["subscriptions"], + "members":{ + "subscriptions":{"shape":"SubscriptionList"}, + "nextToken":{"shape":"PaginationToken"} + } + }, + "ListFindingsRequest":{ + "type":"structure", + "members":{ + "assessmentRunArns":{"shape":"ListParentArnList"}, + "filter":{"shape":"FindingFilter"}, + "nextToken":{"shape":"PaginationToken"}, + "maxResults":{"shape":"ListMaxResults"} + } + }, + "ListFindingsResponse":{ + "type":"structure", + "required":["findingArns"], + "members":{ + "findingArns":{"shape":"ListReturnedArnList"}, + "nextToken":{"shape":"PaginationToken"} + } + }, + "ListMaxResults":{"type":"integer"}, + "ListParentArnList":{ + "type":"list", + "member":{"shape":"Arn"}, + "max":50, + "min":0 + }, + "ListReturnedArnList":{ + "type":"list", + "member":{"shape":"Arn"}, + "max":100, + "min":0 + }, + "ListRulesPackagesRequest":{ + "type":"structure", + "members":{ + "nextToken":{"shape":"PaginationToken"}, + "maxResults":{"shape":"ListMaxResults"} + } + }, + "ListRulesPackagesResponse":{ + "type":"structure", + "required":["rulesPackageArns"], + "members":{ + "rulesPackageArns":{"shape":"ListReturnedArnList"}, + "nextToken":{"shape":"PaginationToken"} + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["resourceArn"], + "members":{ + "resourceArn":{"shape":"Arn"} + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "required":["tags"], + "members":{ + "tags":{"shape":"TagList"} + } + }, + "Locale":{ + "type":"string", + "enum":["EN_US"] + }, + "Long":{"type":"long"}, + "Message":{ + "type":"string", + "max":1000, + "min":0 + }, + "MessageType":{ + "type":"string", + "max":300, + "min":1 + }, + "NamePattern":{ + "type":"string", + "max":140, + "min":1 + }, + "NoSuchEntityErrorCode":{ + "type":"string", + "enum":[ + "ASSESSMENT_TARGET_DOES_NOT_EXIST", + "ASSESSMENT_TEMPLATE_DOES_NOT_EXIST", + "ASSESSMENT_RUN_DOES_NOT_EXIST", + "FINDING_DOES_NOT_EXIST", + "RESOURCE_GROUP_DOES_NOT_EXIST", + "RULES_PACKAGE_DOES_NOT_EXIST", + "SNS_TOPIC_DOES_NOT_EXIST", + "IAM_ROLE_DOES_NOT_EXIST" + ] + }, + "NoSuchEntityException":{ + "type":"structure", + "required":[ + "message", + "errorCode", + "canRetry" + ], + "members":{ + "message":{"shape":"ErrorMessage"}, + "errorCode":{"shape":"NoSuchEntityErrorCode"}, + "canRetry":{"shape":"Bool"} + }, + "exception":true + }, + "NumericSeverity":{ + "type":"double", + "max":10.0, + "min":0.0 + }, + "NumericVersion":{ + "type":"integer", + "min":0 + }, + "PaginationToken":{ + "type":"string", + "max":300, + "min":1 + }, + "PreviewAgentsMaxResults":{"type":"integer"}, + "PreviewAgentsRequest":{ + "type":"structure", + "required":["previewAgentsArn"], + "members":{ + "previewAgentsArn":{"shape":"Arn"}, + "nextToken":{"shape":"PaginationToken"}, + "maxResults":{"shape":"PreviewAgentsMaxResults"} + } + }, + "PreviewAgentsResponse":{ + "type":"structure", + "required":["agentPreviews"], + "members":{ + "agentPreviews":{"shape":"AgentPreviewList"}, + "nextToken":{"shape":"PaginationToken"} + } + }, + "ProviderName":{ + "type":"string", + "max":1000, + "min":0 + }, + "RegisterCrossAccountAccessRoleRequest":{ + "type":"structure", + "required":["roleArn"], + "members":{ + "roleArn":{"shape":"Arn"} + } + }, + "RemoveAttributesFromFindingsRequest":{ + "type":"structure", + "required":[ + "findingArns", + "attributeKeys" + ], + "members":{ + "findingArns":{"shape":"AddRemoveAttributesFindingArnList"}, + "attributeKeys":{"shape":"UserAttributeKeyList"} + } + }, + "RemoveAttributesFromFindingsResponse":{ + "type":"structure", + "required":["failedItems"], + "members":{ + "failedItems":{"shape":"FailedItems"} + } + }, + "ResourceGroup":{ + "type":"structure", + "required":[ + "arn", + "tags", + "createdAt" + ], + "members":{ + "arn":{"shape":"Arn"}, + "tags":{"shape":"ResourceGroupTags"}, + "createdAt":{"shape":"Timestamp"} + } + }, + "ResourceGroupList":{ + "type":"list", + "member":{"shape":"ResourceGroup"}, + "max":10, + "min":0 + }, + "ResourceGroupTag":{ + "type":"structure", + "required":["key"], + "members":{ + "key":{"shape":"TagKey"}, + "value":{"shape":"TagValue"} + } + }, + "ResourceGroupTags":{ + "type":"list", + "member":{"shape":"ResourceGroupTag"}, + "max":10, + "min":1 + }, + "RuleName":{ + "type":"string", + "max":1000 + }, + "RuleNameList":{ + "type":"list", + "member":{"shape":"RuleName"}, + "max":50, + "min":0 + }, + "RulesPackage":{ + "type":"structure", + "required":[ + "arn", + "name", + "version", + "provider" + ], + "members":{ + "arn":{"shape":"Arn"}, + "name":{"shape":"RulesPackageName"}, + "version":{"shape":"Version"}, + "provider":{"shape":"ProviderName"}, + "description":{"shape":"Text"} + } + }, + "RulesPackageList":{ + "type":"list", + "member":{"shape":"RulesPackage"}, + "max":10, + "min":0 + }, + "RulesPackageName":{ + "type":"string", + "max":1000, + "min":0 + }, + "ServiceName":{ + "type":"string", + "max":128, + "min":0 + }, + "SetTagsForResourceRequest":{ + "type":"structure", + "required":["resourceArn"], + "members":{ + "resourceArn":{"shape":"Arn"}, + "tags":{"shape":"TagList"} + } + }, + "Severity":{ + "type":"string", + "enum":[ + "Low", + "Medium", + "High", + "Informational", + "Undefined" + ] + }, + "SeverityList":{ + "type":"list", + "member":{"shape":"Severity"}, + "max":50, + "min":0 + }, + "StartAssessmentRunRequest":{ + "type":"structure", + "required":["assessmentTemplateArn"], + "members":{ + "assessmentTemplateArn":{"shape":"Arn"}, + "assessmentRunName":{"shape":"AssessmentRunName"} + } + }, + "StartAssessmentRunResponse":{ + "type":"structure", + "required":["assessmentRunArn"], + "members":{ + "assessmentRunArn":{"shape":"Arn"} + } + }, + "StopAssessmentRunRequest":{ + "type":"structure", + "required":["assessmentRunArn"], + "members":{ + "assessmentRunArn":{"shape":"Arn"} + } + }, + "SubscribeToEventRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "event", + "topicArn" + ], + "members":{ + "resourceArn":{"shape":"Arn"}, + "event":{"shape":"InspectorEvent"}, + "topicArn":{"shape":"Arn"} + } + }, + "Subscription":{ + "type":"structure", + "required":[ + "resourceArn", + "topicArn", + "eventSubscriptions" + ], + "members":{ + "resourceArn":{"shape":"Arn"}, + "topicArn":{"shape":"Arn"}, + "eventSubscriptions":{"shape":"EventSubscriptionList"} + } + }, + "SubscriptionList":{ + "type":"list", + "member":{"shape":"Subscription"}, + "max":50, + "min":0 + }, + "Tag":{ + "type":"structure", + "required":["key"], + "members":{ + "key":{"shape":"TagKey"}, + "value":{"shape":"TagValue"} + } + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1 + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"}, + "max":10, + "min":0 + }, + "TagValue":{ + "type":"string", + "max":256, + "min":1 + }, + "TelemetryMetadata":{ + "type":"structure", + "required":[ + "messageType", + "count" + ], + "members":{ + "messageType":{"shape":"MessageType"}, + "count":{"shape":"Long"}, + "dataSize":{"shape":"Long"} + } + }, + "TelemetryMetadataList":{ + "type":"list", + "member":{"shape":"TelemetryMetadata"}, + "max":5000, + "min":0 + }, + "Text":{ + "type":"string", + "max":20000, + "min":0 + }, + "Timestamp":{"type":"timestamp"}, + "TimestampRange":{ + "type":"structure", + "members":{ + "beginDate":{"shape":"Timestamp"}, + "endDate":{"shape":"Timestamp"} + } + }, + "UnsubscribeFromEventRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "event", + "topicArn" + ], + "members":{ + "resourceArn":{"shape":"Arn"}, + "event":{"shape":"InspectorEvent"}, + "topicArn":{"shape":"Arn"} + } + }, + "UpdateAssessmentTargetRequest":{ + "type":"structure", + "required":[ + "assessmentTargetArn", + "assessmentTargetName", + "resourceGroupArn" + ], + "members":{ + "assessmentTargetArn":{"shape":"Arn"}, + "assessmentTargetName":{"shape":"AssessmentTargetName"}, + "resourceGroupArn":{"shape":"Arn"} + } + }, + "UserAttributeKeyList":{ + "type":"list", + "member":{"shape":"AttributeKey"}, + "max":10, + "min":0 + }, + "UserAttributeList":{ + "type":"list", + "member":{"shape":"Attribute"}, + "max":10, + "min":0 + }, + "Version":{ + "type":"string", + "max":1000, + "min":0 + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/inspector/2016-02-16/docs-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/inspector/2016-02-16/docs-2.json new file mode 100644 index 000000000..2f3ec30b7 --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/inspector/2016-02-16/docs-2.json @@ -0,0 +1,1199 @@ +{ + "version": "2.0", + "service": "Amazon Inspector enables you to analyze the behavior of your AWS resources and to identify potential security issues. For more information, see Amazon Inspector User Guide.
", + "operations": { + "AddAttributesToFindings": "Assigns attributes (key and value pairs) to the findings that are specified by the ARNs of the findings.
", + "CreateAssessmentTarget": "Creates a new assessment target using the ARN of the resource group that is generated by CreateResourceGroup. You can create up to 50 assessment targets per AWS account. You can run up to 500 concurrent agents per AWS account. For more information, see Amazon Inspector Assessment Targets.
", + "CreateAssessmentTemplate": "Creates an assessment template for the assessment target that is specified by the ARN of the assessment target.
", + "CreateResourceGroup": "Creates a resource group using the specified set of tags (key and value pairs) that are used to select the EC2 instances to be included in an Amazon Inspector assessment target. The created resource group is then used to create an Amazon Inspector assessment target. For more information, see CreateAssessmentTarget.
", + "DeleteAssessmentRun": "Deletes the assessment run that is specified by the ARN of the assessment run.
", + "DeleteAssessmentTarget": "Deletes the assessment target that is specified by the ARN of the assessment target.
", + "DeleteAssessmentTemplate": "Deletes the assessment template that is specified by the ARN of the assessment template.
", + "DescribeAssessmentRuns": "Describes the assessment runs that are specified by the ARNs of the assessment runs.
", + "DescribeAssessmentTargets": "Describes the assessment targets that are specified by the ARNs of the assessment targets.
", + "DescribeAssessmentTemplates": "Describes the assessment templates that are specified by the ARNs of the assessment templates.
", + "DescribeCrossAccountAccessRole": "Describes the IAM role that enables Amazon Inspector to access your AWS account.
", + "DescribeFindings": "Describes the findings that are specified by the ARNs of the findings.
", + "DescribeResourceGroups": "Describes the resource groups that are specified by the ARNs of the resource groups.
", + "DescribeRulesPackages": "Describes the rules packages that are specified by the ARNs of the rules packages.
", + "GetTelemetryMetadata": "Information about the data that is collected for the specified assessment run.
", + "ListAssessmentRunAgents": "Lists the agents of the assessment runs that are specified by the ARNs of the assessment runs.
", + "ListAssessmentRuns": "Lists the assessment runs that correspond to the assessment templates that are specified by the ARNs of the assessment templates.
", + "ListAssessmentTargets": "Lists the ARNs of the assessment targets within this AWS account. For more information about assessment targets, see Amazon Inspector Assessment Targets.
", + "ListAssessmentTemplates": "Lists the assessment templates that correspond to the assessment targets that are specified by the ARNs of the assessment targets.
", + "ListEventSubscriptions": "Lists all the event subscriptions for the assessment template that is specified by the ARN of the assessment template. For more information, see SubscribeToEvent and UnsubscribeFromEvent.
", + "ListFindings": "Lists findings that are generated by the assessment runs that are specified by the ARNs of the assessment runs.
", + "ListRulesPackages": "Lists all available Amazon Inspector rules packages.
", + "ListTagsForResource": "Lists all tags associated with an assessment template.
", + "PreviewAgents": "Previews the agents installed on the EC2 instances that are part of the specified assessment target.
", + "RegisterCrossAccountAccessRole": "Registers the IAM role that Amazon Inspector uses to list your EC2 instances at the start of the assessment run or when you call the PreviewAgents action.
", + "RemoveAttributesFromFindings": "Removes entire attributes (key and value pairs) from the findings that are specified by the ARNs of the findings where an attribute with the specified key exists.
", + "SetTagsForResource": "Sets tags (key and value pairs) to the assessment template that is specified by the ARN of the assessment template.
", + "StartAssessmentRun": "Starts the assessment run specified by the ARN of the assessment template. For this API to function properly, you must not exceed the limit of running up to 500 concurrent agents per AWS account.
", + "StopAssessmentRun": "Stops the assessment run that is specified by the ARN of the assessment run.
", + "SubscribeToEvent": "Enables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS topic.
", + "UnsubscribeFromEvent": "Disables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS topic.
", + "UpdateAssessmentTarget": "Updates the assessment target that is specified by the ARN of the assessment target.
" + }, + "shapes": { + "AccessDeniedErrorCode": { + "base": null, + "refs": { + "AccessDeniedException$errorCode": "Code that indicates the type of error that is generated.
" + } + }, + "AccessDeniedException": { + "base": "You do not have required permissions to access the requested resource.
", + "refs": { + } + }, + "AddAttributesToFindingsRequest": { + "base": null, + "refs": { + } + }, + "AddAttributesToFindingsResponse": { + "base": null, + "refs": { + } + }, + "AddRemoveAttributesFindingArnList": { + "base": null, + "refs": { + "AddAttributesToFindingsRequest$findingArns": "The ARNs that specify the findings that you want to assign attributes to.
", + "RemoveAttributesFromFindingsRequest$findingArns": "The ARNs that specify the findings that you want to remove attributes from.
" + } + }, + "AgentAlreadyRunningAssessment": { + "base": "Used in the exception error that is thrown if you start an assessment run for an assessment target that includes an EC2 instance that is already participating in another started assessment run.
", + "refs": { + "AgentAlreadyRunningAssessmentList$member": null + } + }, + "AgentAlreadyRunningAssessmentList": { + "base": null, + "refs": { + "AgentsAlreadyRunningAssessmentException$agents": "" + } + }, + "AgentFilter": { + "base": "Contains information about an Amazon Inspector agent. This data type is used as a request parameter in the ListAssessmentRunAgents action.
", + "refs": { + "ListAssessmentRunAgentsRequest$filter": "You can use this parameter to specify a subset of data to be included in the action's response.
For a record to match a filter, all specified filter attributes must match. When multiple values are specified for a filter attribute, any of the values can match.
" + } + }, + "AgentHealth": { + "base": null, + "refs": { + "AgentHealthList$member": null, + "AssessmentRunAgent$agentHealth": "The current health state of the agent.
" + } + }, + "AgentHealthCode": { + "base": null, + "refs": { + "AgentHealthCodeList$member": null, + "AssessmentRunAgent$agentHealthCode": "The detailed health state of the agent.
" + } + }, + "AgentHealthCodeList": { + "base": null, + "refs": { + "AgentFilter$agentHealthCodes": "The detailed health state of the agent. Values can be set to IDLE, RUNNING, SHUTDOWN, UNHEALTHY, THROTTLED, and UNKNOWN.
" + } + }, + "AgentHealthList": { + "base": null, + "refs": { + "AgentFilter$agentHealths": "The current health state of the agent. Values can be set to HEALTHY or UNHEALTHY.
" + } + }, + "AgentId": { + "base": null, + "refs": { + "AgentAlreadyRunningAssessment$agentId": "ID of the agent that is running on an EC2 instance that is already participating in another started assessment run.
", + "AgentIdList$member": null, + "AgentPreview$agentId": "The ID of the EC2 instance where the agent is installed.
", + "AssessmentRunAgent$agentId": "The AWS account of the EC2 instance where the agent is installed.
", + "AssetAttributes$agentId": "The ID of the agent that is installed on the EC2 instance where the finding is generated.
" + } + }, + "AgentIdList": { + "base": null, + "refs": { + "FindingFilter$agentIds": "For a record to match a filter, one of the values that is specified for this data type property must be the exact match of the value of the agentId property of the Finding data type.
" + } + }, + "AgentPreview": { + "base": "Used as a response element in the PreviewAgents action.
", + "refs": { + "AgentPreviewList$member": null + } + }, + "AgentPreviewList": { + "base": null, + "refs": { + "PreviewAgentsResponse$agentPreviews": "The resulting list of agents.
" + } + }, + "AgentsAlreadyRunningAssessmentException": { + "base": "You started an assessment run, but one of the instances is already participating in another assessment run.
", + "refs": { + } + }, + "AmiId": { + "base": null, + "refs": { + "AssetAttributes$amiId": "The ID of the Amazon Machine Image (AMI) that is installed on the EC2 instance where the finding is generated.
" + } + }, + "Arn": { + "base": null, + "refs": { + "AddRemoveAttributesFindingArnList$member": null, + "AgentAlreadyRunningAssessment$assessmentRunArn": "The ARN of the assessment run that has already been started.
", + "AssessmentRulesPackageArnList$member": null, + "AssessmentRun$arn": "The ARN of the assessment run.
", + "AssessmentRun$assessmentTemplateArn": "The ARN of the assessment template that is associated with the assessment run.
", + "AssessmentRunAgent$assessmentRunArn": "The ARN of the assessment run that is associated with the agent.
", + "AssessmentRunInProgressArnList$member": null, + "AssessmentRunNotification$snsTopicArn": "The SNS topic to which the SNS notification is sent.
", + "AssessmentTarget$arn": "The ARN that specifies the Amazon Inspector assessment target.
", + "AssessmentTarget$resourceGroupArn": "The ARN that specifies the resource group that is associated with the assessment target.
", + "AssessmentTemplate$arn": "The ARN of the assessment template.
", + "AssessmentTemplate$assessmentTargetArn": "The ARN of the assessment target that corresponds to this assessment template.
", + "AssessmentTemplateRulesPackageArnList$member": null, + "BatchDescribeArnList$member": null, + "CreateAssessmentTargetRequest$resourceGroupArn": "The ARN that specifies the resource group that is used to create the assessment target.
", + "CreateAssessmentTargetResponse$assessmentTargetArn": "The ARN that specifies the assessment target that is created.
", + "CreateAssessmentTemplateRequest$assessmentTargetArn": "The ARN that specifies the assessment target for which you want to create the assessment template.
", + "CreateAssessmentTemplateResponse$assessmentTemplateArn": "The ARN that specifies the assessment template that is created.
", + "CreateResourceGroupResponse$resourceGroupArn": "The ARN that specifies the resource group that is created.
", + "DeleteAssessmentRunRequest$assessmentRunArn": "The ARN that specifies the assessment run that you want to delete.
", + "DeleteAssessmentTargetRequest$assessmentTargetArn": "The ARN that specifies the assessment target that you want to delete.
", + "DeleteAssessmentTemplateRequest$assessmentTemplateArn": "The ARN that specifies the assessment template that you want to delete.
", + "DescribeCrossAccountAccessRoleResponse$roleArn": "The ARN that specifies the IAM role that Amazon Inspector uses to access your AWS account.
", + "FailedItems$key": null, + "FilterRulesPackageArnList$member": null, + "Finding$arn": "The ARN that specifies the finding.
", + "GetTelemetryMetadataRequest$assessmentRunArn": "The ARN that specifies the assessment run that has the telemetry data that you want to obtain.
", + "InspectorServiceAttributes$assessmentRunArn": "The ARN of the assessment run during which the finding is generated.
", + "InspectorServiceAttributes$rulesPackageArn": "The ARN of the rules package that is used to generate the finding.
", + "ListAssessmentRunAgentsRequest$assessmentRunArn": "The ARN that specifies the assessment run whose agents you want to list.
", + "ListEventSubscriptionsRequest$resourceArn": "The ARN of the assessment template for which you want to list the existing event subscriptions.
", + "ListParentArnList$member": null, + "ListReturnedArnList$member": null, + "ListTagsForResourceRequest$resourceArn": "The ARN that specifies the assessment template whose tags you want to list.
", + "PreviewAgentsRequest$previewAgentsArn": "The ARN of the assessment target whose agents you want to preview.
", + "RegisterCrossAccountAccessRoleRequest$roleArn": "The ARN of the IAM role that Amazon Inspector uses to list your EC2 instances during the assessment run or when you call the PreviewAgents action.
", + "ResourceGroup$arn": "The ARN of the resource group.
", + "RulesPackage$arn": "The ARN of the rules package.
", + "SetTagsForResourceRequest$resourceArn": "The ARN of the assessment template that you want to set tags to.
", + "StartAssessmentRunRequest$assessmentTemplateArn": "The ARN of the assessment template of the assessment run that you want to start.
", + "StartAssessmentRunResponse$assessmentRunArn": "The ARN of the assessment run that has been started.
", + "StopAssessmentRunRequest$assessmentRunArn": "The ARN of the assessment run that you want to stop.
", + "SubscribeToEventRequest$resourceArn": "The ARN of the assessment template that is used during the event for which you want to receive SNS notifications.
", + "SubscribeToEventRequest$topicArn": "The ARN of the SNS topic to which the SNS notifications are sent.
", + "Subscription$resourceArn": "The ARN of the assessment template that is used during the event for which the SNS notification is sent.
", + "Subscription$topicArn": "The ARN of the Amazon Simple Notification Service (SNS) topic to which the SNS notifications are sent.
", + "UnsubscribeFromEventRequest$resourceArn": "The ARN of the assessment template that is used during the event for which you want to stop receiving SNS notifications.
", + "UnsubscribeFromEventRequest$topicArn": "The ARN of the SNS topic to which SNS notifications are sent.
", + "UpdateAssessmentTargetRequest$assessmentTargetArn": "The ARN of the assessment target that you want to update.
", + "UpdateAssessmentTargetRequest$resourceGroupArn": "The ARN of the resource group that is used to specify the new resource group to associate with the assessment target.
" + } + }, + "AssessmentRulesPackageArnList": { + "base": null, + "refs": { + "AssessmentRun$rulesPackageArns": "The rules packages selected for the assessment run.
" + } + }, + "AssessmentRun": { + "base": "A snapshot of an Amazon Inspector assessment run that contains the findings of the assessment run .
Used as the response element in the DescribeAssessmentRuns action.
", + "refs": { + "AssessmentRunList$member": null + } + }, + "AssessmentRunAgent": { + "base": "Contains information about an Amazon Inspector agent. This data type is used as a response element in the ListAssessmentRunAgents action.
", + "refs": { + "AssessmentRunAgentList$member": null + } + }, + "AssessmentRunAgentList": { + "base": null, + "refs": { + "ListAssessmentRunAgentsResponse$assessmentRunAgents": "A list of ARNs that specifies the agents returned by the action.
" + } + }, + "AssessmentRunDuration": { + "base": null, + "refs": { + "AssessmentRun$durationInSeconds": "The duration of the assessment run.
", + "AssessmentTemplate$durationInSeconds": "The duration in seconds specified for this assessment tempate. The default value is 3600 seconds (one hour). The maximum value is 86400 seconds (one day).
", + "CreateAssessmentTemplateRequest$durationInSeconds": "The duration of the assessment run in seconds. The default value is 3600 seconds (one hour).
", + "DurationRange$minSeconds": "The minimum value of the duration range. Must be greater than zero.
", + "DurationRange$maxSeconds": "The maximum value of the duration range. Must be less than or equal to 604800 seconds (1 week).
" + } + }, + "AssessmentRunFilter": { + "base": "Used as the request parameter in the ListAssessmentRuns action.
", + "refs": { + "ListAssessmentRunsRequest$filter": "You can use this parameter to specify a subset of data to be included in the action's response.
For a record to match a filter, all specified filter attributes must match. When multiple values are specified for a filter attribute, any of the values can match.
" + } + }, + "AssessmentRunInProgressArnList": { + "base": null, + "refs": { + "AssessmentRunInProgressException$assessmentRunArns": "The ARNs of the assessment runs that are currently in progress.
" + } + }, + "AssessmentRunInProgressException": { + "base": "You cannot perform a specified action if an assessment run is currently in progress.
", + "refs": { + } + }, + "AssessmentRunList": { + "base": null, + "refs": { + "DescribeAssessmentRunsResponse$assessmentRuns": "Information about the assessment run.
" + } + }, + "AssessmentRunName": { + "base": null, + "refs": { + "AssessmentRun$name": "The auto-generated name for the assessment run.
", + "StartAssessmentRunRequest$assessmentRunName": "You can specify the name for the assessment run, or you can use the auto-generated name that is based on the assessment template name. The name must be unique for the assessment template.
" + } + }, + "AssessmentRunNotification": { + "base": "Used as one of the elements of the AssessmentRun data type.
", + "refs": { + "AssessmentRunNotificationList$member": null + } + }, + "AssessmentRunNotificationList": { + "base": null, + "refs": { + "AssessmentRun$notifications": "A list of notifications for the event subscriptions. A notification about a particular generated finding is added to this list only once.
" + } + }, + "AssessmentRunNotificationSnsStatusCode": { + "base": null, + "refs": { + "AssessmentRunNotification$snsPublishStatusCode": "The status code of the SNS notification.
" + } + }, + "AssessmentRunState": { + "base": null, + "refs": { + "AssessmentRun$state": "The state of the assessment run.
", + "AssessmentRunStateChange$state": "The assessment run state.
", + "AssessmentRunStateList$member": null + } + }, + "AssessmentRunStateChange": { + "base": "Used as one of the elements of the AssessmentRun data type.
", + "refs": { + "AssessmentRunStateChangeList$member": null + } + }, + "AssessmentRunStateChangeList": { + "base": null, + "refs": { + "AssessmentRun$stateChanges": "A list of the assessment run state changes.
" + } + }, + "AssessmentRunStateList": { + "base": null, + "refs": { + "AssessmentRunFilter$states": "For a record to match a filter, one of the values specified for this data type property must be the exact match of the value of the assessmentRunState property of the AssessmentRun data type.
" + } + }, + "AssessmentTarget": { + "base": "Contains information about an Amazon Inspector application. This data type is used as the response element in the DescribeAssessmentTargets action.
", + "refs": { + "AssessmentTargetList$member": null + } + }, + "AssessmentTargetFilter": { + "base": "Used as the request parameter in the ListAssessmentTargets action.
", + "refs": { + "ListAssessmentTargetsRequest$filter": "You can use this parameter to specify a subset of data to be included in the action's response.
For a record to match a filter, all specified filter attributes must match. When multiple values are specified for a filter attribute, any of the values can match.
" + } + }, + "AssessmentTargetList": { + "base": null, + "refs": { + "DescribeAssessmentTargetsResponse$assessmentTargets": "Information about the assessment targets.
" + } + }, + "AssessmentTargetName": { + "base": null, + "refs": { + "AssessmentTarget$name": "The name of the Amazon Inspector assessment target.
", + "CreateAssessmentTargetRequest$assessmentTargetName": "The user-defined name that identifies the assessment target that you want to create. The name must be unique within the AWS account.
", + "UpdateAssessmentTargetRequest$assessmentTargetName": "The name of the assessment target that you want to update.
" + } + }, + "AssessmentTemplate": { + "base": "Contains information about an Amazon Inspector assessment template. This data type is used as the response element in the DescribeAssessmentTemplates action.
", + "refs": { + "AssessmentTemplateList$member": null + } + }, + "AssessmentTemplateFilter": { + "base": "Used as the request parameter in the ListAssessmentTemplates action.
", + "refs": { + "ListAssessmentTemplatesRequest$filter": "You can use this parameter to specify a subset of data to be included in the action's response.
For a record to match a filter, all specified filter attributes must match. When multiple values are specified for a filter attribute, any of the values can match.
" + } + }, + "AssessmentTemplateList": { + "base": null, + "refs": { + "DescribeAssessmentTemplatesResponse$assessmentTemplates": "Information about the assessment templates.
" + } + }, + "AssessmentTemplateName": { + "base": null, + "refs": { + "AssessmentTemplate$name": "The name of the assessment template.
", + "CreateAssessmentTemplateRequest$assessmentTemplateName": "The user-defined name that identifies the assessment template that you want to create. You can create several assessment templates for an assessment target. The names of the assessment templates that correspond to a particular assessment target must be unique.
" + } + }, + "AssessmentTemplateRulesPackageArnList": { + "base": null, + "refs": { + "AssessmentTemplate$rulesPackageArns": "The rules packages that are specified for this assessment template.
", + "CreateAssessmentTemplateRequest$rulesPackageArns": "The ARNs that specify the rules packages that you want to attach to the assessment template.
" + } + }, + "AssetAttributes": { + "base": "A collection of attributes of the host from which the finding is generated.
", + "refs": { + "Finding$assetAttributes": "A collection of attributes of the host from which the finding is generated.
" + } + }, + "AssetType": { + "base": null, + "refs": { + "Finding$assetType": "The type of the host from which the finding is generated.
" + } + }, + "Attribute": { + "base": "This data type is used as a request parameter in the AddAttributesToFindings and CreateAssessmentTemplate actions.
", + "refs": { + "AttributeList$member": null, + "UserAttributeList$member": null + } + }, + "AttributeKey": { + "base": null, + "refs": { + "Attribute$key": "The attribute key.
", + "UserAttributeKeyList$member": null + } + }, + "AttributeList": { + "base": null, + "refs": { + "Finding$attributes": "The system-defined attributes for the finding.
", + "FindingFilter$attributes": "For a record to match a filter, the list of values that are specified for this data type property must be contained in the list of values of the attributes property of the Finding data type.
", + "FindingFilter$userAttributes": "For a record to match a filter, the value that is specified for this data type property must be contained in the list of values of the userAttributes property of the Finding data type.
" + } + }, + "AttributeValue": { + "base": null, + "refs": { + "Attribute$value": "The value assigned to the attribute key.
" + } + }, + "AutoScalingGroup": { + "base": null, + "refs": { + "AgentPreview$autoScalingGroup": "The Auto Scaling group for the EC2 instance where the agent is installed.
", + "AssessmentRunAgent$autoScalingGroup": "The Auto Scaling group of the EC2 instance that is specified by the agent ID.
", + "AssetAttributes$autoScalingGroup": "The Auto Scaling group of the EC2 instance where the finding is generated.
", + "AutoScalingGroupList$member": null + } + }, + "AutoScalingGroupList": { + "base": null, + "refs": { + "FindingFilter$autoScalingGroups": "For a record to match a filter, one of the values that is specified for this data type property must be the exact match of the value of the autoScalingGroup property of the Finding data type.
" + } + }, + "BatchDescribeArnList": { + "base": null, + "refs": { + "DescribeAssessmentRunsRequest$assessmentRunArns": "The ARN that specifies the assessment run that you want to describe.
", + "DescribeAssessmentTargetsRequest$assessmentTargetArns": "The ARNs that specifies the assessment targets that you want to describe.
", + "DescribeAssessmentTemplatesRequest$assessmentTemplateArns": "The ARN that specifiesthe assessment templates that you want to describe.
", + "DescribeFindingsRequest$findingArns": "The ARN that specifies the finding that you want to describe.
", + "DescribeResourceGroupsRequest$resourceGroupArns": "The ARN that specifies the resource group that you want to describe.
", + "DescribeRulesPackagesRequest$rulesPackageArns": "The ARN that specifies the rules package that you want to describe.
" + } + }, + "Bool": { + "base": null, + "refs": { + "AccessDeniedException$canRetry": "You can immediately retry your request.
", + "AgentsAlreadyRunningAssessmentException$agentsTruncated": "", + "AgentsAlreadyRunningAssessmentException$canRetry": "You can immediately retry your request.
", + "AssessmentRun$dataCollected": "A Boolean value (true or false) that specifies whether the process of collecting data from the agents is completed.
", + "AssessmentRunInProgressException$assessmentRunArnsTruncated": "Boolean value that indicates whether the ARN list of the assessment runs is truncated.
", + "AssessmentRunInProgressException$canRetry": "You can immediately retry your request.
", + "AssessmentRunNotification$error": "The Boolean value that specifies whether the notification represents an error.
", + "DescribeCrossAccountAccessRoleResponse$valid": "A Boolean value that specifies whether the IAM role has the necessary policies attached to enable Amazon Inspector to access your AWS account.
", + "FailedItemDetails$retryable": "Indicates whether you can immediately retry a request for this item for a specified resource.
", + "Finding$indicatorOfCompromise": "This data element is currently not used.
", + "InternalException$canRetry": "You can immediately retry your request.
", + "InvalidCrossAccountRoleException$canRetry": "You can immediately retry your request.
", + "InvalidInputException$canRetry": "You can immediately retry your request.
", + "LimitExceededException$canRetry": "You can immediately retry your request.
", + "NoSuchEntityException$canRetry": "You can immediately retry your request.
" + } + }, + "CreateAssessmentTargetRequest": { + "base": null, + "refs": { + } + }, + "CreateAssessmentTargetResponse": { + "base": null, + "refs": { + } + }, + "CreateAssessmentTemplateRequest": { + "base": null, + "refs": { + } + }, + "CreateAssessmentTemplateResponse": { + "base": null, + "refs": { + } + }, + "CreateResourceGroupRequest": { + "base": null, + "refs": { + } + }, + "CreateResourceGroupResponse": { + "base": null, + "refs": { + } + }, + "DeleteAssessmentRunRequest": { + "base": null, + "refs": { + } + }, + "DeleteAssessmentTargetRequest": { + "base": null, + "refs": { + } + }, + "DeleteAssessmentTemplateRequest": { + "base": null, + "refs": { + } + }, + "DescribeAssessmentRunsRequest": { + "base": null, + "refs": { + } + }, + "DescribeAssessmentRunsResponse": { + "base": null, + "refs": { + } + }, + "DescribeAssessmentTargetsRequest": { + "base": null, + "refs": { + } + }, + "DescribeAssessmentTargetsResponse": { + "base": null, + "refs": { + } + }, + "DescribeAssessmentTemplatesRequest": { + "base": null, + "refs": { + } + }, + "DescribeAssessmentTemplatesResponse": { + "base": null, + "refs": { + } + }, + "DescribeCrossAccountAccessRoleResponse": { + "base": null, + "refs": { + } + }, + "DescribeFindingsRequest": { + "base": null, + "refs": { + } + }, + "DescribeFindingsResponse": { + "base": null, + "refs": { + } + }, + "DescribeResourceGroupsRequest": { + "base": null, + "refs": { + } + }, + "DescribeResourceGroupsResponse": { + "base": null, + "refs": { + } + }, + "DescribeRulesPackagesRequest": { + "base": null, + "refs": { + } + }, + "DescribeRulesPackagesResponse": { + "base": null, + "refs": { + } + }, + "DurationRange": { + "base": "This data type is used in the AssessmentTemplateFilter data type.
", + "refs": { + "AssessmentRunFilter$durationRange": "For a record to match a filter, the value that is specified for this data type property must inclusively match any value between the specified minimum and maximum values of the durationInSeconds property of the AssessmentRun data type.
", + "AssessmentTemplateFilter$durationRange": "For a record to match a filter, the value specified for this data type property must inclusively match any value between the specified minimum and maximum values of the durationInSeconds property of the AssessmentTemplate data type.
" + } + }, + "ErrorMessage": { + "base": null, + "refs": { + "AccessDeniedException$message": "Details of the exception error.
", + "AgentsAlreadyRunningAssessmentException$message": "Details of the exception error.
", + "AssessmentRunInProgressException$message": "Details of the exception error.
", + "InternalException$message": "Details of the exception error.
", + "InvalidCrossAccountRoleException$message": "Details of the exception error.
", + "InvalidInputException$message": "Details of the exception error.
", + "LimitExceededException$message": "Details of the exception error.
", + "NoSuchEntityException$message": "Details of the exception error.
" + } + }, + "EventSubscription": { + "base": "This data type is used in the Subscription data type.
", + "refs": { + "EventSubscriptionList$member": null + } + }, + "EventSubscriptionList": { + "base": null, + "refs": { + "Subscription$eventSubscriptions": "The list of existing event subscriptions.
" + } + }, + "FailedItemDetails": { + "base": "Includes details about the failed items.
", + "refs": { + "FailedItems$value": null + } + }, + "FailedItemErrorCode": { + "base": null, + "refs": { + "FailedItemDetails$failureCode": "The status code of a failed item.
" + } + }, + "FailedItems": { + "base": null, + "refs": { + "AddAttributesToFindingsResponse$failedItems": "Attribute details that cannot be described. An error code is provided for each failed item.
", + "DescribeAssessmentRunsResponse$failedItems": "Assessment run details that cannot be described. An error code is provided for each failed item.
", + "DescribeAssessmentTargetsResponse$failedItems": "Assessment target details that cannot be described. An error code is provided for each failed item.
", + "DescribeAssessmentTemplatesResponse$failedItems": "Assessment template details that cannot be described. An error code is provided for each failed item.
", + "DescribeFindingsResponse$failedItems": "Finding details that cannot be described. An error code is provided for each failed item.
", + "DescribeResourceGroupsResponse$failedItems": "Resource group details that cannot be described. An error code is provided for each failed item.
", + "DescribeRulesPackagesResponse$failedItems": "Rules package details that cannot be described. An error code is provided for each failed item.
", + "RemoveAttributesFromFindingsResponse$failedItems": "Attributes details that cannot be described. An error code is provided for each failed item.
" + } + }, + "FilterRulesPackageArnList": { + "base": null, + "refs": { + "AssessmentRunFilter$rulesPackageArns": "For a record to match a filter, the value that is specified for this data type property must be contained in the list of values of the rulesPackages property of the AssessmentRun data type.
", + "AssessmentTemplateFilter$rulesPackageArns": "For a record to match a filter, the values that are specified for this data type property must be contained in the list of values of the rulesPackageArns property of the AssessmentTemplate data type.
", + "FindingFilter$rulesPackageArns": "For a record to match a filter, one of the values that is specified for this data type property must be the exact match of the value of the rulesPackageArn property of the Finding data type.
" + } + }, + "Finding": { + "base": "Contains information about an Amazon Inspector finding. This data type is used as the response element in the DescribeFindings action.
", + "refs": { + "FindingList$member": null + } + }, + "FindingFilter": { + "base": "This data type is used as a request parameter in the ListFindings action.
", + "refs": { + "ListFindingsRequest$filter": "You can use this parameter to specify a subset of data to be included in the action's response.
For a record to match a filter, all specified filter attributes must match. When multiple values are specified for a filter attribute, any of the values can match.
" + } + }, + "FindingId": { + "base": null, + "refs": { + "Finding$id": "The ID of the finding.
" + } + }, + "FindingList": { + "base": null, + "refs": { + "DescribeFindingsResponse$findings": "Information about the finding.
" + } + }, + "GetTelemetryMetadataRequest": { + "base": null, + "refs": { + } + }, + "GetTelemetryMetadataResponse": { + "base": null, + "refs": { + } + }, + "Hostname": { + "base": null, + "refs": { + "AssetAttributes$hostname": "The hostname of the EC2 instance where the finding is generated.
" + } + }, + "InspectorEvent": { + "base": null, + "refs": { + "AssessmentRunNotification$event": "The event for which a notification is sent.
", + "EventSubscription$event": "The event for which Amazon Simple Notification Service (SNS) notifications are sent.
", + "SubscribeToEventRequest$event": "The event for which you want to receive SNS notifications.
", + "UnsubscribeFromEventRequest$event": "The event for which you want to stop receiving SNS notifications.
" + } + }, + "InspectorServiceAttributes": { + "base": "This data type is used in the Finding data type.
", + "refs": { + "Finding$serviceAttributes": null + } + }, + "InternalException": { + "base": "Internal server error.
", + "refs": { + } + }, + "InvalidCrossAccountRoleErrorCode": { + "base": null, + "refs": { + "InvalidCrossAccountRoleException$errorCode": "Code that indicates the type of error that is generated.
" + } + }, + "InvalidCrossAccountRoleException": { + "base": "Amazon Inspector cannot assume the cross-account role that it needs to list your EC2 instances during the assessment run.
", + "refs": { + } + }, + "InvalidInputErrorCode": { + "base": null, + "refs": { + "InvalidInputException$errorCode": "Code that indicates the type of error that is generated.
" + } + }, + "InvalidInputException": { + "base": "The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
", + "refs": { + } + }, + "IocConfidence": { + "base": null, + "refs": { + "Finding$confidence": "This data element is currently not used.
" + } + }, + "Ipv4Address": { + "base": null, + "refs": { + "Ipv4AddressList$member": null + } + }, + "Ipv4AddressList": { + "base": null, + "refs": { + "AssetAttributes$ipv4Addresses": "The list of IP v4 addresses of the EC2 instance where the finding is generated.
" + } + }, + "LimitExceededErrorCode": { + "base": null, + "refs": { + "LimitExceededException$errorCode": "Code that indicates the type of error that is generated.
" + } + }, + "LimitExceededException": { + "base": "The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded.
", + "refs": { + } + }, + "ListAssessmentRunAgentsRequest": { + "base": null, + "refs": { + } + }, + "ListAssessmentRunAgentsResponse": { + "base": null, + "refs": { + } + }, + "ListAssessmentRunsRequest": { + "base": null, + "refs": { + } + }, + "ListAssessmentRunsResponse": { + "base": null, + "refs": { + } + }, + "ListAssessmentTargetsRequest": { + "base": null, + "refs": { + } + }, + "ListAssessmentTargetsResponse": { + "base": null, + "refs": { + } + }, + "ListAssessmentTemplatesRequest": { + "base": null, + "refs": { + } + }, + "ListAssessmentTemplatesResponse": { + "base": null, + "refs": { + } + }, + "ListEventSubscriptionsMaxResults": { + "base": null, + "refs": { + "ListEventSubscriptionsRequest$maxResults": "You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.
" + } + }, + "ListEventSubscriptionsRequest": { + "base": null, + "refs": { + } + }, + "ListEventSubscriptionsResponse": { + "base": null, + "refs": { + } + }, + "ListFindingsRequest": { + "base": null, + "refs": { + } + }, + "ListFindingsResponse": { + "base": null, + "refs": { + } + }, + "ListMaxResults": { + "base": null, + "refs": { + "ListAssessmentRunAgentsRequest$maxResults": "You can use this parameter to indicate the maximum number of items that you want in the response. The default value is 10. The maximum value is 500.
", + "ListAssessmentRunsRequest$maxResults": "You can use this parameter to indicate the maximum number of items that you want in the response. The default value is 10. The maximum value is 500.
", + "ListAssessmentTargetsRequest$maxResults": "You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.
", + "ListAssessmentTemplatesRequest$maxResults": "You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.
", + "ListFindingsRequest$maxResults": "You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.
", + "ListRulesPackagesRequest$maxResults": "You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.
" + } + }, + "ListParentArnList": { + "base": null, + "refs": { + "ListAssessmentRunsRequest$assessmentTemplateArns": "The ARNs that specify the assessment templates whose assessment runs you want to list.
", + "ListAssessmentTemplatesRequest$assessmentTargetArns": "A list of ARNs that specifies the assessment targets whose assessment templates you want to list.
", + "ListFindingsRequest$assessmentRunArns": "The ARNs of the assessment runs that generate the findings that you want to list.
" + } + }, + "ListReturnedArnList": { + "base": null, + "refs": { + "ListAssessmentRunsResponse$assessmentRunArns": "A list of ARNs that specifies the assessment runs that are returned by the action.
", + "ListAssessmentTargetsResponse$assessmentTargetArns": "A list of ARNs that specifies the assessment targets that are returned by the action.
", + "ListAssessmentTemplatesResponse$assessmentTemplateArns": "A list of ARNs that specifies the assessment templates returned by the action.
", + "ListFindingsResponse$findingArns": "A list of ARNs that specifies the findings returned by the action.
", + "ListRulesPackagesResponse$rulesPackageArns": "The list of ARNs that specifies the rules packages returned by the action.
" + } + }, + "ListRulesPackagesRequest": { + "base": null, + "refs": { + } + }, + "ListRulesPackagesResponse": { + "base": null, + "refs": { + } + }, + "ListTagsForResourceRequest": { + "base": null, + "refs": { + } + }, + "ListTagsForResourceResponse": { + "base": null, + "refs": { + } + }, + "Locale": { + "base": null, + "refs": { + "DescribeFindingsRequest$locale": "The locale into which you want to translate a finding description, recommendation, and the short description that identifies the finding.
", + "DescribeRulesPackagesRequest$locale": "The locale that you want to translate a rules package description into.
" + } + }, + "Long": { + "base": null, + "refs": { + "TelemetryMetadata$count": "The count of messages that the agent sends to the Amazon Inspector service.
", + "TelemetryMetadata$dataSize": "The data size of messages that the agent sends to the Amazon Inspector service.
" + } + }, + "Message": { + "base": null, + "refs": { + "AssessmentRunAgent$agentHealthDetails": "The description for the agent health code.
", + "AssessmentRunNotification$message": null + } + }, + "MessageType": { + "base": null, + "refs": { + "TelemetryMetadata$messageType": "A specific type of behavioral data that is collected by the agent.
" + } + }, + "NamePattern": { + "base": null, + "refs": { + "AssessmentRunFilter$namePattern": "For a record to match a filter, an explicit value or a string containing a wildcard that is specified for this data type property must match the value of the assessmentRunName property of the AssessmentRun data type.
", + "AssessmentTargetFilter$assessmentTargetNamePattern": "For a record to match a filter, an explicit value or a string that contains a wildcard that is specified for this data type property must match the value of the assessmentTargetName property of the AssessmentTarget data type.
", + "AssessmentTemplateFilter$namePattern": "For a record to match a filter, an explicit value or a string that contains a wildcard that is specified for this data type property must match the value of the assessmentTemplateName property of the AssessmentTemplate data type.
" + } + }, + "NoSuchEntityErrorCode": { + "base": null, + "refs": { + "NoSuchEntityException$errorCode": "Code that indicates the type of error that is generated.
" + } + }, + "NoSuchEntityException": { + "base": "The request was rejected because it referenced an entity that does not exist. The error code describes the entity.
", + "refs": { + } + }, + "NumericSeverity": { + "base": null, + "refs": { + "Finding$numericSeverity": "The numeric value of the finding severity.
" + } + }, + "NumericVersion": { + "base": null, + "refs": { + "AssetAttributes$schemaVersion": "The schema version of this data type.
", + "Finding$schemaVersion": "The schema version of this data type.
", + "InspectorServiceAttributes$schemaVersion": "The schema version of this data type.
" + } + }, + "PaginationToken": { + "base": null, + "refs": { + "ListAssessmentRunAgentsRequest$nextToken": "You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListAssessmentRunAgents action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
", + "ListAssessmentRunAgentsResponse$nextToken": "When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null.
", + "ListAssessmentRunsRequest$nextToken": "You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListAssessmentRuns action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
", + "ListAssessmentRunsResponse$nextToken": "When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null.
", + "ListAssessmentTargetsRequest$nextToken": "You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListAssessmentTargets action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
", + "ListAssessmentTargetsResponse$nextToken": "When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null.
", + "ListAssessmentTemplatesRequest$nextToken": "You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListAssessmentTemplates action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
", + "ListAssessmentTemplatesResponse$nextToken": "When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null.
", + "ListEventSubscriptionsRequest$nextToken": "You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListEventSubscriptions action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
", + "ListEventSubscriptionsResponse$nextToken": "When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null.
", + "ListFindingsRequest$nextToken": "You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListFindings action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
", + "ListFindingsResponse$nextToken": "When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null.
", + "ListRulesPackagesRequest$nextToken": "You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListRulesPackages action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
", + "ListRulesPackagesResponse$nextToken": "When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null.
", + "PreviewAgentsRequest$nextToken": "You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the PreviewAgents action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
", + "PreviewAgentsResponse$nextToken": "When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null.
" + } + }, + "PreviewAgentsMaxResults": { + "base": null, + "refs": { + "PreviewAgentsRequest$maxResults": "You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.
" + } + }, + "PreviewAgentsRequest": { + "base": null, + "refs": { + } + }, + "PreviewAgentsResponse": { + "base": null, + "refs": { + } + }, + "ProviderName": { + "base": null, + "refs": { + "RulesPackage$provider": "The provider of the rules package.
" + } + }, + "RegisterCrossAccountAccessRoleRequest": { + "base": null, + "refs": { + } + }, + "RemoveAttributesFromFindingsRequest": { + "base": null, + "refs": { + } + }, + "RemoveAttributesFromFindingsResponse": { + "base": null, + "refs": { + } + }, + "ResourceGroup": { + "base": "Contains information about a resource group. The resource group defines a set of tags that, when queried, identify the AWS resources that make up the assessment target. This data type is used as the response element in the DescribeResourceGroups action.
", + "refs": { + "ResourceGroupList$member": null + } + }, + "ResourceGroupList": { + "base": null, + "refs": { + "DescribeResourceGroupsResponse$resourceGroups": "Information about a resource group.
" + } + }, + "ResourceGroupTag": { + "base": "This data type is used as one of the elements of the ResourceGroup data type.
", + "refs": { + "ResourceGroupTags$member": null + } + }, + "ResourceGroupTags": { + "base": null, + "refs": { + "CreateResourceGroupRequest$resourceGroupTags": "A collection of keys and an array of possible values, '[{\"key\":\"key1\",\"values\":[\"Value1\",\"Value2\"]},{\"key\":\"Key2\",\"values\":[\"Value3\"]}]'.
For example,'[{\"key\":\"Name\",\"values\":[\"TestEC2Instance\"]}]'.
", + "ResourceGroup$tags": "The tags (key and value pairs) of the resource group. This data type property is used in the CreateResourceGroup action.
" + } + }, + "RuleName": { + "base": null, + "refs": { + "RuleNameList$member": null + } + }, + "RuleNameList": { + "base": null, + "refs": { + "FindingFilter$ruleNames": "For a record to match a filter, one of the values that is specified for this data type property must be the exact match of the value of the ruleName property of the Finding data type.
" + } + }, + "RulesPackage": { + "base": "Contains information about an Amazon Inspector rules package. This data type is used as the response element in the DescribeRulesPackages action.
", + "refs": { + "RulesPackageList$member": null + } + }, + "RulesPackageList": { + "base": null, + "refs": { + "DescribeRulesPackagesResponse$rulesPackages": "Information about the rules package.
" + } + }, + "RulesPackageName": { + "base": null, + "refs": { + "RulesPackage$name": "The name of the rules package.
" + } + }, + "ServiceName": { + "base": null, + "refs": { + "Finding$service": "The data element is set to \"Inspector\".
" + } + }, + "SetTagsForResourceRequest": { + "base": null, + "refs": { + } + }, + "Severity": { + "base": null, + "refs": { + "Finding$severity": "The finding severity. Values can be set to High, Medium, Low, and Informational.
", + "SeverityList$member": null + } + }, + "SeverityList": { + "base": null, + "refs": { + "FindingFilter$severities": "For a record to match a filter, one of the values that is specified for this data type property must be the exact match of the value of the severity property of the Finding data type.
" + } + }, + "StartAssessmentRunRequest": { + "base": null, + "refs": { + } + }, + "StartAssessmentRunResponse": { + "base": null, + "refs": { + } + }, + "StopAssessmentRunRequest": { + "base": null, + "refs": { + } + }, + "SubscribeToEventRequest": { + "base": null, + "refs": { + } + }, + "Subscription": { + "base": "This data type is used as a response element in the ListEventSubscriptions action.
", + "refs": { + "SubscriptionList$member": null + } + }, + "SubscriptionList": { + "base": null, + "refs": { + "ListEventSubscriptionsResponse$subscriptions": "Details of the returned event subscriptions.
" + } + }, + "Tag": { + "base": "A key and value pair. This data type is used as a request parameter in the SetTagsForResource action and a response element in the ListTagsForResource action.
", + "refs": { + "TagList$member": null + } + }, + "TagKey": { + "base": null, + "refs": { + "ResourceGroupTag$key": "A tag key.
", + "Tag$key": "A tag key.
" + } + }, + "TagList": { + "base": null, + "refs": { + "ListTagsForResourceResponse$tags": "A collection of key and value pairs.
", + "SetTagsForResourceRequest$tags": "A collection of key and value pairs that you want to set to the assessment template.
" + } + }, + "TagValue": { + "base": null, + "refs": { + "ResourceGroupTag$value": "The value assigned to a tag key.
", + "Tag$value": "A value assigned to a tag key.
" + } + }, + "TelemetryMetadata": { + "base": "The metadata about the Amazon Inspector application data metrics collected by the agent. This data type is used as the response element in the GetTelemetryMetadata action.
", + "refs": { + "TelemetryMetadataList$member": null + } + }, + "TelemetryMetadataList": { + "base": null, + "refs": { + "AssessmentRunAgent$telemetryMetadata": "The Amazon Inspector application data metrics that are collected by the agent.
", + "GetTelemetryMetadataResponse$telemetryMetadata": "Telemetry details.
" + } + }, + "Text": { + "base": null, + "refs": { + "Finding$title": "The name of the finding.
", + "Finding$description": "The description of the finding.
", + "Finding$recommendation": "The recommendation for the finding.
", + "RulesPackage$description": "The description of the rules package.
" + } + }, + "Timestamp": { + "base": null, + "refs": { + "AssessmentRun$createdAt": "The time when StartAssessmentRun was called.
", + "AssessmentRun$startedAt": "The time when StartAssessmentRun was called.
", + "AssessmentRun$completedAt": "The assessment run completion time that corresponds to the rules packages evaluation completion time or failure.
", + "AssessmentRun$stateChangedAt": "The last time when the assessment run's state changed.
", + "AssessmentRunNotification$date": "The date of the notification.
", + "AssessmentRunStateChange$stateChangedAt": "The last time the assessment run state changed.
", + "AssessmentTarget$createdAt": "The time at which the assessment target is created.
", + "AssessmentTarget$updatedAt": "The time at which UpdateAssessmentTarget is called.
", + "AssessmentTemplate$createdAt": "The time at which the assessment template is created.
", + "DescribeCrossAccountAccessRoleResponse$registeredAt": "The date when the cross-account access role was registered.
", + "EventSubscription$subscribedAt": "The time at which SubscribeToEvent is called.
", + "Finding$createdAt": "The time when the finding was generated.
", + "Finding$updatedAt": "The time when AddAttributesToFindings is called.
", + "ResourceGroup$createdAt": "The time at which resource group is created.
", + "TimestampRange$beginDate": "The minimum value of the timestamp range.
", + "TimestampRange$endDate": "The maximum value of the timestamp range.
" + } + }, + "TimestampRange": { + "base": "This data type is used in the AssessmentRunFilter data type.
", + "refs": { + "AssessmentRunFilter$startTimeRange": "For a record to match a filter, the value that is specified for this data type property must inclusively match any value between the specified minimum and maximum values of the startTime property of the AssessmentRun data type.
", + "AssessmentRunFilter$completionTimeRange": "For a record to match a filter, the value that is specified for this data type property must inclusively match any value between the specified minimum and maximum values of the completedAt property of the AssessmentRun data type.
", + "AssessmentRunFilter$stateChangeTimeRange": "For a record to match a filter, the value that is specified for this data type property must match the stateChangedAt property of the AssessmentRun data type.
", + "FindingFilter$creationTimeRange": "The time range during which the finding is generated.
" + } + }, + "UnsubscribeFromEventRequest": { + "base": null, + "refs": { + } + }, + "UpdateAssessmentTargetRequest": { + "base": null, + "refs": { + } + }, + "UserAttributeKeyList": { + "base": null, + "refs": { + "RemoveAttributesFromFindingsRequest$attributeKeys": "The array of attribute keys that you want to remove from specified findings.
" + } + }, + "UserAttributeList": { + "base": null, + "refs": { + "AddAttributesToFindingsRequest$attributes": "The array of attributes that you want to assign to specified findings.
", + "AssessmentRun$userAttributesForFindings": "The user-defined attributes that are assigned to every generated finding.
", + "AssessmentTemplate$userAttributesForFindings": "The user-defined attributes that are assigned to every generated finding from the assessment run that uses this assessment template.
", + "CreateAssessmentTemplateRequest$userAttributesForFindings": "The user-defined attributes that are assigned to every finding that is generated by the assessment run that uses this assessment template.
", + "Finding$userAttributes": "The user-defined attributes that are assigned to the finding.
" + } + }, + "Version": { + "base": null, + "refs": { + "RulesPackage$version": "The version ID of the rules package.
" + } + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/inspector/2016-02-16/examples-1.json b/vendor/github.com/aws/aws-sdk-go/models/apis/inspector/2016-02-16/examples-1.json new file mode 100644 index 000000000..0ea7e3b0b --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/inspector/2016-02-16/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/iot-data/2015-05-28/api-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/iot-data/2015-05-28/api-2.json new file mode 100644 index 000000000..9f6a9f4af --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/iot-data/2015-05-28/api-2.json @@ -0,0 +1,263 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2015-05-28", + "endpointPrefix":"data.iot", + "protocol":"rest-json", + "serviceFullName":"AWS IoT Data Plane", + "signatureVersion":"v4", + "signingName":"iotdata" + }, + "operations":{ + "DeleteThingShadow":{ + "name":"DeleteThingShadow", + "http":{ + "method":"DELETE", + "requestUri":"/things/{thingName}/shadow" + }, + "input":{"shape":"DeleteThingShadowRequest"}, + "output":{"shape":"DeleteThingShadowResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"}, + {"shape":"MethodNotAllowedException"}, + {"shape":"UnsupportedDocumentEncodingException"} + ] + }, + "GetThingShadow":{ + "name":"GetThingShadow", + "http":{ + "method":"GET", + "requestUri":"/things/{thingName}/shadow" + }, + "input":{"shape":"GetThingShadowRequest"}, + "output":{"shape":"GetThingShadowResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"}, + {"shape":"MethodNotAllowedException"}, + {"shape":"UnsupportedDocumentEncodingException"} + ] + }, + "Publish":{ + "name":"Publish", + "http":{ + "method":"POST", + "requestUri":"/topics/{topic}" + }, + "input":{"shape":"PublishRequest"}, + "errors":[ + {"shape":"InternalFailureException"}, + {"shape":"InvalidRequestException"}, + {"shape":"UnauthorizedException"}, + {"shape":"MethodNotAllowedException"} + ] + }, + "UpdateThingShadow":{ + "name":"UpdateThingShadow", + "http":{ + "method":"POST", + "requestUri":"/things/{thingName}/shadow" + }, + "input":{"shape":"UpdateThingShadowRequest"}, + "output":{"shape":"UpdateThingShadowResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"RequestEntityTooLargeException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"}, + {"shape":"MethodNotAllowedException"}, + {"shape":"UnsupportedDocumentEncodingException"} + ] + } + }, + "shapes":{ + "ConflictException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "DeleteThingShadowRequest":{ + "type":"structure", + "required":["thingName"], + "members":{ + "thingName":{ + "shape":"ThingName", + "location":"uri", + "locationName":"thingName" + } + } + }, + "DeleteThingShadowResponse":{ + "type":"structure", + "required":["payload"], + "members":{ + "payload":{"shape":"JsonDocument"} + }, + "payload":"payload" + }, + "ErrorMessage":{"type":"string"}, + "GetThingShadowRequest":{ + "type":"structure", + "required":["thingName"], + "members":{ + "thingName":{ + "shape":"ThingName", + "location":"uri", + "locationName":"thingName" + } + } + }, + "GetThingShadowResponse":{ + "type":"structure", + "members":{ + "payload":{"shape":"JsonDocument"} + }, + "payload":"payload" + }, + "InternalFailureException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + "InvalidRequestException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "JsonDocument":{"type":"blob"}, + "MethodNotAllowedException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "error":{"httpStatusCode":405}, + "exception":true + }, + "Payload":{"type":"blob"}, + "PublishRequest":{ + "type":"structure", + "required":["topic"], + "members":{ + "topic":{ + "shape":"Topic", + "location":"uri", + "locationName":"topic" + }, + "qos":{ + "shape":"Qos", + "location":"querystring", + "locationName":"qos" + }, + "payload":{"shape":"Payload"} + }, + "payload":"payload" + }, + "Qos":{ + "type":"integer", + "max":1, + "min":0 + }, + "RequestEntityTooLargeException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "error":{"httpStatusCode":413}, + "exception":true + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "error":{"httpStatusCode":404}, + "exception":true + }, + "ServiceUnavailableException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + "ThingName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[a-zA-Z0-9_-]+" + }, + "ThrottlingException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "error":{"httpStatusCode":429}, + "exception":true + }, + "Topic":{"type":"string"}, + "UnauthorizedException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "error":{"httpStatusCode":401}, + "exception":true + }, + "UnsupportedDocumentEncodingException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "error":{"httpStatusCode":415}, + "exception":true + }, + "UpdateThingShadowRequest":{ + "type":"structure", + "required":[ + "thingName", + "payload" + ], + "members":{ + "thingName":{ + "shape":"ThingName", + "location":"uri", + "locationName":"thingName" + }, + "payload":{"shape":"JsonDocument"} + }, + "payload":"payload" + }, + "UpdateThingShadowResponse":{ + "type":"structure", + "members":{ + "payload":{"shape":"JsonDocument"} + }, + "payload":"payload" + }, + "errorMessage":{"type":"string"} + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/iot-data/2015-05-28/docs-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/iot-data/2015-05-28/docs-2.json new file mode 100644 index 000000000..09e16dbd7 --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/iot-data/2015-05-28/docs-2.json @@ -0,0 +1,152 @@ +{ + "version": "2.0", + "service": "AWS IoT-Data enables secure, bi-directional communication between Internet-connected things (such as sensors, actuators, embedded devices, or smart appliances) and the AWS cloud. It implements a broker for applications and things to publish messages over HTTP (Publish) and retrieve, update, and delete thing shadows. A thing shadow is a persistent representation of your things and their state in the AWS cloud.
", + "operations": { + "DeleteThingShadow": "Deletes the thing shadow for the specified thing.
For more information, see DeleteThingShadow in the AWS IoT Developer Guide.
", + "GetThingShadow": "Gets the thing shadow for the specified thing.
For more information, see GetThingShadow in the AWS IoT Developer Guide.
", + "Publish": "Publishes state information.
For more information, see HTTP Protocol in the AWS IoT Developer Guide.
", + "UpdateThingShadow": "Updates the thing shadow for the specified thing.
For more information, see UpdateThingShadow in the AWS IoT Developer Guide.
" + }, + "shapes": { + "ConflictException": { + "base": "The specified version does not match the version of the document.
", + "refs": { + } + }, + "DeleteThingShadowRequest": { + "base": "The input for the DeleteThingShadow operation.
", + "refs": { + } + }, + "DeleteThingShadowResponse": { + "base": "The output from the DeleteThingShadow operation.
", + "refs": { + } + }, + "ErrorMessage": { + "base": null, + "refs": { + "ConflictException$message": "The message for the exception.
", + "MethodNotAllowedException$message": "The message for the exception.
", + "RequestEntityTooLargeException$message": "The message for the exception.
" + } + }, + "GetThingShadowRequest": { + "base": "The input for the GetThingShadow operation.
", + "refs": { + } + }, + "GetThingShadowResponse": { + "base": "The output from the GetThingShadow operation.
", + "refs": { + } + }, + "InternalFailureException": { + "base": "An unexpected error has occurred.
", + "refs": { + } + }, + "InvalidRequestException": { + "base": "The request is not valid.
", + "refs": { + } + }, + "JsonDocument": { + "base": null, + "refs": { + "DeleteThingShadowResponse$payload": "The state information, in JSON format.
", + "GetThingShadowResponse$payload": "The state information, in JSON format.
", + "UpdateThingShadowRequest$payload": "The state information, in JSON format.
", + "UpdateThingShadowResponse$payload": "The state information, in JSON format.
" + } + }, + "MethodNotAllowedException": { + "base": "The specified combination of HTTP verb and URI is not supported.
", + "refs": { + } + }, + "Payload": { + "base": null, + "refs": { + "PublishRequest$payload": "The state information, in JSON format.
" + } + }, + "PublishRequest": { + "base": "The input for the Publish operation.
", + "refs": { + } + }, + "Qos": { + "base": null, + "refs": { + "PublishRequest$qos": "The Quality of Service (QoS) level.
" + } + }, + "RequestEntityTooLargeException": { + "base": "The payload exceeds the maximum size allowed.
", + "refs": { + } + }, + "ResourceNotFoundException": { + "base": "The specified resource does not exist.
", + "refs": { + } + }, + "ServiceUnavailableException": { + "base": "The service is temporarily unavailable.
", + "refs": { + } + }, + "ThingName": { + "base": null, + "refs": { + "DeleteThingShadowRequest$thingName": "The name of the thing.
", + "GetThingShadowRequest$thingName": "The name of the thing.
", + "UpdateThingShadowRequest$thingName": "The name of the thing.
" + } + }, + "ThrottlingException": { + "base": "The rate exceeds the limit.
", + "refs": { + } + }, + "Topic": { + "base": null, + "refs": { + "PublishRequest$topic": "The name of the MQTT topic.
" + } + }, + "UnauthorizedException": { + "base": "You are not authorized to perform this operation.
", + "refs": { + } + }, + "UnsupportedDocumentEncodingException": { + "base": "The document encoding is not supported.
", + "refs": { + } + }, + "UpdateThingShadowRequest": { + "base": "The input for the UpdateThingShadow operation.
", + "refs": { + } + }, + "UpdateThingShadowResponse": { + "base": "The output from the UpdateThingShadow operation.
", + "refs": { + } + }, + "errorMessage": { + "base": null, + "refs": { + "InternalFailureException$message": "The message for the exception.
", + "InvalidRequestException$message": "The message for the exception.
", + "ResourceNotFoundException$message": "The message for the exception.
", + "ServiceUnavailableException$message": "The message for the exception.
", + "ThrottlingException$message": "The message for the exception.
", + "UnauthorizedException$message": "The message for the exception.
", + "UnsupportedDocumentEncodingException$message": "The message for the exception.
" + } + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/iot-data/2015-05-28/examples-1.json b/vendor/github.com/aws/aws-sdk-go/models/apis/iot-data/2015-05-28/examples-1.json new file mode 100644 index 000000000..0ea7e3b0b --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/iot-data/2015-05-28/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/iot/2015-05-28/api-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/iot/2015-05-28/api-2.json new file mode 100644 index 000000000..ad5172074 --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/iot/2015-05-28/api-2.json @@ -0,0 +1,3800 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2015-05-28", + "endpointPrefix":"iot", + "serviceFullName":"AWS IoT", + "signatureVersion":"v4", + "signingName":"execute-api", + "protocol":"rest-json" + }, + "operations":{ + "AcceptCertificateTransfer":{ + "name":"AcceptCertificateTransfer", + "http":{ + "method":"PATCH", + "requestUri":"/accept-certificate-transfer/{certificateId}" + }, + "input":{"shape":"AcceptCertificateTransferRequest"}, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"TransferAlreadyCompletedException", + "error":{"httpStatusCode":410}, + "exception":true + }, + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "AttachPrincipalPolicy":{ + "name":"AttachPrincipalPolicy", + "http":{ + "method":"PUT", + "requestUri":"/principal-policies/{policyName}" + }, + "input":{"shape":"AttachPrincipalPolicyRequest"}, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + { + "shape":"LimitExceededException", + "error":{"httpStatusCode":410}, + "exception":true + } + ] + }, + "AttachThingPrincipal":{ + "name":"AttachThingPrincipal", + "http":{ + "method":"PUT", + "requestUri":"/things/{thingName}/principals" + }, + "input":{"shape":"AttachThingPrincipalRequest"}, + "output":{"shape":"AttachThingPrincipalResponse"}, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "CancelCertificateTransfer":{ + "name":"CancelCertificateTransfer", + "http":{ + "method":"PATCH", + "requestUri":"/cancel-certificate-transfer/{certificateId}" + }, + "input":{"shape":"CancelCertificateTransferRequest"}, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"TransferAlreadyCompletedException", + "error":{"httpStatusCode":410}, + "exception":true + }, + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "CreateCertificateFromCsr":{ + "name":"CreateCertificateFromCsr", + "http":{ + "method":"POST", + "requestUri":"/certificates" + }, + "input":{"shape":"CreateCertificateFromCsrRequest"}, + "output":{"shape":"CreateCertificateFromCsrResponse"}, + "errors":[ + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "CreateKeysAndCertificate":{ + "name":"CreateKeysAndCertificate", + "http":{ + "method":"POST", + "requestUri":"/keys-and-certificate" + }, + "input":{"shape":"CreateKeysAndCertificateRequest"}, + "output":{"shape":"CreateKeysAndCertificateResponse"}, + "errors":[ + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "CreatePolicy":{ + "name":"CreatePolicy", + "http":{ + "method":"POST", + "requestUri":"/policies/{policyName}" + }, + "input":{"shape":"CreatePolicyRequest"}, + "output":{"shape":"CreatePolicyResponse"}, + "errors":[ + { + "shape":"ResourceAlreadyExistsException", + "error":{"httpStatusCode":409}, + "exception":true + }, + { + "shape":"MalformedPolicyException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "CreatePolicyVersion":{ + "name":"CreatePolicyVersion", + "http":{ + "method":"POST", + "requestUri":"/policies/{policyName}/version" + }, + "input":{"shape":"CreatePolicyVersionRequest"}, + "output":{"shape":"CreatePolicyVersionResponse"}, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"MalformedPolicyException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"VersionsLimitExceededException", + "error":{"httpStatusCode":409}, + "exception":true + }, + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "CreateThing":{ + "name":"CreateThing", + "http":{ + "method":"POST", + "requestUri":"/things/{thingName}" + }, + "input":{"shape":"CreateThingRequest"}, + "output":{"shape":"CreateThingResponse"}, + "errors":[ + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + { + "shape":"ResourceAlreadyExistsException", + "error":{"httpStatusCode":409}, + "exception":true + } + ] + }, + "CreateTopicRule":{ + "name":"CreateTopicRule", + "http":{ + "method":"POST", + "requestUri":"/rules/{ruleName}" + }, + "input":{"shape":"CreateTopicRuleRequest"}, + "errors":[ + { + "shape":"SqlParseException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InternalException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ResourceAlreadyExistsException", + "error":{"httpStatusCode":409}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + } + ] + }, + "DeleteCACertificate":{ + "name":"DeleteCACertificate", + "http":{ + "method":"DELETE", + "requestUri":"/cacertificate/{caCertificateId}" + }, + "input":{"shape":"DeleteCACertificateRequest"}, + "output":{"shape":"DeleteCACertificateResponse"}, + "errors":[ + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"CertificateStateException", + "error":{"httpStatusCode":406}, + "exception":true + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + } + ] + }, + "DeleteCertificate":{ + "name":"DeleteCertificate", + "http":{ + "method":"DELETE", + "requestUri":"/certificates/{certificateId}" + }, + "input":{"shape":"DeleteCertificateRequest"}, + "errors":[ + { + "shape":"CertificateStateException", + "error":{"httpStatusCode":406}, + "exception":true + }, + { + "shape":"DeleteConflictException", + "error":{"httpStatusCode":409}, + "exception":true + }, + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + } + ] + }, + "DeletePolicy":{ + "name":"DeletePolicy", + "http":{ + "method":"DELETE", + "requestUri":"/policies/{policyName}" + }, + "input":{"shape":"DeletePolicyRequest"}, + "errors":[ + { + "shape":"DeleteConflictException", + "error":{"httpStatusCode":409}, + "exception":true + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "DeletePolicyVersion":{ + "name":"DeletePolicyVersion", + "http":{ + "method":"DELETE", + "requestUri":"/policies/{policyName}/version/{policyVersionId}" + }, + "input":{"shape":"DeletePolicyVersionRequest"}, + "errors":[ + { + "shape":"DeleteConflictException", + "error":{"httpStatusCode":409}, + "exception":true + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "DeleteRegistrationCode":{ + "name":"DeleteRegistrationCode", + "http":{ + "method":"DELETE", + "requestUri":"/registrationcode" + }, + "input":{"shape":"DeleteRegistrationCodeRequest"}, + "output":{"shape":"DeleteRegistrationCodeResponse"}, + "errors":[ + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "DeleteThing":{ + "name":"DeleteThing", + "http":{ + "method":"DELETE", + "requestUri":"/things/{thingName}" + }, + "input":{"shape":"DeleteThingRequest"}, + "output":{"shape":"DeleteThingResponse"}, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "DeleteTopicRule":{ + "name":"DeleteTopicRule", + "http":{ + "method":"DELETE", + "requestUri":"/rules/{ruleName}" + }, + "input":{"shape":"DeleteTopicRuleRequest"}, + "errors":[ + { + "shape":"InternalException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + } + ] + }, + "DescribeCACertificate":{ + "name":"DescribeCACertificate", + "http":{ + "method":"GET", + "requestUri":"/cacertificate/{caCertificateId}" + }, + "input":{"shape":"DescribeCACertificateRequest"}, + "output":{"shape":"DescribeCACertificateResponse"}, + "errors":[ + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + } + ] + }, + "DescribeCertificate":{ + "name":"DescribeCertificate", + "http":{ + "method":"GET", + "requestUri":"/certificates/{certificateId}" + }, + "input":{"shape":"DescribeCertificateRequest"}, + "output":{"shape":"DescribeCertificateResponse"}, + "errors":[ + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + } + ] + }, + "DescribeEndpoint":{ + "name":"DescribeEndpoint", + "http":{ + "method":"GET", + "requestUri":"/endpoint" + }, + "input":{"shape":"DescribeEndpointRequest"}, + "output":{"shape":"DescribeEndpointResponse"}, + "errors":[ + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + } + ] + }, + "DescribeThing":{ + "name":"DescribeThing", + "http":{ + "method":"GET", + "requestUri":"/things/{thingName}" + }, + "input":{"shape":"DescribeThingRequest"}, + "output":{"shape":"DescribeThingResponse"}, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "DetachPrincipalPolicy":{ + "name":"DetachPrincipalPolicy", + "http":{ + "method":"DELETE", + "requestUri":"/principal-policies/{policyName}" + }, + "input":{"shape":"DetachPrincipalPolicyRequest"}, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "DetachThingPrincipal":{ + "name":"DetachThingPrincipal", + "http":{ + "method":"DELETE", + "requestUri":"/things/{thingName}/principals" + }, + "input":{"shape":"DetachThingPrincipalRequest"}, + "output":{"shape":"DetachThingPrincipalResponse"}, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "DisableTopicRule":{ + "name":"DisableTopicRule", + "http":{ + "method":"POST", + "requestUri":"/rules/{ruleName}/disable" + }, + "input":{"shape":"DisableTopicRuleRequest"}, + "errors":[ + { + "shape":"InternalException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + } + ] + }, + "EnableTopicRule":{ + "name":"EnableTopicRule", + "http":{ + "method":"POST", + "requestUri":"/rules/{ruleName}/enable" + }, + "input":{"shape":"EnableTopicRuleRequest"}, + "errors":[ + { + "shape":"InternalException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + } + ] + }, + "GetLoggingOptions":{ + "name":"GetLoggingOptions", + "http":{ + "method":"GET", + "requestUri":"/loggingOptions" + }, + "input":{"shape":"GetLoggingOptionsRequest"}, + "output":{"shape":"GetLoggingOptionsResponse"}, + "errors":[ + { + "shape":"InternalException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + } + ] + }, + "GetPolicy":{ + "name":"GetPolicy", + "http":{ + "method":"GET", + "requestUri":"/policies/{policyName}" + }, + "input":{"shape":"GetPolicyRequest"}, + "output":{"shape":"GetPolicyResponse"}, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "GetPolicyVersion":{ + "name":"GetPolicyVersion", + "http":{ + "method":"GET", + "requestUri":"/policies/{policyName}/version/{policyVersionId}" + }, + "input":{"shape":"GetPolicyVersionRequest"}, + "output":{"shape":"GetPolicyVersionResponse"}, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "GetRegistrationCode":{ + "name":"GetRegistrationCode", + "http":{ + "method":"GET", + "requestUri":"/registrationcode" + }, + "input":{"shape":"GetRegistrationCodeRequest"}, + "output":{"shape":"GetRegistrationCodeResponse"}, + "errors":[ + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + } + ] + }, + "GetTopicRule":{ + "name":"GetTopicRule", + "http":{ + "method":"GET", + "requestUri":"/rules/{ruleName}" + }, + "input":{"shape":"GetTopicRuleRequest"}, + "output":{"shape":"GetTopicRuleResponse"}, + "errors":[ + { + "shape":"InternalException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + } + ] + }, + "ListCACertificates":{ + "name":"ListCACertificates", + "http":{ + "method":"GET", + "requestUri":"/cacertificates" + }, + "input":{"shape":"ListCACertificatesRequest"}, + "output":{"shape":"ListCACertificatesResponse"}, + "errors":[ + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "ListCertificates":{ + "name":"ListCertificates", + "http":{ + "method":"GET", + "requestUri":"/certificates" + }, + "input":{"shape":"ListCertificatesRequest"}, + "output":{"shape":"ListCertificatesResponse"}, + "errors":[ + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "ListCertificatesByCA":{ + "name":"ListCertificatesByCA", + "http":{ + "method":"GET", + "requestUri":"/certificates-by-ca/{caCertificateId}" + }, + "input":{"shape":"ListCertificatesByCARequest"}, + "output":{"shape":"ListCertificatesByCAResponse"}, + "errors":[ + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "ListPolicies":{ + "name":"ListPolicies", + "http":{ + "method":"GET", + "requestUri":"/policies" + }, + "input":{"shape":"ListPoliciesRequest"}, + "output":{"shape":"ListPoliciesResponse"}, + "errors":[ + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "ListPolicyPrincipals":{ + "name":"ListPolicyPrincipals", + "http":{ + "method":"GET", + "requestUri":"/policy-principals" + }, + "input":{"shape":"ListPolicyPrincipalsRequest"}, + "output":{"shape":"ListPolicyPrincipalsResponse"}, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "ListPolicyVersions":{ + "name":"ListPolicyVersions", + "http":{ + "method":"GET", + "requestUri":"/policies/{policyName}/version" + }, + "input":{"shape":"ListPolicyVersionsRequest"}, + "output":{"shape":"ListPolicyVersionsResponse"}, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "ListPrincipalPolicies":{ + "name":"ListPrincipalPolicies", + "http":{ + "method":"GET", + "requestUri":"/principal-policies" + }, + "input":{"shape":"ListPrincipalPoliciesRequest"}, + "output":{"shape":"ListPrincipalPoliciesResponse"}, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "ListPrincipalThings":{ + "name":"ListPrincipalThings", + "http":{ + "method":"GET", + "requestUri":"/principals/things" + }, + "input":{"shape":"ListPrincipalThingsRequest"}, + "output":{"shape":"ListPrincipalThingsResponse"}, + "errors":[ + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "ListThingPrincipals":{ + "name":"ListThingPrincipals", + "http":{ + "method":"GET", + "requestUri":"/things/{thingName}/principals" + }, + "input":{"shape":"ListThingPrincipalsRequest"}, + "output":{"shape":"ListThingPrincipalsResponse"}, + "errors":[ + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "ListThings":{ + "name":"ListThings", + "http":{ + "method":"GET", + "requestUri":"/things" + }, + "input":{"shape":"ListThingsRequest"}, + "output":{"shape":"ListThingsResponse"}, + "errors":[ + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "ListTopicRules":{ + "name":"ListTopicRules", + "http":{ + "method":"GET", + "requestUri":"/rules" + }, + "input":{"shape":"ListTopicRulesRequest"}, + "output":{"shape":"ListTopicRulesResponse"}, + "errors":[ + { + "shape":"InternalException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + } + ] + }, + "RegisterCACertificate":{ + "name":"RegisterCACertificate", + "http":{ + "method":"POST", + "requestUri":"/cacertificate" + }, + "input":{"shape":"RegisterCACertificateRequest"}, + "output":{"shape":"RegisterCACertificateResponse"}, + "errors":[ + { + "shape":"ResourceAlreadyExistsException", + "error":{"httpStatusCode":409}, + "exception":true + }, + { + "shape":"RegistrationCodeValidationException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"CertificateValidationException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"LimitExceededException", + "error":{"httpStatusCode":410}, + "exception":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "RegisterCertificate":{ + "name":"RegisterCertificate", + "http":{ + "method":"POST", + "requestUri":"/certificate/register" + }, + "input":{"shape":"RegisterCertificateRequest"}, + "output":{"shape":"RegisterCertificateResponse"}, + "errors":[ + { + "shape":"ResourceAlreadyExistsException", + "error":{"httpStatusCode":409}, + "exception":true + }, + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"CertificateValidationException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"CertificateStateException", + "error":{"httpStatusCode":406}, + "exception":true + }, + { + "shape":"CertificateConflictException", + "error":{"httpStatusCode":409}, + "exception":true + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "RejectCertificateTransfer":{ + "name":"RejectCertificateTransfer", + "http":{ + "method":"PATCH", + "requestUri":"/reject-certificate-transfer/{certificateId}" + }, + "input":{"shape":"RejectCertificateTransferRequest"}, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"TransferAlreadyCompletedException", + "error":{"httpStatusCode":410}, + "exception":true + }, + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "ReplaceTopicRule":{ + "name":"ReplaceTopicRule", + "http":{ + "method":"PATCH", + "requestUri":"/rules/{ruleName}" + }, + "input":{"shape":"ReplaceTopicRuleRequest"}, + "errors":[ + { + "shape":"SqlParseException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InternalException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + } + ] + }, + "SetDefaultPolicyVersion":{ + "name":"SetDefaultPolicyVersion", + "http":{ + "method":"PATCH", + "requestUri":"/policies/{policyName}/version/{policyVersionId}" + }, + "input":{"shape":"SetDefaultPolicyVersionRequest"}, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "SetLoggingOptions":{ + "name":"SetLoggingOptions", + "http":{ + "method":"POST", + "requestUri":"/loggingOptions" + }, + "input":{"shape":"SetLoggingOptionsRequest"}, + "errors":[ + { + "shape":"InternalException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + } + ] + }, + "TransferCertificate":{ + "name":"TransferCertificate", + "http":{ + "method":"PATCH", + "requestUri":"/transfer-certificate/{certificateId}" + }, + "input":{"shape":"TransferCertificateRequest"}, + "output":{"shape":"TransferCertificateResponse"}, + "errors":[ + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"CertificateStateException", + "error":{"httpStatusCode":406}, + "exception":true + }, + { + "shape":"TransferConflictException", + "error":{"httpStatusCode":409}, + "exception":true + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "UpdateCACertificate":{ + "name":"UpdateCACertificate", + "http":{ + "method":"PUT", + "requestUri":"/cacertificate/{caCertificateId}" + }, + "input":{"shape":"UpdateCACertificateRequest"}, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "UpdateCertificate":{ + "name":"UpdateCertificate", + "http":{ + "method":"PUT", + "requestUri":"/certificates/{certificateId}" + }, + "input":{"shape":"UpdateCertificateRequest"}, + "errors":[ + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"CertificateStateException", + "error":{"httpStatusCode":406}, + "exception":true + }, + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "UpdateThing":{ + "name":"UpdateThing", + "http":{ + "method":"PATCH", + "requestUri":"/things/{thingName}" + }, + "input":{"shape":"UpdateThingRequest"}, + "output":{"shape":"UpdateThingResponse"}, + "errors":[ + { + "shape":"InvalidRequestException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ThrottlingException", + "error":{"httpStatusCode":429}, + "exception":true + }, + { + "shape":"UnauthorizedException", + "error":{"httpStatusCode":401}, + "exception":true + }, + { + "shape":"ServiceUnavailableException", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + { + "shape":"InternalFailureException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + } + ] + } + }, + "shapes":{ + "AcceptCertificateTransferRequest":{ + "type":"structure", + "required":["certificateId"], + "members":{ + "certificateId":{ + "shape":"CertificateId", + "location":"uri", + "locationName":"certificateId" + }, + "setAsActive":{ + "shape":"SetAsActive", + "location":"querystring", + "locationName":"setAsActive" + } + } + }, + "Action":{ + "type":"structure", + "members":{ + "dynamoDB":{"shape":"DynamoDBAction"}, + "lambda":{"shape":"LambdaAction"}, + "sns":{"shape":"SnsAction"}, + "sqs":{"shape":"SqsAction"}, + "kinesis":{"shape":"KinesisAction"}, + "republish":{"shape":"RepublishAction"}, + "s3":{"shape":"S3Action"}, + "firehose":{"shape":"FirehoseAction"}, + "cloudwatchMetric":{"shape":"CloudwatchMetricAction"}, + "cloudwatchAlarm":{"shape":"CloudwatchAlarmAction"}, + "elasticsearch":{"shape":"ElasticsearchAction"} + } + }, + "ActionList":{ + "type":"list", + "member":{"shape":"Action"}, + "min":0, + "max":10 + }, + "AlarmName":{"type":"string"}, + "AscendingOrder":{"type":"boolean"}, + "AttachPrincipalPolicyRequest":{ + "type":"structure", + "required":[ + "policyName", + "principal" + ], + "members":{ + "policyName":{ + "shape":"PolicyName", + "location":"uri", + "locationName":"policyName" + }, + "principal":{ + "shape":"Principal", + "location":"header", + "locationName":"x-amzn-iot-principal" + } + } + }, + "AttachThingPrincipalRequest":{ + "type":"structure", + "required":[ + "thingName", + "principal" + ], + "members":{ + "thingName":{ + "shape":"ThingName", + "location":"uri", + "locationName":"thingName" + }, + "principal":{ + "shape":"Principal", + "location":"header", + "locationName":"x-amzn-principal" + } + } + }, + "AttachThingPrincipalResponse":{ + "type":"structure", + "members":{ + } + }, + "AttributeName":{ + "type":"string", + "max":128, + "pattern":"[a-zA-Z0-9_.,@/:#-]+" + }, + "AttributePayload":{ + "type":"structure", + "members":{ + "attributes":{"shape":"Attributes"} + } + }, + "AttributeValue":{ + "type":"string", + "max":1024, + "pattern":"[a-zA-Z0-9_.,@/:#-]+" + }, + "Attributes":{ + "type":"map", + "key":{"shape":"AttributeName"}, + "value":{"shape":"AttributeValue"} + }, + "AwsAccountId":{ + "type":"string", + "pattern":"[0-9]{12}" + }, + "AwsArn":{"type":"string"}, + "AwsIotSqlVersion":{"type":"string"}, + "BucketName":{"type":"string"}, + "CACertificate":{ + "type":"structure", + "members":{ + "certificateArn":{"shape":"CertificateArn"}, + "certificateId":{"shape":"CertificateId"}, + "status":{"shape":"CACertificateStatus"}, + "creationDate":{"shape":"DateType"} + } + }, + "CACertificateDescription":{ + "type":"structure", + "members":{ + "certificateArn":{"shape":"CertificateArn"}, + "certificateId":{"shape":"CertificateId"}, + "status":{"shape":"CACertificateStatus"}, + "certificatePem":{"shape":"CertificatePem"}, + "ownedBy":{"shape":"AwsAccountId"}, + "creationDate":{"shape":"DateType"} + } + }, + "CACertificateStatus":{ + "type":"string", + "enum":[ + "ACTIVE", + "INACTIVE" + ] + }, + "CACertificates":{ + "type":"list", + "member":{"shape":"CACertificate"} + }, + "CancelCertificateTransferRequest":{ + "type":"structure", + "required":["certificateId"], + "members":{ + "certificateId":{ + "shape":"CertificateId", + "location":"uri", + "locationName":"certificateId" + } + } + }, + "Certificate":{ + "type":"structure", + "members":{ + "certificateArn":{"shape":"CertificateArn"}, + "certificateId":{"shape":"CertificateId"}, + "status":{"shape":"CertificateStatus"}, + "creationDate":{"shape":"DateType"} + } + }, + "CertificateArn":{"type":"string"}, + "CertificateConflictException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "CertificateDescription":{ + "type":"structure", + "members":{ + "certificateArn":{"shape":"CertificateArn"}, + "certificateId":{"shape":"CertificateId"}, + "caCertificateId":{"shape":"CertificateId"}, + "status":{"shape":"CertificateStatus"}, + "certificatePem":{"shape":"CertificatePem"}, + "ownedBy":{"shape":"AwsAccountId"}, + "previousOwnedBy":{"shape":"AwsAccountId"}, + "creationDate":{"shape":"DateType"}, + "lastModifiedDate":{"shape":"DateType"}, + "transferData":{"shape":"TransferData"} + } + }, + "CertificateId":{ + "type":"string", + "min":64, + "max":64, + "pattern":"(0x)?[a-fA-F0-9]+" + }, + "CertificatePem":{ + "type":"string", + "min":1, + "max":65536 + }, + "CertificateSigningRequest":{ + "type":"string", + "min":1 + }, + "CertificateStateException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "error":{"httpStatusCode":406}, + "exception":true + }, + "CertificateStatus":{ + "type":"string", + "enum":[ + "ACTIVE", + "INACTIVE", + "REVOKED", + "PENDING_TRANSFER", + "REGISTER_INACTIVE" + ] + }, + "CertificateValidationException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "Certificates":{ + "type":"list", + "member":{"shape":"Certificate"} + }, + "ClientId":{"type":"string"}, + "CloudwatchAlarmAction":{ + "type":"structure", + "required":[ + "roleArn", + "alarmName", + "stateReason", + "stateValue" + ], + "members":{ + "roleArn":{"shape":"AwsArn"}, + "alarmName":{"shape":"AlarmName"}, + "stateReason":{"shape":"StateReason"}, + "stateValue":{"shape":"StateValue"} + } + }, + "CloudwatchMetricAction":{ + "type":"structure", + "required":[ + "roleArn", + "metricNamespace", + "metricName", + "metricValue", + "metricUnit" + ], + "members":{ + "roleArn":{"shape":"AwsArn"}, + "metricNamespace":{"shape":"MetricNamespace"}, + "metricName":{"shape":"MetricName"}, + "metricValue":{"shape":"MetricValue"}, + "metricUnit":{"shape":"MetricUnit"}, + "metricTimestamp":{"shape":"MetricTimestamp"} + } + }, + "CreateCertificateFromCsrRequest":{ + "type":"structure", + "required":["certificateSigningRequest"], + "members":{ + "certificateSigningRequest":{"shape":"CertificateSigningRequest"}, + "setAsActive":{ + "shape":"SetAsActive", + "location":"querystring", + "locationName":"setAsActive" + } + } + }, + "CreateCertificateFromCsrResponse":{ + "type":"structure", + "members":{ + "certificateArn":{"shape":"CertificateArn"}, + "certificateId":{"shape":"CertificateId"}, + "certificatePem":{"shape":"CertificatePem"} + } + }, + "CreateKeysAndCertificateRequest":{ + "type":"structure", + "members":{ + "setAsActive":{ + "shape":"SetAsActive", + "location":"querystring", + "locationName":"setAsActive" + } + } + }, + "CreateKeysAndCertificateResponse":{ + "type":"structure", + "members":{ + "certificateArn":{"shape":"CertificateArn"}, + "certificateId":{"shape":"CertificateId"}, + "certificatePem":{"shape":"CertificatePem"}, + "keyPair":{"shape":"KeyPair"} + } + }, + "CreatePolicyRequest":{ + "type":"structure", + "required":[ + "policyName", + "policyDocument" + ], + "members":{ + "policyName":{ + "shape":"PolicyName", + "location":"uri", + "locationName":"policyName" + }, + "policyDocument":{"shape":"PolicyDocument"} + } + }, + "CreatePolicyResponse":{ + "type":"structure", + "members":{ + "policyName":{"shape":"PolicyName"}, + "policyArn":{"shape":"PolicyArn"}, + "policyDocument":{"shape":"PolicyDocument"}, + "policyVersionId":{"shape":"PolicyVersionId"} + } + }, + "CreatePolicyVersionRequest":{ + "type":"structure", + "required":[ + "policyName", + "policyDocument" + ], + "members":{ + "policyName":{ + "shape":"PolicyName", + "location":"uri", + "locationName":"policyName" + }, + "policyDocument":{"shape":"PolicyDocument"}, + "setAsDefault":{ + "shape":"SetAsDefault", + "location":"querystring", + "locationName":"setAsDefault" + } + } + }, + "CreatePolicyVersionResponse":{ + "type":"structure", + "members":{ + "policyArn":{"shape":"PolicyArn"}, + "policyDocument":{"shape":"PolicyDocument"}, + "policyVersionId":{"shape":"PolicyVersionId"}, + "isDefaultVersion":{"shape":"IsDefaultVersion"} + } + }, + "CreateThingRequest":{ + "type":"structure", + "required":["thingName"], + "members":{ + "thingName":{ + "shape":"ThingName", + "location":"uri", + "locationName":"thingName" + }, + "attributePayload":{"shape":"AttributePayload"} + } + }, + "CreateThingResponse":{ + "type":"structure", + "members":{ + "thingName":{"shape":"ThingName"}, + "thingArn":{"shape":"ThingArn"} + } + }, + "CreateTopicRuleRequest":{ + "type":"structure", + "required":[ + "ruleName", + "topicRulePayload" + ], + "members":{ + "ruleName":{ + "shape":"RuleName", + "location":"uri", + "locationName":"ruleName" + }, + "topicRulePayload":{"shape":"TopicRulePayload"} + }, + "payload":"topicRulePayload" + }, + "CreatedAtDate":{"type":"timestamp"}, + "DateType":{"type":"timestamp"}, + "DeleteCACertificateRequest":{ + "type":"structure", + "required":["certificateId"], + "members":{ + "certificateId":{ + "shape":"CertificateId", + "location":"uri", + "locationName":"caCertificateId" + } + } + }, + "DeleteCACertificateResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteCertificateRequest":{ + "type":"structure", + "required":["certificateId"], + "members":{ + "certificateId":{ + "shape":"CertificateId", + "location":"uri", + "locationName":"certificateId" + } + } + }, + "DeleteConflictException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "DeletePolicyRequest":{ + "type":"structure", + "required":["policyName"], + "members":{ + "policyName":{ + "shape":"PolicyName", + "location":"uri", + "locationName":"policyName" + } + } + }, + "DeletePolicyVersionRequest":{ + "type":"structure", + "required":[ + "policyName", + "policyVersionId" + ], + "members":{ + "policyName":{ + "shape":"PolicyName", + "location":"uri", + "locationName":"policyName" + }, + "policyVersionId":{ + "shape":"PolicyVersionId", + "location":"uri", + "locationName":"policyVersionId" + } + } + }, + "DeleteRegistrationCodeRequest":{ + "type":"structure", + "members":{ + } + }, + "DeleteRegistrationCodeResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteThingRequest":{ + "type":"structure", + "required":["thingName"], + "members":{ + "thingName":{ + "shape":"ThingName", + "location":"uri", + "locationName":"thingName" + } + } + }, + "DeleteThingResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteTopicRuleRequest":{ + "type":"structure", + "members":{ + "ruleName":{ + "shape":"RuleName", + "location":"uri", + "locationName":"ruleName" + } + }, + "required":["ruleName"] + }, + "DeliveryStreamName":{"type":"string"}, + "DescribeCACertificateRequest":{ + "type":"structure", + "required":["certificateId"], + "members":{ + "certificateId":{ + "shape":"CertificateId", + "location":"uri", + "locationName":"caCertificateId" + } + } + }, + "DescribeCACertificateResponse":{ + "type":"structure", + "members":{ + "certificateDescription":{"shape":"CACertificateDescription"} + } + }, + "DescribeCertificateRequest":{ + "type":"structure", + "required":["certificateId"], + "members":{ + "certificateId":{ + "shape":"CertificateId", + "location":"uri", + "locationName":"certificateId" + } + } + }, + "DescribeCertificateResponse":{ + "type":"structure", + "members":{ + "certificateDescription":{"shape":"CertificateDescription"} + } + }, + "DescribeEndpointRequest":{ + "type":"structure", + "members":{ + } + }, + "DescribeEndpointResponse":{ + "type":"structure", + "members":{ + "endpointAddress":{"shape":"EndpointAddress"} + } + }, + "DescribeThingRequest":{ + "type":"structure", + "required":["thingName"], + "members":{ + "thingName":{ + "shape":"ThingName", + "location":"uri", + "locationName":"thingName" + } + } + }, + "DescribeThingResponse":{ + "type":"structure", + "members":{ + "defaultClientId":{"shape":"ClientId"}, + "thingName":{"shape":"ThingName"}, + "attributes":{"shape":"Attributes"} + } + }, + "Description":{"type":"string"}, + "DetachPrincipalPolicyRequest":{ + "type":"structure", + "required":[ + "policyName", + "principal" + ], + "members":{ + "policyName":{ + "shape":"PolicyName", + "location":"uri", + "locationName":"policyName" + }, + "principal":{ + "shape":"Principal", + "location":"header", + "locationName":"x-amzn-iot-principal" + } + } + }, + "DetachThingPrincipalRequest":{ + "type":"structure", + "required":[ + "thingName", + "principal" + ], + "members":{ + "thingName":{ + "shape":"ThingName", + "location":"uri", + "locationName":"thingName" + }, + "principal":{ + "shape":"Principal", + "location":"header", + "locationName":"x-amzn-principal" + } + } + }, + "DetachThingPrincipalResponse":{ + "type":"structure", + "members":{ + } + }, + "DisableTopicRuleRequest":{ + "type":"structure", + "required":["ruleName"], + "members":{ + "ruleName":{ + "shape":"RuleName", + "location":"uri", + "locationName":"ruleName" + } + } + }, + "DynamoDBAction":{ + "type":"structure", + "required":[ + "tableName", + "roleArn", + "hashKeyField", + "hashKeyValue" + ], + "members":{ + "tableName":{"shape":"TableName"}, + "roleArn":{"shape":"AwsArn"}, + "operation":{"shape":"DynamoOperation"}, + "hashKeyField":{"shape":"HashKeyField"}, + "hashKeyValue":{"shape":"HashKeyValue"}, + "hashKeyType":{"shape":"DynamoKeyType"}, + "rangeKeyField":{"shape":"RangeKeyField"}, + "rangeKeyValue":{"shape":"RangeKeyValue"}, + "rangeKeyType":{"shape":"DynamoKeyType"}, + "payloadField":{"shape":"PayloadField"} + } + }, + "DynamoKeyType":{ + "type":"string", + "enum":[ + "STRING", + "NUMBER" + ] + }, + "DynamoOperation":{"type":"string"}, + "ElasticsearchAction":{ + "type":"structure", + "required":[ + "roleArn", + "endpoint", + "index", + "type", + "id" + ], + "members":{ + "roleArn":{"shape":"AwsArn"}, + "endpoint":{"shape":"ElasticsearchEndpoint"}, + "index":{"shape":"ElasticsearchIndex"}, + "type":{"shape":"ElasticsearchType"}, + "id":{"shape":"ElasticsearchId"} + } + }, + "ElasticsearchEndpoint":{ + "type":"string", + "pattern":"https?://.*" + }, + "ElasticsearchId":{"type":"string"}, + "ElasticsearchIndex":{"type":"string"}, + "ElasticsearchType":{"type":"string"}, + "EnableTopicRuleRequest":{ + "type":"structure", + "required":["ruleName"], + "members":{ + "ruleName":{ + "shape":"RuleName", + "location":"uri", + "locationName":"ruleName" + } + } + }, + "EndpointAddress":{"type":"string"}, + "FirehoseAction":{ + "type":"structure", + "required":[ + "roleArn", + "deliveryStreamName" + ], + "members":{ + "roleArn":{"shape":"AwsArn"}, + "deliveryStreamName":{"shape":"DeliveryStreamName"} + } + }, + "FunctionArn":{"type":"string"}, + "GetLoggingOptionsRequest":{ + "type":"structure", + "members":{ + } + }, + "GetLoggingOptionsResponse":{ + "type":"structure", + "members":{ + "roleArn":{"shape":"AwsArn"}, + "logLevel":{"shape":"LogLevel"} + } + }, + "GetPolicyRequest":{ + "type":"structure", + "required":["policyName"], + "members":{ + "policyName":{ + "shape":"PolicyName", + "location":"uri", + "locationName":"policyName" + } + } + }, + "GetPolicyResponse":{ + "type":"structure", + "members":{ + "policyName":{"shape":"PolicyName"}, + "policyArn":{"shape":"PolicyArn"}, + "policyDocument":{"shape":"PolicyDocument"}, + "defaultVersionId":{"shape":"PolicyVersionId"} + } + }, + "GetPolicyVersionRequest":{ + "type":"structure", + "required":[ + "policyName", + "policyVersionId" + ], + "members":{ + "policyName":{ + "shape":"PolicyName", + "location":"uri", + "locationName":"policyName" + }, + "policyVersionId":{ + "shape":"PolicyVersionId", + "location":"uri", + "locationName":"policyVersionId" + } + } + }, + "GetPolicyVersionResponse":{ + "type":"structure", + "members":{ + "policyArn":{"shape":"PolicyArn"}, + "policyName":{"shape":"PolicyName"}, + "policyDocument":{"shape":"PolicyDocument"}, + "policyVersionId":{"shape":"PolicyVersionId"}, + "isDefaultVersion":{"shape":"IsDefaultVersion"} + } + }, + "GetRegistrationCodeRequest":{ + "type":"structure", + "members":{ + } + }, + "GetRegistrationCodeResponse":{ + "type":"structure", + "members":{ + "registrationCode":{"shape":"RegistrationCode"} + } + }, + "GetTopicRuleRequest":{ + "type":"structure", + "required":["ruleName"], + "members":{ + "ruleName":{ + "shape":"RuleName", + "location":"uri", + "locationName":"ruleName" + } + } + }, + "GetTopicRuleResponse":{ + "type":"structure", + "members":{ + "ruleArn":{"shape":"RuleArn"}, + "rule":{"shape":"TopicRule"} + } + }, + "HashKeyField":{"type":"string"}, + "HashKeyValue":{"type":"string"}, + "InternalException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + "InternalFailureException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + "InvalidRequestException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "IsDefaultVersion":{"type":"boolean"}, + "IsDisabled":{"type":"boolean"}, + "Key":{"type":"string"}, + "KeyPair":{ + "type":"structure", + "members":{ + "PublicKey":{"shape":"PublicKey"}, + "PrivateKey":{"shape":"PrivateKey"} + } + }, + "KinesisAction":{ + "type":"structure", + "required":[ + "roleArn", + "streamName" + ], + "members":{ + "roleArn":{"shape":"AwsArn"}, + "streamName":{"shape":"StreamName"}, + "partitionKey":{"shape":"PartitionKey"} + } + }, + "LambdaAction":{ + "type":"structure", + "required":["functionArn"], + "members":{ + "functionArn":{"shape":"FunctionArn"} + } + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "error":{"httpStatusCode":410}, + "exception":true + }, + "ListCACertificatesRequest":{ + "type":"structure", + "members":{ + "pageSize":{ + "shape":"PageSize", + "location":"querystring", + "locationName":"pageSize" + }, + "marker":{ + "shape":"Marker", + "location":"querystring", + "locationName":"marker" + }, + "ascendingOrder":{ + "shape":"AscendingOrder", + "location":"querystring", + "locationName":"isAscendingOrder" + } + } + }, + "ListCACertificatesResponse":{ + "type":"structure", + "members":{ + "certificates":{"shape":"CACertificates"}, + "nextMarker":{"shape":"Marker"} + } + }, + "ListCertificatesByCARequest":{ + "type":"structure", + "required":["caCertificateId"], + "members":{ + "caCertificateId":{ + "shape":"CertificateId", + "location":"uri", + "locationName":"caCertificateId" + }, + "pageSize":{ + "shape":"PageSize", + "location":"querystring", + "locationName":"pageSize" + }, + "marker":{ + "shape":"Marker", + "location":"querystring", + "locationName":"marker" + }, + "ascendingOrder":{ + "shape":"AscendingOrder", + "location":"querystring", + "locationName":"isAscendingOrder" + } + } + }, + "ListCertificatesByCAResponse":{ + "type":"structure", + "members":{ + "certificates":{"shape":"Certificates"}, + "nextMarker":{"shape":"Marker"} + } + }, + "ListCertificatesRequest":{ + "type":"structure", + "members":{ + "pageSize":{ + "shape":"PageSize", + "location":"querystring", + "locationName":"pageSize" + }, + "marker":{ + "shape":"Marker", + "location":"querystring", + "locationName":"marker" + }, + "ascendingOrder":{ + "shape":"AscendingOrder", + "location":"querystring", + "locationName":"isAscendingOrder" + } + } + }, + "ListCertificatesResponse":{ + "type":"structure", + "members":{ + "certificates":{"shape":"Certificates"}, + "nextMarker":{"shape":"Marker"} + } + }, + "ListPoliciesRequest":{ + "type":"structure", + "members":{ + "marker":{ + "shape":"Marker", + "location":"querystring", + "locationName":"marker" + }, + "pageSize":{ + "shape":"PageSize", + "location":"querystring", + "locationName":"pageSize" + }, + "ascendingOrder":{ + "shape":"AscendingOrder", + "location":"querystring", + "locationName":"isAscendingOrder" + } + } + }, + "ListPoliciesResponse":{ + "type":"structure", + "members":{ + "policies":{"shape":"Policies"}, + "nextMarker":{"shape":"Marker"} + } + }, + "ListPolicyPrincipalsRequest":{ + "type":"structure", + "required":["policyName"], + "members":{ + "policyName":{ + "shape":"PolicyName", + "location":"header", + "locationName":"x-amzn-iot-policy" + }, + "marker":{ + "shape":"Marker", + "location":"querystring", + "locationName":"marker" + }, + "pageSize":{ + "shape":"PageSize", + "location":"querystring", + "locationName":"pageSize" + }, + "ascendingOrder":{ + "shape":"AscendingOrder", + "location":"querystring", + "locationName":"isAscendingOrder" + } + } + }, + "ListPolicyPrincipalsResponse":{ + "type":"structure", + "members":{ + "principals":{"shape":"Principals"}, + "nextMarker":{"shape":"Marker"} + } + }, + "ListPolicyVersionsRequest":{ + "type":"structure", + "required":["policyName"], + "members":{ + "policyName":{ + "shape":"PolicyName", + "location":"uri", + "locationName":"policyName" + } + } + }, + "ListPolicyVersionsResponse":{ + "type":"structure", + "members":{ + "policyVersions":{"shape":"PolicyVersions"} + } + }, + "ListPrincipalPoliciesRequest":{ + "type":"structure", + "required":["principal"], + "members":{ + "principal":{ + "shape":"Principal", + "location":"header", + "locationName":"x-amzn-iot-principal" + }, + "marker":{ + "shape":"Marker", + "location":"querystring", + "locationName":"marker" + }, + "pageSize":{ + "shape":"PageSize", + "location":"querystring", + "locationName":"pageSize" + }, + "ascendingOrder":{ + "shape":"AscendingOrder", + "location":"querystring", + "locationName":"isAscendingOrder" + } + } + }, + "ListPrincipalPoliciesResponse":{ + "type":"structure", + "members":{ + "policies":{"shape":"Policies"}, + "nextMarker":{"shape":"Marker"} + } + }, + "ListPrincipalThingsRequest":{ + "type":"structure", + "required":["principal"], + "members":{ + "nextToken":{ + "shape":"NextToken", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "location":"querystring", + "locationName":"maxResults" + }, + "principal":{ + "shape":"Principal", + "location":"header", + "locationName":"x-amzn-principal" + } + } + }, + "ListPrincipalThingsResponse":{ + "type":"structure", + "members":{ + "things":{"shape":"ThingNameList"}, + "nextToken":{"shape":"NextToken"} + } + }, + "ListThingPrincipalsRequest":{ + "type":"structure", + "required":["thingName"], + "members":{ + "thingName":{ + "shape":"ThingName", + "location":"uri", + "locationName":"thingName" + } + } + }, + "ListThingPrincipalsResponse":{ + "type":"structure", + "members":{ + "principals":{"shape":"Principals"} + } + }, + "ListThingsRequest":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"NextToken", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "location":"querystring", + "locationName":"maxResults" + }, + "attributeName":{ + "shape":"AttributeName", + "location":"querystring", + "locationName":"attributeName" + }, + "attributeValue":{ + "shape":"AttributeValue", + "location":"querystring", + "locationName":"attributeValue" + } + } + }, + "ListThingsResponse":{ + "type":"structure", + "members":{ + "things":{"shape":"ThingAttributeList"}, + "nextToken":{"shape":"NextToken"} + } + }, + "ListTopicRulesRequest":{ + "type":"structure", + "members":{ + "topic":{ + "shape":"Topic", + "location":"querystring", + "locationName":"topic" + }, + "maxResults":{ + "shape":"MaxResults", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "location":"querystring", + "locationName":"nextToken" + }, + "ruleDisabled":{ + "shape":"IsDisabled", + "location":"querystring", + "locationName":"ruleDisabled" + } + } + }, + "ListTopicRulesResponse":{ + "type":"structure", + "members":{ + "rules":{"shape":"TopicRuleList"}, + "nextToken":{"shape":"NextToken"} + } + }, + "LogLevel":{ + "type":"string", + "enum":[ + "DEBUG", + "INFO", + "ERROR", + "WARN", + "DISABLED" + ] + }, + "LoggingOptionsPayload":{ + "type":"structure", + "required":["roleArn"], + "members":{ + "roleArn":{"shape":"AwsArn"}, + "logLevel":{"shape":"LogLevel"} + } + }, + "MalformedPolicyException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "Marker":{"type":"string"}, + "MaxResults":{ + "type":"integer", + "min":1, + "max":10000 + }, + "Message":{ + "type":"string", + "max":128 + }, + "MessageFormat":{ + "type":"string", + "enum":[ + "RAW", + "JSON" + ] + }, + "MetricName":{"type":"string"}, + "MetricNamespace":{"type":"string"}, + "MetricTimestamp":{"type":"string"}, + "MetricUnit":{"type":"string"}, + "MetricValue":{"type":"string"}, + "NextToken":{"type":"string"}, + "PageSize":{ + "type":"integer", + "min":1, + "max":250 + }, + "PartitionKey":{"type":"string"}, + "PayloadField":{"type":"string"}, + "Policies":{ + "type":"list", + "member":{"shape":"Policy"} + }, + "Policy":{ + "type":"structure", + "members":{ + "policyName":{"shape":"PolicyName"}, + "policyArn":{"shape":"PolicyArn"} + } + }, + "PolicyArn":{"type":"string"}, + "PolicyDocument":{"type":"string"}, + "PolicyName":{ + "type":"string", + "min":1, + "max":128, + "pattern":"[\\w+=,.@-]+" + }, + "PolicyVersion":{ + "type":"structure", + "members":{ + "versionId":{"shape":"PolicyVersionId"}, + "isDefaultVersion":{"shape":"IsDefaultVersion"}, + "createDate":{"shape":"DateType"} + } + }, + "PolicyVersionId":{ + "type":"string", + "pattern":"[0-9]+" + }, + "PolicyVersions":{ + "type":"list", + "member":{"shape":"PolicyVersion"} + }, + "Principal":{"type":"string"}, + "PrincipalArn":{"type":"string"}, + "Principals":{ + "type":"list", + "member":{"shape":"PrincipalArn"} + }, + "PrivateKey":{ + "type":"string", + "min":1, + "sensitive":true + }, + "PublicKey":{ + "type":"string", + "min":1 + }, + "QueueUrl":{"type":"string"}, + "RangeKeyField":{"type":"string"}, + "RangeKeyValue":{"type":"string"}, + "RegisterCACertificateRequest":{ + "type":"structure", + "required":[ + "caCertificate", + "verificationCertificate" + ], + "members":{ + "caCertificate":{"shape":"CertificatePem"}, + "verificationCertificate":{"shape":"CertificatePem"}, + "setAsActive":{ + "shape":"SetAsActive", + "location":"querystring", + "locationName":"setAsActive" + } + } + }, + "RegisterCACertificateResponse":{ + "type":"structure", + "members":{ + "certificateArn":{"shape":"CertificateArn"}, + "certificateId":{"shape":"CertificateId"} + } + }, + "RegisterCertificateRequest":{ + "type":"structure", + "required":["certificatePem"], + "members":{ + "certificatePem":{"shape":"CertificatePem"}, + "caCertificatePem":{"shape":"CertificatePem"}, + "setAsActive":{ + "shape":"SetAsActive", + "location":"querystring", + "locationName":"setAsActive" + } + } + }, + "RegisterCertificateResponse":{ + "type":"structure", + "members":{ + "certificateArn":{"shape":"CertificateArn"}, + "certificateId":{"shape":"CertificateId"} + } + }, + "RegistrationCode":{ + "type":"string", + "min":64, + "max":64, + "pattern":"(0x)?[a-fA-F0-9]+" + }, + "RegistrationCodeValidationException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "RejectCertificateTransferRequest":{ + "type":"structure", + "required":["certificateId"], + "members":{ + "certificateId":{ + "shape":"CertificateId", + "location":"uri", + "locationName":"certificateId" + }, + "rejectReason":{"shape":"Message"} + } + }, + "ReplaceTopicRuleRequest":{ + "type":"structure", + "required":[ + "ruleName", + "topicRulePayload" + ], + "members":{ + "ruleName":{ + "shape":"RuleName", + "location":"uri", + "locationName":"ruleName" + }, + "topicRulePayload":{"shape":"TopicRulePayload"} + }, + "payload":"topicRulePayload" + }, + "RepublishAction":{ + "type":"structure", + "required":[ + "roleArn", + "topic" + ], + "members":{ + "roleArn":{"shape":"AwsArn"}, + "topic":{"shape":"TopicPattern"} + } + }, + "ResourceAlreadyExistsException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "error":{"httpStatusCode":404}, + "exception":true + }, + "RuleArn":{"type":"string"}, + "RuleName":{ + "type":"string", + "min":1, + "max":128, + "pattern":"^[a-zA-Z0-9_]+$" + }, + "S3Action":{ + "type":"structure", + "required":[ + "roleArn", + "bucketName", + "key" + ], + "members":{ + "roleArn":{"shape":"AwsArn"}, + "bucketName":{"shape":"BucketName"}, + "key":{"shape":"Key"} + } + }, + "SQL":{"type":"string"}, + "ServiceUnavailableException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + "SetAsActive":{"type":"boolean"}, + "SetAsDefault":{"type":"boolean"}, + "SetDefaultPolicyVersionRequest":{ + "type":"structure", + "required":[ + "policyName", + "policyVersionId" + ], + "members":{ + "policyName":{ + "shape":"PolicyName", + "location":"uri", + "locationName":"policyName" + }, + "policyVersionId":{ + "shape":"PolicyVersionId", + "location":"uri", + "locationName":"policyVersionId" + } + } + }, + "SetLoggingOptionsRequest":{ + "type":"structure", + "required":["loggingOptionsPayload"], + "members":{ + "loggingOptionsPayload":{"shape":"LoggingOptionsPayload"} + }, + "payload":"loggingOptionsPayload" + }, + "SnsAction":{ + "type":"structure", + "required":[ + "targetArn", + "roleArn" + ], + "members":{ + "targetArn":{"shape":"AwsArn"}, + "roleArn":{"shape":"AwsArn"}, + "messageFormat":{"shape":"MessageFormat"} + } + }, + "SqlParseException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "SqsAction":{ + "type":"structure", + "required":[ + "roleArn", + "queueUrl" + ], + "members":{ + "roleArn":{"shape":"AwsArn"}, + "queueUrl":{"shape":"QueueUrl"}, + "useBase64":{"shape":"UseBase64"} + } + }, + "StateReason":{"type":"string"}, + "StateValue":{"type":"string"}, + "StreamName":{"type":"string"}, + "TableName":{"type":"string"}, + "ThingArn":{"type":"string"}, + "ThingAttribute":{ + "type":"structure", + "members":{ + "thingName":{"shape":"ThingName"}, + "attributes":{"shape":"Attributes"} + } + }, + "ThingAttributeList":{ + "type":"list", + "member":{"shape":"ThingAttribute"} + }, + "ThingName":{ + "type":"string", + "min":1, + "max":128, + "pattern":"[a-zA-Z0-9_-]+" + }, + "ThingNameList":{ + "type":"list", + "member":{"shape":"ThingName"} + }, + "ThrottlingException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "error":{"httpStatusCode":429}, + "exception":true + }, + "Topic":{"type":"string"}, + "TopicPattern":{"type":"string"}, + "TopicRule":{ + "type":"structure", + "members":{ + "ruleName":{"shape":"RuleName"}, + "sql":{"shape":"SQL"}, + "description":{"shape":"Description"}, + "createdAt":{"shape":"CreatedAtDate"}, + "actions":{"shape":"ActionList"}, + "ruleDisabled":{"shape":"IsDisabled"}, + "awsIotSqlVersion":{"shape":"AwsIotSqlVersion"} + } + }, + "TopicRuleList":{ + "type":"list", + "member":{"shape":"TopicRuleListItem"} + }, + "TopicRuleListItem":{ + "type":"structure", + "members":{ + "ruleArn":{"shape":"RuleArn"}, + "ruleName":{"shape":"RuleName"}, + "topicPattern":{"shape":"TopicPattern"}, + "createdAt":{"shape":"CreatedAtDate"}, + "ruleDisabled":{"shape":"IsDisabled"} + } + }, + "TopicRulePayload":{ + "type":"structure", + "required":[ + "sql", + "actions" + ], + "members":{ + "sql":{"shape":"SQL"}, + "description":{"shape":"Description"}, + "actions":{"shape":"ActionList"}, + "ruleDisabled":{"shape":"IsDisabled"}, + "awsIotSqlVersion":{"shape":"AwsIotSqlVersion"} + } + }, + "TransferAlreadyCompletedException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "error":{"httpStatusCode":410}, + "exception":true + }, + "TransferCertificateRequest":{ + "type":"structure", + "required":[ + "certificateId", + "targetAwsAccount" + ], + "members":{ + "certificateId":{ + "shape":"CertificateId", + "location":"uri", + "locationName":"certificateId" + }, + "targetAwsAccount":{ + "shape":"AwsAccountId", + "location":"querystring", + "locationName":"targetAwsAccount" + }, + "transferMessage":{"shape":"Message"} + } + }, + "TransferCertificateResponse":{ + "type":"structure", + "members":{ + "transferredCertificateArn":{"shape":"CertificateArn"} + } + }, + "TransferConflictException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "TransferData":{ + "type":"structure", + "members":{ + "transferMessage":{"shape":"Message"}, + "rejectReason":{"shape":"Message"}, + "transferDate":{"shape":"DateType"}, + "acceptDate":{"shape":"DateType"}, + "rejectDate":{"shape":"DateType"} + } + }, + "UnauthorizedException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "error":{"httpStatusCode":401}, + "exception":true + }, + "UpdateCACertificateRequest":{ + "type":"structure", + "required":[ + "certificateId", + "newStatus" + ], + "members":{ + "certificateId":{ + "shape":"CertificateId", + "location":"uri", + "locationName":"caCertificateId" + }, + "newStatus":{ + "shape":"CACertificateStatus", + "location":"querystring", + "locationName":"newStatus" + } + } + }, + "UpdateCertificateRequest":{ + "type":"structure", + "required":[ + "certificateId", + "newStatus" + ], + "members":{ + "certificateId":{ + "shape":"CertificateId", + "location":"uri", + "locationName":"certificateId" + }, + "newStatus":{ + "shape":"CertificateStatus", + "location":"querystring", + "locationName":"newStatus" + } + } + }, + "UpdateThingRequest":{ + "type":"structure", + "required":[ + "thingName", + "attributePayload" + ], + "members":{ + "thingName":{ + "shape":"ThingName", + "location":"uri", + "locationName":"thingName" + }, + "attributePayload":{"shape":"AttributePayload"} + } + }, + "UpdateThingResponse":{ + "type":"structure", + "members":{ + } + }, + "UseBase64":{"type":"boolean"}, + "VersionsLimitExceededException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "errorMessage":{"type":"string"} + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/iot/2015-05-28/docs-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/iot/2015-05-28/docs-2.json new file mode 100644 index 000000000..0266957e9 --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/iot/2015-05-28/docs-2.json @@ -0,0 +1,1422 @@ +{ + "version": "2.0", + "operations": { + "AcceptCertificateTransfer": "Accepts a pending certificate transfer. The default state of the certificate is INACTIVE.
To check for pending certificate transfers, call ListCertificates to enumerate your certificates.
", + "AttachPrincipalPolicy": "Attaches the specified policy to the specified principal (certificate or other credential).
", + "AttachThingPrincipal": "Attaches the specified principal to the specified thing.
", + "CancelCertificateTransfer": "Cancels a pending transfer for the specified certificate.
Note Only the transfer source account can use this operation to cancel a transfer. (Transfer destinations can use RejectCertificateTransfer instead.) After transfer, AWS IoT returns the certificate to the source account in the INACTIVE state. After the destination account has accepted the transfer, the transfer cannot be cancelled.
After a certificate transfer is cancelled, the status of the certificate changes from PENDING_TRANSFER to INACTIVE.
", + "CreateCertificateFromCsr": "Creates an X.509 certificate using the specified certificate signing request.
Note Reusing the same certificate signing request (CSR) results in a distinct certificate.
You can create multiple certificates in a batch by creating a directory, copying multiple .csr files into that directory, and then specifying that directory on the command line. The following commands show how to create a batch of certificates given a batch of CSRs.
Assuming a set of CSRs are located inside of the directory my-csr-directory:
On Linux and OS X, the command is:
$ ls my-csr-directory/ | xargs -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{}
This command lists all of the CSRs in my-csr-directory and pipes each CSR file name to the aws iot create-certificate-from-csr AWS CLI command to create a certificate for the corresponding CSR.
The aws iot create-certificate-from-csr part of the command can also be run in parallel to speed up the certificate creation process:
$ ls my-csr-directory/ | xargs -P 10 -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{}
On Windows PowerShell, the command to create certificates for all CSRs in my-csr-directory is:
> ls -Name my-csr-directory | %{aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/$_}
On a Windows command prompt, the command to create certificates for all CSRs in my-csr-directory is:
> forfiles /p my-csr-directory /c \"cmd /c aws iot create-certificate-from-csr --certificate-signing-request file://@path\"
", + "CreateKeysAndCertificate": "Creates a 2048-bit RSA key pair and issues an X.509 certificate using the issued public key.
Note This is the only time AWS IoT issues the private key for this certificate, so it is important to keep it in a secure location.
", + "CreatePolicy": "Creates an AWS IoT policy.
The created policy is the default version for the policy. This operation creates a policy version with a version identifier of 1 and sets 1 as the policy's default version.
", + "CreatePolicyVersion": "Creates a new version of the specified AWS IoT policy. To update a policy, create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must use DeletePolicyVersion to delete an existing version before you create a new one.
Optionally, you can set the new version as the policy's default version. The default version is the operative version (that is, the version that is in effect for the certificates to which the policy is attached).
", + "CreateThing": "Creates a thing in the Thing Registry.
", + "CreateTopicRule": "Creates a rule. Creating rules is an administrator-level action. Any user who has permission to create rules will be able to access data processed by the rule.
", + "DeleteCACertificate": "Deletes a registered CA certificate.
", + "DeleteCertificate": "Deletes the specified certificate.
A certificate cannot be deleted if it has a policy attached to it or if its status is set to ACTIVE. To delete a certificate, first use the DetachPrincipalPolicy API to detach all policies. Next, use the UpdateCertificate API to set the certificate to the INACTIVE status.
", + "DeletePolicy": "Deletes the specified policy.
A policy cannot be deleted if it has non-default versions or it is attached to any certificate.
To delete a policy, use the DeletePolicyVersion API to delete all non-default versions of the policy; use the DetachPrincipalPolicy API to detach the policy from any certificate; and then use the DeletePolicy API to delete the policy.
When a policy is deleted using DeletePolicy, its default version is deleted with it.
", + "DeletePolicyVersion": "Deletes the specified version of the specified policy. You cannot delete the default version of a policy using this API. To delete the default version of a policy, use DeletePolicy. To find out which version of a policy is marked as the default version, use ListPolicyVersions.
", + "DeleteRegistrationCode": "Deletes a CA certificate registration code.
", + "DeleteThing": "Deletes the specified thing from the Thing Registry.
", + "DeleteTopicRule": "Deletes the specified rule.
", + "DescribeCACertificate": "Describes a registered CA certificate.
", + "DescribeCertificate": "Gets information about the specified certificate.
", + "DescribeEndpoint": "Returns a unique endpoint specific to the AWS account making the call.
", + "DescribeThing": "Gets information about the specified thing.
", + "DetachPrincipalPolicy": "Removes the specified policy from the specified certificate.
", + "DetachThingPrincipal": "Detaches the specified principal from the specified thing.
", + "DisableTopicRule": "Disables the specified rule.
", + "EnableTopicRule": "Enables the specified rule.
", + "GetLoggingOptions": "Gets the logging options.
", + "GetPolicy": "Gets information about the specified policy with the policy document of the default version.
", + "GetPolicyVersion": "Gets information about the specified policy version.
", + "GetRegistrationCode": "Gets a registration code used to register a CA certificate with AWS IoT.
", + "GetTopicRule": "Gets information about the specified rule.
", + "ListCACertificates": "Lists the CA certificates registered for your AWS account.
The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional results.
", + "ListCertificates": "Lists the certificates registered in your AWS account.
The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional results.
", + "ListCertificatesByCA": "List the device certificates signed by the specified CA certificate.
", + "ListPolicies": "Lists your policies.
", + "ListPolicyPrincipals": "Lists the principals associated with the specified policy.
", + "ListPolicyVersions": "Lists the versions of the specified policy and identifies the default version.
", + "ListPrincipalPolicies": "Lists the policies attached to the specified principal. If you use an Cognito identity, the ID must be in AmazonCognito Identity format.
", + "ListPrincipalThings": "Lists the things associated with the specified principal.
", + "ListThingPrincipals": "Lists the principals associated with the specified thing.
", + "ListThings": "Lists your things. You can pass an AttributeName or AttributeValue to filter your things (for example, \"ListThings where AttributeName=Color and AttributeValue=Red\").
", + "ListTopicRules": "Lists the rules for the specific topic.
", + "RegisterCACertificate": "Registers a CA certificate with AWS IoT. This CA certificate can then be used to sign device certificates, which can be then registered with AWS IoT. You can register up to 10 CA certificates per AWS account that have the same subject field and public key. This enables you to have up to 10 certificate authorities sign your device certificates. If you have more than one CA certificate registered, make sure you pass the CA certificate when you register your device certificates with the RegisterCertificate API.
", + "RegisterCertificate": "Registers a device certificate with AWS IoT. If you have more than one CA certificate that has the same subject field, you must specify the CA certificate that was used to sign the device certificate being registered.
", + "RejectCertificateTransfer": "Rejects a pending certificate transfer. After AWS IoT rejects a certificate transfer, the certificate status changes from PENDING_TRANSFER to INACTIVE.
To check for pending certificate transfers, call ListCertificates to enumerate your certificates.
This operation can only be called by the transfer destination. After it is called, the certificate will be returned to the source's account in the INACTIVE state.
", + "ReplaceTopicRule": "Replaces the specified rule. You must specify all parameters for the new rule. Creating rules is an administrator-level action. Any user who has permission to create rules will be able to access data processed by the rule.
", + "SetDefaultPolicyVersion": "Sets the specified version of the specified policy as the policy's default (operative) version. This action affects all certificates to which the policy is attached. To list the principals the policy is attached to, use the ListPrincipalPolicy API.
", + "SetLoggingOptions": "Sets the logging options.
", + "TransferCertificate": "Transfers the specified certificate to the specified AWS account.
You can cancel the transfer until it is acknowledged by the recipient.
No notification is sent to the transfer destination's account. It is up to the caller to notify the transfer target.
The certificate being transferred must not be in the ACTIVE state. You can use the UpdateCertificate API to deactivate it.
The certificate must not have any policies attached to it. You can use the DetachPrincipalPolicy API to detach them.
", + "UpdateCACertificate": "Updates a registered CA certificate.
", + "UpdateCertificate": "Updates the status of the specified certificate. This operation is idempotent.
Moving a certificate from the ACTIVE state (including REVOKED) will not disconnect currently connected devices, but these devices will be unable to reconnect.
The ACTIVE state is required to authenticate devices connecting to AWS IoT using a certificate.
", + "UpdateThing": "Updates the data for a thing.
" + }, + "service": "AWS IoT provides secure, bi-directional communication between Internet-connected things (such as sensors, actuators, embedded devices, or smart appliances) and the AWS cloud. You can discover your custom IoT-Data endpoint to communicate with, configure rules for data processing and integration with other services, organize resources associated with each thing (Thing Registry), configure logging, and create and manage policies and credentials to authenticate things.
For more information about how AWS IoT works, see the Developer Guide.
", + "shapes": { + "AcceptCertificateTransferRequest": { + "base": "The input for the AcceptCertificateTransfer operation.
", + "refs": { + } + }, + "Action": { + "base": "Describes the actions associated with a rule.
", + "refs": { + "ActionList$member": null + } + }, + "ActionList": { + "base": null, + "refs": { + "TopicRule$actions": "The actions associated with the rule.
", + "TopicRulePayload$actions": "The actions associated with the rule.
" + } + }, + "AlarmName": { + "base": null, + "refs": { + "CloudwatchAlarmAction$alarmName": "The CloudWatch alarm name.
" + } + }, + "AscendingOrder": { + "base": null, + "refs": { + "ListCACertificatesRequest$ascendingOrder": "Determines the order of the results.
", + "ListCertificatesByCARequest$ascendingOrder": "Specifies the order for results. If True, the results are returned in ascending order, based on the creation date.
", + "ListCertificatesRequest$ascendingOrder": "Specifies the order for results. If True, the results are returned in ascending order, based on the creation date.
", + "ListPoliciesRequest$ascendingOrder": "Specifies the order for results. If true, the results are returned in ascending creation order.
", + "ListPolicyPrincipalsRequest$ascendingOrder": "Specifies the order for results. If true, the results are returned in ascending creation order.
", + "ListPrincipalPoliciesRequest$ascendingOrder": "Specifies the order for results. If true, results are returned in ascending creation order.
" + } + }, + "AttachPrincipalPolicyRequest": { + "base": "The input for the AttachPrincipalPolicy operation.
", + "refs": { + } + }, + "AttachThingPrincipalRequest": { + "base": "The input for the AttachThingPrincipal operation.
", + "refs": { + } + }, + "AttachThingPrincipalResponse": { + "base": "The output from the AttachThingPrincipal operation.
", + "refs": { + } + }, + "AttributeName": { + "base": null, + "refs": { + "Attributes$key": null, + "ListThingsRequest$attributeName": "The attribute name.
" + } + }, + "AttributePayload": { + "base": "The attribute payload, a JSON string containing up to three key-value pairs (for example, {\\\"attributes\\\":{\\\"string1\\\":\\\"string2\\\"}}).
", + "refs": { + "CreateThingRequest$attributePayload": "The attribute payload, which consists of up to 3 name/value pairs in a JSON document (for example, {\\\"attributes\\\":{\\\"string1\\\":\\\"string2\\\"}}).
", + "UpdateThingRequest$attributePayload": "The attribute payload, a JSON string containing up to three key-value pairs (for example, {\\\"attributes\\\":{\\\"string1\\\":\\\"string2\\\"}}).
" + } + }, + "AttributeValue": { + "base": null, + "refs": { + "Attributes$value": null, + "ListThingsRequest$attributeValue": "The attribute value.
" + } + }, + "Attributes": { + "base": null, + "refs": { + "AttributePayload$attributes": "A JSON string containing up to three key-value pair in JSON format (for example, {\\\"attributes\\\":{\\\"string1\\\":\\\"string2\\\"}}).
", + "DescribeThingResponse$attributes": "The attributes, which are name/value pairs in JSON format (for example: {\\\"attributes\\\":{\\\"some-name1\\\":\\\"some-value1\\\"}, {\\\"some-name2\\\":\\\"some-value2\\\"}, {\\\"some-name3\\\":\\\"some-value3\\\"}})
", + "ThingAttribute$attributes": "The attributes.
" + } + }, + "AwsAccountId": { + "base": null, + "refs": { + "CACertificateDescription$ownedBy": "The owner of the CA certificate.
", + "CertificateDescription$ownedBy": "The ID of the AWS account that owns the certificate.
", + "CertificateDescription$previousOwnedBy": "The ID of the AWS account of the previous owner of the certificate.
", + "TransferCertificateRequest$targetAwsAccount": "The AWS account.
" + } + }, + "AwsArn": { + "base": null, + "refs": { + "CloudwatchAlarmAction$roleArn": "The IAM role that allows access to the CloudWatch alarm.
", + "CloudwatchMetricAction$roleArn": "The IAM role that allows access to the CloudWatch metric.
", + "DynamoDBAction$roleArn": "The ARN of the IAM role that grants access to the DynamoDB table.
", + "ElasticsearchAction$roleArn": "The IAM role ARN that has access to Elasticsearch.
", + "FirehoseAction$roleArn": "The IAM role that grants access to the Amazon Kinesis Firehost stream.
", + "GetLoggingOptionsResponse$roleArn": "The ARN of the IAM role that grants access.
", + "KinesisAction$roleArn": "The ARN of the IAM role that grants access to the Amazon Kinesis stream.
", + "LoggingOptionsPayload$roleArn": "The ARN of the IAM role that grants access.
", + "RepublishAction$roleArn": "The ARN of the IAM role that grants access.
", + "S3Action$roleArn": "The ARN of the IAM role that grants access.
", + "SnsAction$targetArn": "The ARN of the SNS topic.
", + "SnsAction$roleArn": "The ARN of the IAM role that grants access.
", + "SqsAction$roleArn": "The ARN of the IAM role that grants access.
" + } + }, + "AwsIotSqlVersion": { + "base": null, + "refs": { + "TopicRule$awsIotSqlVersion": "The version of the SQL rules engine to use when evaluating the rule.
", + "TopicRulePayload$awsIotSqlVersion": "The version of the SQL rules engine to use when evaluating the rule.
" + } + }, + "BucketName": { + "base": null, + "refs": { + "S3Action$bucketName": "The Amazon S3 bucket.
" + } + }, + "CACertificate": { + "base": "A CA certificate.
", + "refs": { + "CACertificates$member": null + } + }, + "CACertificateDescription": { + "base": "Describes a CA certificate.
", + "refs": { + "DescribeCACertificateResponse$certificateDescription": "The CA certificate description.
" + } + }, + "CACertificateStatus": { + "base": null, + "refs": { + "CACertificate$status": "The status of the CA certificate.
The status value REGISTER_INACTIVE is deprecated and should not be used.
", + "CACertificateDescription$status": "The status of a CA certificate.
", + "UpdateCACertificateRequest$newStatus": "The updated status of the CA certificate.
Note: The status value REGISTER_INACTIVE is deprecated and should not be used.
" + } + }, + "CACertificates": { + "base": null, + "refs": { + "ListCACertificatesResponse$certificates": "The CA certificates registered in your AWS account.
" + } + }, + "CancelCertificateTransferRequest": { + "base": "The input for the CancelCertificateTransfer operation.
", + "refs": { + } + }, + "Certificate": { + "base": "Information about a certificate.
", + "refs": { + "Certificates$member": null + } + }, + "CertificateArn": { + "base": null, + "refs": { + "CACertificate$certificateArn": "The ARN of the CA certificate.
", + "CACertificateDescription$certificateArn": "The CA certificate ARN.
", + "Certificate$certificateArn": "The ARN of the certificate.
", + "CertificateDescription$certificateArn": "The ARN of the certificate.
", + "CreateCertificateFromCsrResponse$certificateArn": "The Amazon Resource Name (ARN) of the certificate. You can use the ARN as a principal for policy operations.
", + "CreateKeysAndCertificateResponse$certificateArn": "The ARN of the certificate.
", + "RegisterCACertificateResponse$certificateArn": "The CA certificate ARN.
", + "RegisterCertificateResponse$certificateArn": "The certificate ARN.
", + "TransferCertificateResponse$transferredCertificateArn": "The ARN of the certificate.
" + } + }, + "CertificateConflictException": { + "base": "Unable to verify the CA certificate used to sign the device certificate you are attempting to register. This is happens when you have registered more than one CA certificate that has the same subject field and public key.
", + "refs": { + } + }, + "CertificateDescription": { + "base": "Describes a certificate.
", + "refs": { + "DescribeCertificateResponse$certificateDescription": "The description of the certificate.
" + } + }, + "CertificateId": { + "base": null, + "refs": { + "AcceptCertificateTransferRequest$certificateId": "The ID of the certificate.
", + "CACertificate$certificateId": "The ID of the CA certificate.
", + "CACertificateDescription$certificateId": "The CA certificate ID.
", + "CancelCertificateTransferRequest$certificateId": "The ID of the certificate.
", + "Certificate$certificateId": "The ID of the certificate.
", + "CertificateDescription$certificateId": "The ID of the certificate.
", + "CertificateDescription$caCertificateId": "The certificate ID of the CA certificate used to sign this certificate.
", + "CreateCertificateFromCsrResponse$certificateId": "The ID of the certificate. Certificate management operations only take a certificateId.
", + "CreateKeysAndCertificateResponse$certificateId": "The ID of the certificate. AWS IoT issues a default subject name for the certificate (for example, AWS IoT Certificate).
", + "DeleteCACertificateRequest$certificateId": "The ID of the certificate to delete.
", + "DeleteCertificateRequest$certificateId": "The ID of the certificate.
", + "DescribeCACertificateRequest$certificateId": "The CA certificate identifier.
", + "DescribeCertificateRequest$certificateId": "The ID of the certificate.
", + "ListCertificatesByCARequest$caCertificateId": "The ID of the CA certificate. This operation will list all registered device certificate that were signed by this CA certificate.
", + "RegisterCACertificateResponse$certificateId": "The CA certificate identifier.
", + "RegisterCertificateResponse$certificateId": "The certificate identifier.
", + "RejectCertificateTransferRequest$certificateId": "The ID of the certificate.
", + "TransferCertificateRequest$certificateId": "The ID of the certificate.
", + "UpdateCACertificateRequest$certificateId": "The CA certificate identifier.
", + "UpdateCertificateRequest$certificateId": "The ID of the certificate.
" + } + }, + "CertificatePem": { + "base": null, + "refs": { + "CACertificateDescription$certificatePem": "The CA certificate data, in PEM format.
", + "CertificateDescription$certificatePem": "The certificate data, in PEM format.
", + "CreateCertificateFromCsrResponse$certificatePem": "The certificate data, in PEM format.
", + "CreateKeysAndCertificateResponse$certificatePem": "The certificate data, in PEM format.
", + "RegisterCACertificateRequest$caCertificate": "The CA certificate.
", + "RegisterCACertificateRequest$verificationCertificate": "The private key verification certificate.
", + "RegisterCertificateRequest$certificatePem": "The certificate data, in PEM format.
", + "RegisterCertificateRequest$caCertificatePem": "The CA certificate used to sign the device certificate being registered.
" + } + }, + "CertificateSigningRequest": { + "base": null, + "refs": { + "CreateCertificateFromCsrRequest$certificateSigningRequest": "The certificate signing request (CSR).
" + } + }, + "CertificateStateException": { + "base": "The certificate operation is not allowed.
", + "refs": { + } + }, + "CertificateStatus": { + "base": null, + "refs": { + "Certificate$status": "The status of the certificate.
The status value REGISTER_INACTIVE is deprecated and should not be used.
", + "CertificateDescription$status": "The status of the certificate.
", + "UpdateCertificateRequest$newStatus": "The new status.
Note: Setting the status to PENDING_TRANSFER will result in an exception being thrown. PENDING_TRANSFER is a status used internally by AWS IoT. It is not intended for developer use.
Note: The status value REGISTER_INACTIVE is deprecated and should not be used.
" + } + }, + "CertificateValidationException": { + "base": "The certificate is invalid.
", + "refs": { + } + }, + "Certificates": { + "base": null, + "refs": { + "ListCertificatesByCAResponse$certificates": "The device certificates signed by the specified CA certificate.
", + "ListCertificatesResponse$certificates": "The descriptions of the certificates.
" + } + }, + "ClientId": { + "base": null, + "refs": { + "DescribeThingResponse$defaultClientId": "The default client ID.
" + } + }, + "CloudwatchAlarmAction": { + "base": "Describes an action that updates a CloudWatch alarm.
", + "refs": { + "Action$cloudwatchAlarm": "Change the state of a CloudWatch alarm.
" + } + }, + "CloudwatchMetricAction": { + "base": "Describes an action that captures a CloudWatch metric.
", + "refs": { + "Action$cloudwatchMetric": "Capture a CloudWatch metric.
" + } + }, + "CreateCertificateFromCsrRequest": { + "base": "The input for the CreateCertificateFromCsr operation.
", + "refs": { + } + }, + "CreateCertificateFromCsrResponse": { + "base": "The output from the CreateCertificateFromCsr operation.
", + "refs": { + } + }, + "CreateKeysAndCertificateRequest": { + "base": "The input for the CreateKeysAndCertificate operation.
", + "refs": { + } + }, + "CreateKeysAndCertificateResponse": { + "base": "The output of the CreateKeysAndCertificate operation.
", + "refs": { + } + }, + "CreatePolicyRequest": { + "base": "The input for the CreatePolicy operation.
", + "refs": { + } + }, + "CreatePolicyResponse": { + "base": "The output from the CreatePolicy operation.
", + "refs": { + } + }, + "CreatePolicyVersionRequest": { + "base": "The input for the CreatePolicyVersion operation.
", + "refs": { + } + }, + "CreatePolicyVersionResponse": { + "base": "The output of the CreatePolicyVersion operation.
", + "refs": { + } + }, + "CreateThingRequest": { + "base": "The input for the CreateThing operation.
", + "refs": { + } + }, + "CreateThingResponse": { + "base": "The output of the CreateThing operation.
", + "refs": { + } + }, + "CreateTopicRuleRequest": { + "base": "The input for the CreateTopicRule operation.
", + "refs": { + } + }, + "CreatedAtDate": { + "base": null, + "refs": { + "TopicRule$createdAt": "The date and time the rule was created.
", + "TopicRuleListItem$createdAt": "The date and time the rule was created.
" + } + }, + "DateType": { + "base": null, + "refs": { + "CACertificate$creationDate": "The date the CA certificate was created.
", + "CACertificateDescription$creationDate": "The date the CA certificate was created.
", + "Certificate$creationDate": "The date and time the certificate was created.
", + "CertificateDescription$creationDate": "The date and time the certificate was created.
", + "CertificateDescription$lastModifiedDate": "The date and time the certificate was last modified.
", + "PolicyVersion$createDate": "The date and time the policy was created.
", + "TransferData$transferDate": "The date the transfer took place.
", + "TransferData$acceptDate": "The date the transfer was accepted.
", + "TransferData$rejectDate": "The date the transfer was rejected.
" + } + }, + "DeleteCACertificateRequest": { + "base": "Input for the DeleteCACertificate operation.
", + "refs": { + } + }, + "DeleteCACertificateResponse": { + "base": "The output for the DeleteCACertificate operation.
", + "refs": { + } + }, + "DeleteCertificateRequest": { + "base": "The input for the DeleteCertificate operation.
", + "refs": { + } + }, + "DeleteConflictException": { + "base": "You can't delete the resource because it is attached to one or more resources.
", + "refs": { + } + }, + "DeletePolicyRequest": { + "base": "The input for the DeletePolicy operation.
", + "refs": { + } + }, + "DeletePolicyVersionRequest": { + "base": "The input for the DeletePolicyVersion operation.
", + "refs": { + } + }, + "DeleteRegistrationCodeRequest": { + "base": "The input for the DeleteRegistrationCode operation.
", + "refs": { + } + }, + "DeleteRegistrationCodeResponse": { + "base": "The output for the DeleteRegistrationCode operation.
", + "refs": { + } + }, + "DeleteThingRequest": { + "base": "The input for the DeleteThing operation.
", + "refs": { + } + }, + "DeleteThingResponse": { + "base": "The output of the DeleteThing operation.
", + "refs": { + } + }, + "DeleteTopicRuleRequest": { + "base": "The input for the DeleteTopicRule operation.
", + "refs": { + } + }, + "DeliveryStreamName": { + "base": null, + "refs": { + "FirehoseAction$deliveryStreamName": "The delivery stream name.
" + } + }, + "DescribeCACertificateRequest": { + "base": "The input for the DescribeCACertificate operation.
", + "refs": { + } + }, + "DescribeCACertificateResponse": { + "base": "The output from the DescribeCACertificate operation.
", + "refs": { + } + }, + "DescribeCertificateRequest": { + "base": "The input for the DescribeCertificate operation.
", + "refs": { + } + }, + "DescribeCertificateResponse": { + "base": "The output of the DescribeCertificate operation.
", + "refs": { + } + }, + "DescribeEndpointRequest": { + "base": "The input for the DescribeEndpoint operation.
", + "refs": { + } + }, + "DescribeEndpointResponse": { + "base": "The output from the DescribeEndpoint operation.
", + "refs": { + } + }, + "DescribeThingRequest": { + "base": "The input for the DescribeThing operation.
", + "refs": { + } + }, + "DescribeThingResponse": { + "base": "The output from the DescribeThing operation.
", + "refs": { + } + }, + "Description": { + "base": null, + "refs": { + "TopicRule$description": "The description of the rule.
", + "TopicRulePayload$description": "The description of the rule.
" + } + }, + "DetachPrincipalPolicyRequest": { + "base": "The input for the DetachPrincipalPolicy operation.
", + "refs": { + } + }, + "DetachThingPrincipalRequest": { + "base": "The input for the DetachThingPrincipal operation.
", + "refs": { + } + }, + "DetachThingPrincipalResponse": { + "base": "The output from the DetachThingPrincipal operation.
", + "refs": { + } + }, + "DisableTopicRuleRequest": { + "base": "The input for the DisableTopicRuleRequest operation.
", + "refs": { + } + }, + "DynamoDBAction": { + "base": "Describes an action to write to a DynamoDB table.
The tableName, hashKeyField, and rangeKeyField values must match the values used when you created the table.
The hashKeyValue and rangeKeyvalue fields use a substitution template syntax. These templates provide data at runtime. The syntax is as follows: ${sql-expression}.
You can specify any valid expression in a WHERE or SELECT clause, including JSON properties, comparisons, calculations, and functions. For example, the following field uses the third level of the topic:
\"hashKeyValue\": \"${topic(3)}\"
The following field uses the timestamp:
\"rangeKeyValue\": \"${timestamp()}\"
Write to a DynamoDB table.
" + } + }, + "DynamoKeyType": { + "base": null, + "refs": { + "DynamoDBAction$hashKeyType": "The hash key type. Valid values are \"STRING\" or \"NUMBER\"
", + "DynamoDBAction$rangeKeyType": "The range key type. Valid values are \"STRING\" or \"NUMBER\"
" + } + }, + "DynamoOperation": { + "base": null, + "refs": { + "DynamoDBAction$operation": "The type of operation to be performed. This follows the substitution template, so it can be ${operation}, but the substitution must result in one of the following: INSERT, UPDATE, or DELETE.
Describes an action that writes data to an Amazon Elasticsearch Service; domain.
", + "refs": { + "Action$elasticsearch": "Write data to an Amazon Elasticsearch Service; domain.
" + } + }, + "ElasticsearchEndpoint": { + "base": null, + "refs": { + "ElasticsearchAction$endpoint": "The endpoint of your Elasticsearch domain.
" + } + }, + "ElasticsearchId": { + "base": null, + "refs": { + "ElasticsearchAction$id": "The unique identifier for the document you are storing.
" + } + }, + "ElasticsearchIndex": { + "base": null, + "refs": { + "ElasticsearchAction$index": "The Elasticsearch index where you want to store your data.
" + } + }, + "ElasticsearchType": { + "base": null, + "refs": { + "ElasticsearchAction$type": "The type of document you are storing.
" + } + }, + "EnableTopicRuleRequest": { + "base": "The input for the EnableTopicRuleRequest operation.
", + "refs": { + } + }, + "EndpointAddress": { + "base": null, + "refs": { + "DescribeEndpointResponse$endpointAddress": "The endpoint. The format of the endpoint is as follows: identifier.iot.region.amazonaws.com.
" + } + }, + "FirehoseAction": { + "base": "Describes an action that writes data to an Amazon Kinesis Firehose stream.
", + "refs": { + "Action$firehose": "Write to an Amazon Kinesis Firehose stream.
" + } + }, + "FunctionArn": { + "base": null, + "refs": { + "LambdaAction$functionArn": "The ARN of the Lambda function.
" + } + }, + "GetLoggingOptionsRequest": { + "base": "The input for the GetLoggingOptions operation.
", + "refs": { + } + }, + "GetLoggingOptionsResponse": { + "base": "The output from the GetLoggingOptions operation.
", + "refs": { + } + }, + "GetPolicyRequest": { + "base": "The input for the GetPolicy operation.
", + "refs": { + } + }, + "GetPolicyResponse": { + "base": "The output from the GetPolicy operation.
", + "refs": { + } + }, + "GetPolicyVersionRequest": { + "base": "The input for the GetPolicyVersion operation.
", + "refs": { + } + }, + "GetPolicyVersionResponse": { + "base": "The output from the GetPolicyVersion operation.
", + "refs": { + } + }, + "GetRegistrationCodeRequest": { + "base": "The input to the GetRegistrationCode operation.
", + "refs": { + } + }, + "GetRegistrationCodeResponse": { + "base": "The output from the GetRegistrationCode operation.
", + "refs": { + } + }, + "GetTopicRuleRequest": { + "base": "The input for the GetTopicRule operation.
", + "refs": { + } + }, + "GetTopicRuleResponse": { + "base": "The output from the GetTopicRule operation.
", + "refs": { + } + }, + "HashKeyField": { + "base": null, + "refs": { + "DynamoDBAction$hashKeyField": "The hash key name.
" + } + }, + "HashKeyValue": { + "base": null, + "refs": { + "DynamoDBAction$hashKeyValue": "The hash key value.
" + } + }, + "InternalException": { + "base": "An unexpected error has occurred.
", + "refs": { + } + }, + "InternalFailureException": { + "base": "An unexpected error has occurred.
", + "refs": { + } + }, + "InvalidRequestException": { + "base": "The request is not valid.
", + "refs": { + } + }, + "IsDefaultVersion": { + "base": null, + "refs": { + "CreatePolicyVersionResponse$isDefaultVersion": "Specifies whether the policy version is the default.
", + "GetPolicyVersionResponse$isDefaultVersion": "Specifies whether the policy version is the default.
", + "PolicyVersion$isDefaultVersion": "Specifies whether the policy version is the default.
" + } + }, + "IsDisabled": { + "base": null, + "refs": { + "ListTopicRulesRequest$ruleDisabled": "Specifies whether the rule is disabled.
", + "TopicRule$ruleDisabled": "Specifies whether the rule is disabled.
", + "TopicRuleListItem$ruleDisabled": "Specifies whether the rule is disabled.
", + "TopicRulePayload$ruleDisabled": "Specifies whether the rule is disabled.
" + } + }, + "Key": { + "base": null, + "refs": { + "S3Action$key": "The object key.
" + } + }, + "KeyPair": { + "base": "Describes a key pair.
", + "refs": { + "CreateKeysAndCertificateResponse$keyPair": "The generated key pair.
" + } + }, + "KinesisAction": { + "base": "Describes an action to write data to an Amazon Kinesis stream.
", + "refs": { + "Action$kinesis": "Write data to an Amazon Kinesis stream.
" + } + }, + "LambdaAction": { + "base": "Describes an action to invoke a Lambda function.
", + "refs": { + "Action$lambda": "Invoke a Lambda function.
" + } + }, + "LimitExceededException": { + "base": "The number of attached entities exceeds the limit.
", + "refs": { + } + }, + "ListCACertificatesRequest": { + "base": "Input for the ListCACertificates operation.
", + "refs": { + } + }, + "ListCACertificatesResponse": { + "base": "The output from the ListCACertificates operation.
", + "refs": { + } + }, + "ListCertificatesByCARequest": { + "base": "The input to the ListCertificatesByCA operation.
", + "refs": { + } + }, + "ListCertificatesByCAResponse": { + "base": "The output of the ListCertificatesByCA operation.
", + "refs": { + } + }, + "ListCertificatesRequest": { + "base": "The input for the ListCertificates operation.
", + "refs": { + } + }, + "ListCertificatesResponse": { + "base": "The output of the ListCertificates operation.
", + "refs": { + } + }, + "ListPoliciesRequest": { + "base": "The input for the ListPolicies operation.
", + "refs": { + } + }, + "ListPoliciesResponse": { + "base": "The output from the ListPolicies operation.
", + "refs": { + } + }, + "ListPolicyPrincipalsRequest": { + "base": "The input for the ListPolicyPrincipals operation.
", + "refs": { + } + }, + "ListPolicyPrincipalsResponse": { + "base": "The output from the ListPolicyPrincipals operation.
", + "refs": { + } + }, + "ListPolicyVersionsRequest": { + "base": "The input for the ListPolicyVersions operation.
", + "refs": { + } + }, + "ListPolicyVersionsResponse": { + "base": "The output from the ListPolicyVersions operation.
", + "refs": { + } + }, + "ListPrincipalPoliciesRequest": { + "base": "The input for the ListPrincipalPolicies operation.
", + "refs": { + } + }, + "ListPrincipalPoliciesResponse": { + "base": "The output from the ListPrincipalPolicies operation.
", + "refs": { + } + }, + "ListPrincipalThingsRequest": { + "base": "The input for the ListPrincipalThings operation.
", + "refs": { + } + }, + "ListPrincipalThingsResponse": { + "base": "The output from the ListPrincipalThings operation.
", + "refs": { + } + }, + "ListThingPrincipalsRequest": { + "base": "The input for the ListThingPrincipal operation.
", + "refs": { + } + }, + "ListThingPrincipalsResponse": { + "base": "The output from the ListThingPrincipals operation.
", + "refs": { + } + }, + "ListThingsRequest": { + "base": "The input for the ListThings operation.
", + "refs": { + } + }, + "ListThingsResponse": { + "base": "The output from the ListThings operation.
", + "refs": { + } + }, + "ListTopicRulesRequest": { + "base": "The input for the ListTopicRules operation.
", + "refs": { + } + }, + "ListTopicRulesResponse": { + "base": "The output from the ListTopicRules operation.
", + "refs": { + } + }, + "LogLevel": { + "base": null, + "refs": { + "GetLoggingOptionsResponse$logLevel": "The logging level.
", + "LoggingOptionsPayload$logLevel": "The logging level.
" + } + }, + "LoggingOptionsPayload": { + "base": "Describes the logging options payload.
", + "refs": { + "SetLoggingOptionsRequest$loggingOptionsPayload": "The logging options payload.
" + } + }, + "MalformedPolicyException": { + "base": "The policy documentation is not valid.
", + "refs": { + } + }, + "Marker": { + "base": null, + "refs": { + "ListCACertificatesRequest$marker": "The marker for the next set of results.
", + "ListCACertificatesResponse$nextMarker": "The current position within the list of CA certificates.
", + "ListCertificatesByCARequest$marker": "The marker for the next set of results.
", + "ListCertificatesByCAResponse$nextMarker": "The marker for the next set of results, or null if there are no additional results.
", + "ListCertificatesRequest$marker": "The marker for the next set of results.
", + "ListCertificatesResponse$nextMarker": "The marker for the next set of results, or null if there are no additional results.
", + "ListPoliciesRequest$marker": "The marker for the next set of results.
", + "ListPoliciesResponse$nextMarker": "The marker for the next set of results, or null if there are no additional results.
", + "ListPolicyPrincipalsRequest$marker": "The marker for the next set of results.
", + "ListPolicyPrincipalsResponse$nextMarker": "The marker for the next set of results, or null if there are no additional results.
", + "ListPrincipalPoliciesRequest$marker": "The marker for the next set of results.
", + "ListPrincipalPoliciesResponse$nextMarker": "The marker for the next set of results, or null if there are no additional results.
" + } + }, + "MaxResults": { + "base": null, + "refs": { + "ListPrincipalThingsRequest$maxResults": "The maximum number of principals to return.
", + "ListThingsRequest$maxResults": "The maximum number of results.
", + "ListTopicRulesRequest$maxResults": "The maximum number of results to return.
" + } + }, + "Message": { + "base": null, + "refs": { + "RejectCertificateTransferRequest$rejectReason": "The reason the certificate transfer was rejected.
", + "TransferCertificateRequest$transferMessage": "The transfer message.
", + "TransferData$transferMessage": "The transfer message.
", + "TransferData$rejectReason": "The reason why the transfer was rejected.
" + } + }, + "MessageFormat": { + "base": null, + "refs": { + "SnsAction$messageFormat": "The message format of the message to publish. Optional. Accepted values are \"JSON\" and \"RAW\". The default value of the attribute is \"RAW\". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. To read more about SNS message formats, see refer to their official documentation.
" + } + }, + "MetricName": { + "base": null, + "refs": { + "CloudwatchMetricAction$metricName": "The CloudWatch metric name.
" + } + }, + "MetricNamespace": { + "base": null, + "refs": { + "CloudwatchMetricAction$metricNamespace": "The CloudWatch metric namespace name.
" + } + }, + "MetricTimestamp": { + "base": null, + "refs": { + "CloudwatchMetricAction$metricTimestamp": "An optional Unix timestamp.
" + } + }, + "MetricUnit": { + "base": null, + "refs": { + "CloudwatchMetricAction$metricUnit": "The metric unit supported by CloudWatch.
" + } + }, + "MetricValue": { + "base": null, + "refs": { + "CloudwatchMetricAction$metricValue": "The CloudWatch metric value.
" + } + }, + "NextToken": { + "base": null, + "refs": { + "ListPrincipalThingsRequest$nextToken": "A token used to retrieve the next value.
", + "ListPrincipalThingsResponse$nextToken": "A token used to retrieve the next value.
", + "ListThingsRequest$nextToken": "The token for the next value.
", + "ListThingsResponse$nextToken": "A token used to retrieve the next value.
", + "ListTopicRulesRequest$nextToken": "A token used to retrieve the next value.
", + "ListTopicRulesResponse$nextToken": "A token used to retrieve the next value.
" + } + }, + "PageSize": { + "base": null, + "refs": { + "ListCACertificatesRequest$pageSize": "The result page size.
", + "ListCertificatesByCARequest$pageSize": "The result page size.
", + "ListCertificatesRequest$pageSize": "The result page size.
", + "ListPoliciesRequest$pageSize": "The result page size.
", + "ListPolicyPrincipalsRequest$pageSize": "The result page size.
", + "ListPrincipalPoliciesRequest$pageSize": "The result page size.
" + } + }, + "PartitionKey": { + "base": null, + "refs": { + "KinesisAction$partitionKey": "The partition key.
" + } + }, + "PayloadField": { + "base": null, + "refs": { + "DynamoDBAction$payloadField": "The action payload. This name can be customized.
" + } + }, + "Policies": { + "base": null, + "refs": { + "ListPoliciesResponse$policies": "The descriptions of the policies.
", + "ListPrincipalPoliciesResponse$policies": "The policies.
" + } + }, + "Policy": { + "base": "Describes an AWS IoT policy.
", + "refs": { + "Policies$member": null + } + }, + "PolicyArn": { + "base": null, + "refs": { + "CreatePolicyResponse$policyArn": "The policy ARN.
", + "CreatePolicyVersionResponse$policyArn": "The policy ARN.
", + "GetPolicyResponse$policyArn": "The policy ARN.
", + "GetPolicyVersionResponse$policyArn": "The policy ARN.
", + "Policy$policyArn": "The policy ARN.
" + } + }, + "PolicyDocument": { + "base": null, + "refs": { + "CreatePolicyRequest$policyDocument": "The JSON document that describes the policy. policyDocument must have a minimum length of 1, with a maximum length of 2048, excluding whitespace.
", + "CreatePolicyResponse$policyDocument": "The JSON document that describes the policy.
", + "CreatePolicyVersionRequest$policyDocument": "The JSON document that describes the policy. Minimum length of 1. Maximum length of 2048, excluding whitespaces
", + "CreatePolicyVersionResponse$policyDocument": "The JSON document that describes the policy.
", + "GetPolicyResponse$policyDocument": "The JSON document that describes the policy.
", + "GetPolicyVersionResponse$policyDocument": "The JSON document that describes the policy.
" + } + }, + "PolicyName": { + "base": null, + "refs": { + "AttachPrincipalPolicyRequest$policyName": "The policy name.
", + "CreatePolicyRequest$policyName": "The policy name.
", + "CreatePolicyResponse$policyName": "The policy name.
", + "CreatePolicyVersionRequest$policyName": "The policy name.
", + "DeletePolicyRequest$policyName": "The name of the policy to delete.
", + "DeletePolicyVersionRequest$policyName": "The name of the policy.
", + "DetachPrincipalPolicyRequest$policyName": "The name of the policy to detach.
", + "GetPolicyRequest$policyName": "The name of the policy.
", + "GetPolicyResponse$policyName": "The policy name.
", + "GetPolicyVersionRequest$policyName": "The name of the policy.
", + "GetPolicyVersionResponse$policyName": "The policy name.
", + "ListPolicyPrincipalsRequest$policyName": "The policy name.
", + "ListPolicyVersionsRequest$policyName": "The policy name.
", + "Policy$policyName": "The policy name.
", + "SetDefaultPolicyVersionRequest$policyName": "The policy name.
" + } + }, + "PolicyVersion": { + "base": "Describes a policy version.
", + "refs": { + "PolicyVersions$member": null + } + }, + "PolicyVersionId": { + "base": null, + "refs": { + "CreatePolicyResponse$policyVersionId": "The policy version ID.
", + "CreatePolicyVersionResponse$policyVersionId": "The policy version ID.
", + "DeletePolicyVersionRequest$policyVersionId": "The policy version ID.
", + "GetPolicyResponse$defaultVersionId": "The default policy version ID.
", + "GetPolicyVersionRequest$policyVersionId": "The policy version ID.
", + "GetPolicyVersionResponse$policyVersionId": "The policy version ID.
", + "PolicyVersion$versionId": "The policy version ID.
", + "SetDefaultPolicyVersionRequest$policyVersionId": "The policy version ID.
" + } + }, + "PolicyVersions": { + "base": null, + "refs": { + "ListPolicyVersionsResponse$policyVersions": "The policy versions.
" + } + }, + "Principal": { + "base": null, + "refs": { + "AttachPrincipalPolicyRequest$principal": "The principal, which can be a certificate ARN (as returned from the CreateCertificate operation) or an Amazon Cognito ID.
", + "AttachThingPrincipalRequest$principal": "The principal (certificate or other credential).
", + "DetachPrincipalPolicyRequest$principal": "The principal.
If the principal is a certificate, specify the certificate ARN. If the principal is an Amazon Cognito identity, specify the identity ID.
", + "DetachThingPrincipalRequest$principal": "The principal.
If the principal is a certificate, specify the certificate ARN. If the principal is an Amazon Cognito identity, specify the identity ID.
", + "ListPrincipalPoliciesRequest$principal": "The principal.
", + "ListPrincipalThingsRequest$principal": "The principal.
" + } + }, + "PrincipalArn": { + "base": null, + "refs": { + "Principals$member": null + } + }, + "Principals": { + "base": null, + "refs": { + "ListPolicyPrincipalsResponse$principals": "The descriptions of the principals.
", + "ListThingPrincipalsResponse$principals": "The principals.
" + } + }, + "PrivateKey": { + "base": null, + "refs": { + "KeyPair$PrivateKey": "The private key.
" + } + }, + "PublicKey": { + "base": null, + "refs": { + "KeyPair$PublicKey": "The public key.
" + } + }, + "QueueUrl": { + "base": null, + "refs": { + "SqsAction$queueUrl": "The URL of the Amazon SQS queue.
" + } + }, + "RangeKeyField": { + "base": null, + "refs": { + "DynamoDBAction$rangeKeyField": "The range key name.
" + } + }, + "RangeKeyValue": { + "base": null, + "refs": { + "DynamoDBAction$rangeKeyValue": "The range key value.
" + } + }, + "RegisterCACertificateRequest": { + "base": "The input to the RegisterCACertificate operation.
", + "refs": { + } + }, + "RegisterCACertificateResponse": { + "base": "The output from the RegisterCACertificateResponse operation.
", + "refs": { + } + }, + "RegisterCertificateRequest": { + "base": "The input to the RegisterCertificate operation.
", + "refs": { + } + }, + "RegisterCertificateResponse": { + "base": "The output from the RegisterCertificate operation.
", + "refs": { + } + }, + "RegistrationCode": { + "base": null, + "refs": { + "GetRegistrationCodeResponse$registrationCode": "The CA certificate registration code.
" + } + }, + "RegistrationCodeValidationException": { + "base": "The registration code is invalid.
", + "refs": { + } + }, + "RejectCertificateTransferRequest": { + "base": "The input for the RejectCertificateTransfer operation.
", + "refs": { + } + }, + "ReplaceTopicRuleRequest": { + "base": "The input for the ReplaceTopicRule operation.
", + "refs": { + } + }, + "RepublishAction": { + "base": "Describes an action to republish to another topic.
", + "refs": { + "Action$republish": "Publish to another MQTT topic.
" + } + }, + "ResourceAlreadyExistsException": { + "base": "The resource already exists.
", + "refs": { + } + }, + "ResourceNotFoundException": { + "base": "The specified resource does not exist.
", + "refs": { + } + }, + "RuleArn": { + "base": null, + "refs": { + "GetTopicRuleResponse$ruleArn": "The rule ARN.
", + "TopicRuleListItem$ruleArn": "The rule ARN.
" + } + }, + "RuleName": { + "base": null, + "refs": { + "CreateTopicRuleRequest$ruleName": "The name of the rule.
", + "DeleteTopicRuleRequest$ruleName": "The name of the rule.
", + "DisableTopicRuleRequest$ruleName": "The name of the rule to disable.
", + "EnableTopicRuleRequest$ruleName": "The name of the topic rule to enable.
", + "GetTopicRuleRequest$ruleName": "The name of the rule.
", + "ReplaceTopicRuleRequest$ruleName": "The name of the rule.
", + "TopicRule$ruleName": "The name of the rule.
", + "TopicRuleListItem$ruleName": "The name of the rule.
" + } + }, + "S3Action": { + "base": "Describes an action to write data to an Amazon S3 bucket.
", + "refs": { + "Action$s3": "Write to an Amazon S3 bucket.
" + } + }, + "SQL": { + "base": null, + "refs": { + "TopicRule$sql": "The SQL statement used to query the topic. When using a SQL query with multiple lines, be sure to escape the newline characters.
", + "TopicRulePayload$sql": "The SQL statement used to query the topic. For more information, see AWS IoT SQL Reference in the AWS IoT Developer Guide.
" + } + }, + "ServiceUnavailableException": { + "base": "The service is temporarily unavailable.
", + "refs": { + } + }, + "SetAsActive": { + "base": null, + "refs": { + "AcceptCertificateTransferRequest$setAsActive": "Specifies whether the certificate is active.
", + "CreateCertificateFromCsrRequest$setAsActive": "Specifies whether the certificate is active.
", + "CreateKeysAndCertificateRequest$setAsActive": "Specifies whether the certificate is active.
", + "RegisterCACertificateRequest$setAsActive": "A boolean value that specifies if the CA certificate is set to active.
", + "RegisterCertificateRequest$setAsActive": "A boolean value that specifies if the CA certificate is set to active.
" + } + }, + "SetAsDefault": { + "base": null, + "refs": { + "CreatePolicyVersionRequest$setAsDefault": "Specifies whether the policy version is set as the default. When this parameter is true, the new policy version becomes the operative version (that is, the version that is in effect for the certificates to which the policy is attached).
" + } + }, + "SetDefaultPolicyVersionRequest": { + "base": "The input for the SetDefaultPolicyVersion operation.
", + "refs": { + } + }, + "SetLoggingOptionsRequest": { + "base": "The input for the SetLoggingOptions operation.
", + "refs": { + } + }, + "SnsAction": { + "base": "Describes an action to publish to an Amazon SNS topic.
", + "refs": { + "Action$sns": "Publish to an Amazon SNS topic.
" + } + }, + "SqlParseException": { + "base": "The Rule-SQL expression can't be parsed correctly.
", + "refs": { + } + }, + "SqsAction": { + "base": "Describes an action to publish data to an Amazon SQS queue.
", + "refs": { + "Action$sqs": "Publish to an Amazon SQS queue.
" + } + }, + "StateReason": { + "base": null, + "refs": { + "CloudwatchAlarmAction$stateReason": "The reason for the alarm change.
" + } + }, + "StateValue": { + "base": null, + "refs": { + "CloudwatchAlarmAction$stateValue": "The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA.
" + } + }, + "StreamName": { + "base": null, + "refs": { + "KinesisAction$streamName": "The name of the Amazon Kinesis stream.
" + } + }, + "TableName": { + "base": null, + "refs": { + "DynamoDBAction$tableName": "The name of the DynamoDB table.
" + } + }, + "ThingArn": { + "base": null, + "refs": { + "CreateThingResponse$thingArn": "The thing ARN.
" + } + }, + "ThingAttribute": { + "base": "Describes a thing attribute.
", + "refs": { + "ThingAttributeList$member": null + } + }, + "ThingAttributeList": { + "base": null, + "refs": { + "ListThingsResponse$things": "The things.
" + } + }, + "ThingName": { + "base": null, + "refs": { + "AttachThingPrincipalRequest$thingName": "The name of the thing.
", + "CreateThingRequest$thingName": "The name of the thing.
", + "CreateThingResponse$thingName": "The name of the thing.
", + "DeleteThingRequest$thingName": "The thing name.
", + "DescribeThingRequest$thingName": "The name of the thing.
", + "DescribeThingResponse$thingName": "The name of the thing.
", + "DetachThingPrincipalRequest$thingName": "The name of the thing.
", + "ListThingPrincipalsRequest$thingName": "The name of the thing.
", + "ThingAttribute$thingName": "The name of the thing.
", + "ThingNameList$member": null, + "UpdateThingRequest$thingName": "The thing name.
" + } + }, + "ThingNameList": { + "base": null, + "refs": { + "ListPrincipalThingsResponse$things": "The things.
" + } + }, + "ThrottlingException": { + "base": "The rate exceeds the limit.
", + "refs": { + } + }, + "Topic": { + "base": null, + "refs": { + "ListTopicRulesRequest$topic": "The topic.
" + } + }, + "TopicPattern": { + "base": null, + "refs": { + "RepublishAction$topic": "The name of the MQTT topic.
", + "TopicRuleListItem$topicPattern": "The pattern for the topic names that apply.
" + } + }, + "TopicRule": { + "base": "Describes a rule.
", + "refs": { + "GetTopicRuleResponse$rule": "The rule.
" + } + }, + "TopicRuleList": { + "base": null, + "refs": { + "ListTopicRulesResponse$rules": "The rules.
" + } + }, + "TopicRuleListItem": { + "base": "Describes a rule.
", + "refs": { + "TopicRuleList$member": null + } + }, + "TopicRulePayload": { + "base": "Describes a rule.
", + "refs": { + "CreateTopicRuleRequest$topicRulePayload": "The rule payload.
", + "ReplaceTopicRuleRequest$topicRulePayload": "The rule payload.
" + } + }, + "TransferAlreadyCompletedException": { + "base": "You can't revert the certificate transfer because the transfer is already complete.
", + "refs": { + } + }, + "TransferCertificateRequest": { + "base": "The input for the TransferCertificate operation.
", + "refs": { + } + }, + "TransferCertificateResponse": { + "base": "The output from the TransferCertificate operation.
", + "refs": { + } + }, + "TransferConflictException": { + "base": "You can't transfer the certificate because authorization policies are still attached.
", + "refs": { + } + }, + "TransferData": { + "base": "Data used to transfer a certificate to an AWS account.
", + "refs": { + "CertificateDescription$transferData": "The transfer data.
" + } + }, + "UnauthorizedException": { + "base": "You are not authorized to perform this operation.
", + "refs": { + } + }, + "UpdateCACertificateRequest": { + "base": "The input to the UpdateCACertificate operation.
", + "refs": { + } + }, + "UpdateCertificateRequest": { + "base": "The input for the UpdateCertificate operation.
", + "refs": { + } + }, + "UpdateThingRequest": { + "base": "The input for the UpdateThing operation.
", + "refs": { + } + }, + "UpdateThingResponse": { + "base": "The output from the UpdateThing operation.
", + "refs": { + } + }, + "UseBase64": { + "base": null, + "refs": { + "SqsAction$useBase64": "Specifies whether to use Base64 encoding.
" + } + }, + "VersionsLimitExceededException": { + "base": "The number of policy versions exceeds the limit.
", + "refs": { + } + }, + "errorMessage": { + "base": null, + "refs": { + "CertificateConflictException$message": "The message for the exception.
", + "CertificateStateException$message": "The message for the exception.
", + "CertificateValidationException$message": "Additional information about the exception.
", + "DeleteConflictException$message": "The message for the exception.
", + "InternalException$message": "The message for the exception.
", + "InternalFailureException$message": "The message for the exception.
", + "InvalidRequestException$message": "The message for the exception.
", + "LimitExceededException$message": "The message for the exception.
", + "MalformedPolicyException$message": "The message for the exception.
", + "RegistrationCodeValidationException$message": "Additional information about the exception.
", + "ResourceAlreadyExistsException$message": "The message for the exception.
", + "ResourceNotFoundException$message": "The message for the exception.
", + "ServiceUnavailableException$message": "The message for the exception.
", + "SqlParseException$message": "The message for the exception.
", + "ThrottlingException$message": "The message for the exception.
", + "TransferAlreadyCompletedException$message": "The message for the exception.
", + "TransferConflictException$message": "The message for the exception.
", + "UnauthorizedException$message": "The message for the exception.
", + "VersionsLimitExceededException$message": "The message for the exception.
" + } + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/iot/2015-05-28/examples-1.json b/vendor/github.com/aws/aws-sdk-go/models/apis/iot/2015-05-28/examples-1.json new file mode 100644 index 000000000..faff76894 --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/iot/2015-05-28/examples-1.json @@ -0,0 +1,5 @@ +{ + "version":"1.0", + "examples":{ + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/kinesis/2013-12-02/api-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/kinesis/2013-12-02/api-2.json new file mode 100644 index 000000000..1f24a5aaf --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/kinesis/2013-12-02/api-2.json @@ -0,0 +1,822 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2013-12-02", + "endpointPrefix":"kinesis", + "jsonVersion":"1.1", + "protocol":"json", + "serviceAbbreviation":"Kinesis", + "serviceFullName":"Amazon Kinesis", + "signatureVersion":"v4", + "targetPrefix":"Kinesis_20131202" + }, + "operations":{ + "AddTagsToStream":{ + "name":"AddTagsToStream", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddTagsToStreamInput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"LimitExceededException"} + ] + }, + "CreateStream":{ + "name":"CreateStream", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateStreamInput"}, + "errors":[ + {"shape":"ResourceInUseException"}, + {"shape":"LimitExceededException"}, + {"shape":"InvalidArgumentException"} + ] + }, + "DecreaseStreamRetentionPeriod":{ + "name":"DecreaseStreamRetentionPeriod", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DecreaseStreamRetentionPeriodInput"}, + "errors":[ + {"shape":"ResourceInUseException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"InvalidArgumentException"} + ] + }, + "DeleteStream":{ + "name":"DeleteStream", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteStreamInput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"LimitExceededException"} + ] + }, + "DescribeStream":{ + "name":"DescribeStream", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeStreamInput"}, + "output":{"shape":"DescribeStreamOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"LimitExceededException"} + ] + }, + "DisableEnhancedMonitoring":{ + "name":"DisableEnhancedMonitoring", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisableEnhancedMonitoringInput"}, + "output":{"shape":"EnhancedMonitoringOutput"}, + "errors":[ + {"shape":"InvalidArgumentException"}, + {"shape":"LimitExceededException"}, + {"shape":"ResourceInUseException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "EnableEnhancedMonitoring":{ + "name":"EnableEnhancedMonitoring", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"EnableEnhancedMonitoringInput"}, + "output":{"shape":"EnhancedMonitoringOutput"}, + "errors":[ + {"shape":"InvalidArgumentException"}, + {"shape":"LimitExceededException"}, + {"shape":"ResourceInUseException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "GetRecords":{ + "name":"GetRecords", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetRecordsInput"}, + "output":{"shape":"GetRecordsOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"ProvisionedThroughputExceededException"}, + {"shape":"ExpiredIteratorException"} + ] + }, + "GetShardIterator":{ + "name":"GetShardIterator", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetShardIteratorInput"}, + "output":{"shape":"GetShardIteratorOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"ProvisionedThroughputExceededException"} + ] + }, + "IncreaseStreamRetentionPeriod":{ + "name":"IncreaseStreamRetentionPeriod", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"IncreaseStreamRetentionPeriodInput"}, + "errors":[ + {"shape":"ResourceInUseException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"InvalidArgumentException"} + ] + }, + "ListStreams":{ + "name":"ListStreams", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListStreamsInput"}, + "output":{"shape":"ListStreamsOutput"}, + "errors":[ + {"shape":"LimitExceededException"} + ] + }, + "ListTagsForStream":{ + "name":"ListTagsForStream", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForStreamInput"}, + "output":{"shape":"ListTagsForStreamOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"LimitExceededException"} + ] + }, + "MergeShards":{ + "name":"MergeShards", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"MergeShardsInput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"LimitExceededException"} + ] + }, + "PutRecord":{ + "name":"PutRecord", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutRecordInput"}, + "output":{"shape":"PutRecordOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"ProvisionedThroughputExceededException"} + ] + }, + "PutRecords":{ + "name":"PutRecords", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutRecordsInput"}, + "output":{"shape":"PutRecordsOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"ProvisionedThroughputExceededException"} + ] + }, + "RemoveTagsFromStream":{ + "name":"RemoveTagsFromStream", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RemoveTagsFromStreamInput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"LimitExceededException"} + ] + }, + "SplitShard":{ + "name":"SplitShard", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SplitShardInput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"LimitExceededException"} + ] + } + }, + "shapes":{ + "AddTagsToStreamInput":{ + "type":"structure", + "required":[ + "StreamName", + "Tags" + ], + "members":{ + "StreamName":{"shape":"StreamName"}, + "Tags":{"shape":"TagMap"} + } + }, + "ApproximateArrivalTimestamp":{"type":"timestamp"}, + "BooleanObject":{"type":"boolean"}, + "CreateStreamInput":{ + "type":"structure", + "required":[ + "StreamName", + "ShardCount" + ], + "members":{ + "StreamName":{"shape":"StreamName"}, + "ShardCount":{"shape":"PositiveIntegerObject"} + } + }, + "Data":{ + "type":"blob", + "max":1048576, + "min":0 + }, + "DecreaseStreamRetentionPeriodInput":{ + "type":"structure", + "required":[ + "StreamName", + "RetentionPeriodHours" + ], + "members":{ + "StreamName":{"shape":"StreamName"}, + "RetentionPeriodHours":{"shape":"RetentionPeriodHours"} + } + }, + "DeleteStreamInput":{ + "type":"structure", + "required":["StreamName"], + "members":{ + "StreamName":{"shape":"StreamName"} + } + }, + "DescribeStreamInput":{ + "type":"structure", + "required":["StreamName"], + "members":{ + "StreamName":{"shape":"StreamName"}, + "Limit":{"shape":"DescribeStreamInputLimit"}, + "ExclusiveStartShardId":{"shape":"ShardId"} + } + }, + "DescribeStreamInputLimit":{ + "type":"integer", + "max":10000, + "min":1 + }, + "DescribeStreamOutput":{ + "type":"structure", + "required":["StreamDescription"], + "members":{ + "StreamDescription":{"shape":"StreamDescription"} + } + }, + "DisableEnhancedMonitoringInput":{ + "type":"structure", + "required":[ + "StreamName", + "ShardLevelMetrics" + ], + "members":{ + "StreamName":{"shape":"StreamName"}, + "ShardLevelMetrics":{"shape":"MetricsNameList"} + } + }, + "EnableEnhancedMonitoringInput":{ + "type":"structure", + "required":[ + "StreamName", + "ShardLevelMetrics" + ], + "members":{ + "StreamName":{"shape":"StreamName"}, + "ShardLevelMetrics":{"shape":"MetricsNameList"} + } + }, + "EnhancedMetrics":{ + "type":"structure", + "members":{ + "ShardLevelMetrics":{"shape":"MetricsNameList"} + } + }, + "EnhancedMonitoringList":{ + "type":"list", + "member":{"shape":"EnhancedMetrics"} + }, + "EnhancedMonitoringOutput":{ + "type":"structure", + "members":{ + "StreamName":{"shape":"StreamName"}, + "CurrentShardLevelMetrics":{"shape":"MetricsNameList"}, + "DesiredShardLevelMetrics":{"shape":"MetricsNameList"} + } + }, + "ErrorCode":{"type":"string"}, + "ErrorMessage":{"type":"string"}, + "ExpiredIteratorException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true + }, + "GetRecordsInput":{ + "type":"structure", + "required":["ShardIterator"], + "members":{ + "ShardIterator":{"shape":"ShardIterator"}, + "Limit":{"shape":"GetRecordsInputLimit"} + } + }, + "GetRecordsInputLimit":{ + "type":"integer", + "max":10000, + "min":1 + }, + "GetRecordsOutput":{ + "type":"structure", + "required":["Records"], + "members":{ + "Records":{"shape":"RecordList"}, + "NextShardIterator":{"shape":"ShardIterator"}, + "MillisBehindLatest":{"shape":"MillisBehindLatest"} + } + }, + "GetShardIteratorInput":{ + "type":"structure", + "required":[ + "StreamName", + "ShardId", + "ShardIteratorType" + ], + "members":{ + "StreamName":{"shape":"StreamName"}, + "ShardId":{"shape":"ShardId"}, + "ShardIteratorType":{"shape":"ShardIteratorType"}, + "StartingSequenceNumber":{"shape":"SequenceNumber"}, + "Timestamp":{"shape":"Timestamp"} + } + }, + "GetShardIteratorOutput":{ + "type":"structure", + "members":{ + "ShardIterator":{"shape":"ShardIterator"} + } + }, + "HashKey":{ + "type":"string", + "pattern":"0|([1-9]\\d{0,38})" + }, + "HashKeyRange":{ + "type":"structure", + "required":[ + "StartingHashKey", + "EndingHashKey" + ], + "members":{ + "StartingHashKey":{"shape":"HashKey"}, + "EndingHashKey":{"shape":"HashKey"} + } + }, + "IncreaseStreamRetentionPeriodInput":{ + "type":"structure", + "required":[ + "StreamName", + "RetentionPeriodHours" + ], + "members":{ + "StreamName":{"shape":"StreamName"}, + "RetentionPeriodHours":{"shape":"RetentionPeriodHours"} + } + }, + "InvalidArgumentException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true + }, + "ListStreamsInput":{ + "type":"structure", + "members":{ + "Limit":{"shape":"ListStreamsInputLimit"}, + "ExclusiveStartStreamName":{"shape":"StreamName"} + } + }, + "ListStreamsInputLimit":{ + "type":"integer", + "max":10000, + "min":1 + }, + "ListStreamsOutput":{ + "type":"structure", + "required":[ + "StreamNames", + "HasMoreStreams" + ], + "members":{ + "StreamNames":{"shape":"StreamNameList"}, + "HasMoreStreams":{"shape":"BooleanObject"} + } + }, + "ListTagsForStreamInput":{ + "type":"structure", + "required":["StreamName"], + "members":{ + "StreamName":{"shape":"StreamName"}, + "ExclusiveStartTagKey":{"shape":"TagKey"}, + "Limit":{"shape":"ListTagsForStreamInputLimit"} + } + }, + "ListTagsForStreamInputLimit":{ + "type":"integer", + "max":10, + "min":1 + }, + "ListTagsForStreamOutput":{ + "type":"structure", + "required":[ + "Tags", + "HasMoreTags" + ], + "members":{ + "Tags":{"shape":"TagList"}, + "HasMoreTags":{"shape":"BooleanObject"} + } + }, + "MergeShardsInput":{ + "type":"structure", + "required":[ + "StreamName", + "ShardToMerge", + "AdjacentShardToMerge" + ], + "members":{ + "StreamName":{"shape":"StreamName"}, + "ShardToMerge":{"shape":"ShardId"}, + "AdjacentShardToMerge":{"shape":"ShardId"} + } + }, + "MetricsName":{ + "type":"string", + "enum":[ + "IncomingBytes", + "IncomingRecords", + "OutgoingBytes", + "OutgoingRecords", + "WriteProvisionedThroughputExceeded", + "ReadProvisionedThroughputExceeded", + "IteratorAgeMilliseconds", + "ALL" + ] + }, + "MetricsNameList":{ + "type":"list", + "member":{"shape":"MetricsName"}, + "max":7, + "min":1 + }, + "MillisBehindLatest":{ + "type":"long", + "min":0 + }, + "PartitionKey":{ + "type":"string", + "max":256, + "min":1 + }, + "PositiveIntegerObject":{ + "type":"integer", + "max":100000, + "min":1 + }, + "ProvisionedThroughputExceededException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true + }, + "PutRecordInput":{ + "type":"structure", + "required":[ + "StreamName", + "Data", + "PartitionKey" + ], + "members":{ + "StreamName":{"shape":"StreamName"}, + "Data":{"shape":"Data"}, + "PartitionKey":{"shape":"PartitionKey"}, + "ExplicitHashKey":{"shape":"HashKey"}, + "SequenceNumberForOrdering":{"shape":"SequenceNumber"} + } + }, + "PutRecordOutput":{ + "type":"structure", + "required":[ + "ShardId", + "SequenceNumber" + ], + "members":{ + "ShardId":{"shape":"ShardId"}, + "SequenceNumber":{"shape":"SequenceNumber"} + } + }, + "PutRecordsInput":{ + "type":"structure", + "required":[ + "Records", + "StreamName" + ], + "members":{ + "Records":{"shape":"PutRecordsRequestEntryList"}, + "StreamName":{"shape":"StreamName"} + } + }, + "PutRecordsOutput":{ + "type":"structure", + "required":["Records"], + "members":{ + "FailedRecordCount":{"shape":"PositiveIntegerObject"}, + "Records":{"shape":"PutRecordsResultEntryList"} + } + }, + "PutRecordsRequestEntry":{ + "type":"structure", + "required":[ + "Data", + "PartitionKey" + ], + "members":{ + "Data":{"shape":"Data"}, + "ExplicitHashKey":{"shape":"HashKey"}, + "PartitionKey":{"shape":"PartitionKey"} + } + }, + "PutRecordsRequestEntryList":{ + "type":"list", + "member":{"shape":"PutRecordsRequestEntry"}, + "max":500, + "min":1 + }, + "PutRecordsResultEntry":{ + "type":"structure", + "members":{ + "SequenceNumber":{"shape":"SequenceNumber"}, + "ShardId":{"shape":"ShardId"}, + "ErrorCode":{"shape":"ErrorCode"}, + "ErrorMessage":{"shape":"ErrorMessage"} + } + }, + "PutRecordsResultEntryList":{ + "type":"list", + "member":{"shape":"PutRecordsResultEntry"}, + "max":500, + "min":1 + }, + "Record":{ + "type":"structure", + "required":[ + "SequenceNumber", + "Data", + "PartitionKey" + ], + "members":{ + "SequenceNumber":{"shape":"SequenceNumber"}, + "ApproximateArrivalTimestamp":{"shape":"ApproximateArrivalTimestamp"}, + "Data":{"shape":"Data"}, + "PartitionKey":{"shape":"PartitionKey"} + } + }, + "RecordList":{ + "type":"list", + "member":{"shape":"Record"} + }, + "RemoveTagsFromStreamInput":{ + "type":"structure", + "required":[ + "StreamName", + "TagKeys" + ], + "members":{ + "StreamName":{"shape":"StreamName"}, + "TagKeys":{"shape":"TagKeyList"} + } + }, + "ResourceInUseException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true + }, + "RetentionPeriodHours":{ + "type":"integer", + "max":168, + "min":24 + }, + "SequenceNumber":{ + "type":"string", + "pattern":"0|([1-9]\\d{0,128})" + }, + "SequenceNumberRange":{ + "type":"structure", + "required":["StartingSequenceNumber"], + "members":{ + "StartingSequenceNumber":{"shape":"SequenceNumber"}, + "EndingSequenceNumber":{"shape":"SequenceNumber"} + } + }, + "Shard":{ + "type":"structure", + "required":[ + "ShardId", + "HashKeyRange", + "SequenceNumberRange" + ], + "members":{ + "ShardId":{"shape":"ShardId"}, + "ParentShardId":{"shape":"ShardId"}, + "AdjacentParentShardId":{"shape":"ShardId"}, + "HashKeyRange":{"shape":"HashKeyRange"}, + "SequenceNumberRange":{"shape":"SequenceNumberRange"} + } + }, + "ShardId":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[a-zA-Z0-9_.-]+" + }, + "ShardIterator":{ + "type":"string", + "max":512, + "min":1 + }, + "ShardIteratorType":{ + "type":"string", + "enum":[ + "AT_SEQUENCE_NUMBER", + "AFTER_SEQUENCE_NUMBER", + "TRIM_HORIZON", + "LATEST", + "AT_TIMESTAMP" + ] + }, + "ShardList":{ + "type":"list", + "member":{"shape":"Shard"} + }, + "SplitShardInput":{ + "type":"structure", + "required":[ + "StreamName", + "ShardToSplit", + "NewStartingHashKey" + ], + "members":{ + "StreamName":{"shape":"StreamName"}, + "ShardToSplit":{"shape":"ShardId"}, + "NewStartingHashKey":{"shape":"HashKey"} + } + }, + "StreamARN":{"type":"string"}, + "StreamDescription":{ + "type":"structure", + "required":[ + "StreamName", + "StreamARN", + "StreamStatus", + "Shards", + "HasMoreShards", + "RetentionPeriodHours", + "EnhancedMonitoring" + ], + "members":{ + "StreamName":{"shape":"StreamName"}, + "StreamARN":{"shape":"StreamARN"}, + "StreamStatus":{"shape":"StreamStatus"}, + "Shards":{"shape":"ShardList"}, + "HasMoreShards":{"shape":"BooleanObject"}, + "RetentionPeriodHours":{"shape":"RetentionPeriodHours"}, + "EnhancedMonitoring":{"shape":"EnhancedMonitoringList"} + } + }, + "StreamName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[a-zA-Z0-9_.-]+" + }, + "StreamNameList":{ + "type":"list", + "member":{"shape":"StreamName"} + }, + "StreamStatus":{ + "type":"string", + "enum":[ + "CREATING", + "DELETING", + "ACTIVE", + "UPDATING" + ] + }, + "Tag":{ + "type":"structure", + "required":["Key"], + "members":{ + "Key":{"shape":"TagKey"}, + "Value":{"shape":"TagValue"} + } + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1 + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":10, + "min":1 + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"}, + "min":0 + }, + "TagMap":{ + "type":"map", + "key":{"shape":"TagKey"}, + "value":{"shape":"TagValue"}, + "max":10, + "min":1 + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0 + }, + "Timestamp":{"type":"timestamp"} + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/kinesis/2013-12-02/docs-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/kinesis/2013-12-02/docs-2.json new file mode 100644 index 000000000..09cf0fc16 --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/kinesis/2013-12-02/docs-2.json @@ -0,0 +1,506 @@ +{ + "version": "2.0", + "service": "Amazon Kinesis Streams is a managed service that scales elastically for real time processing of streaming big data.
", + "operations": { + "AddTagsToStream": "Adds or updates tags for the specified Amazon Kinesis stream. Each stream can have up to 10 tags.
If tags have already been assigned to the stream, AddTagsToStream overwrites any existing tags that correspond to the specified tag keys.
Creates an Amazon Kinesis stream. A stream captures and transports data records that are continuously emitted from different data sources or producers. Scale-out within a stream is explicitly supported by means of shards, which are uniquely identified groups of data records in a stream.
You specify and control the number of shards that a stream is composed of. Each shard can support reads up to 5 transactions per second, up to a maximum data read total of 2 MB per second. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MB per second. You can add shards to a stream if the amount of data input increases and you can remove shards if the amount of data input decreases.
The stream name identifies the stream. The name is scoped to the AWS account used by the application. It is also scoped by region. That is, two streams in two different accounts can have the same name, and two streams in the same account, but in two different regions, can have the same name.
CreateStream is an asynchronous operation. Upon receiving a CreateStream request, Amazon Kinesis immediately returns and sets the stream status to CREATING. After the stream is created, Amazon Kinesis sets the stream status to ACTIVE. You should perform read and write operations only on an ACTIVE stream.
You receive a LimitExceededException when making a CreateStream request if you try to do one of the following:
CREATING state at any point in time.For the default shard limit for an AWS account, see Streams Limits in the Amazon Kinesis Streams Developer Guide. If you need to increase this limit, contact AWS Support.
You can use DescribeStream to check the stream status, which is returned in StreamStatus.
CreateStream has a limit of 5 transactions per second per account.
", + "DecreaseStreamRetentionPeriod": "Decreases the Amazon Kinesis stream's retention period, which is the length of time data records are accessible after they are added to the stream. The minimum value of a stream's retention period is 24 hours.
This operation may result in lost data. For example, if the stream's retention period is 48 hours and is decreased to 24 hours, any data already in the stream that is older than 24 hours is inaccessible.
", + "DeleteStream": "Deletes an Amazon Kinesis stream and all its shards and data. You must shut down any applications that are operating on the stream before you delete the stream. If an application attempts to operate on a deleted stream, it will receive the exception ResourceNotFoundException.
If the stream is in the ACTIVE state, you can delete it. After a DeleteStream request, the specified stream is in the DELETING state until Amazon Kinesis completes the deletion.
Note: Amazon Kinesis might continue to accept data read and write operations, such as PutRecord, PutRecords, and GetRecords, on a stream in the DELETING state until the stream deletion is complete.
When you delete a stream, any shards in that stream are also deleted, and any tags are dissociated from the stream.
You can use the DescribeStream operation to check the state of the stream, which is returned in StreamStatus.
DeleteStream has a limit of 5 transactions per second per account.
", + "DescribeStream": "Describes the specified Amazon Kinesis stream.
The information about the stream includes its current status, its Amazon Resource Name (ARN), and an array of shard objects. For each shard object, there is information about the hash key and sequence number ranges that the shard spans, and the IDs of any earlier shards that played in a role in creating the shard. A sequence number is the identifier associated with every record ingested in the stream. The sequence number is assigned when a record is put into the stream.
You can limit the number of returned shards using the Limit parameter. The number of shards in a stream may be too large to return from a single call to DescribeStream. You can detect this by using the HasMoreShards flag in the returned output. HasMoreShards is set to true when there is more data available.
DescribeStream is a paginated operation. If there are more shards available, you can request them using the shard ID of the last shard returned. Specify this ID in the ExclusiveStartShardId parameter in a subsequent request to DescribeStream.
There are no guarantees about the chronological order shards returned in DescribeStream results. If you want to process shards in chronological order, use ParentShardId to track lineage to the oldest shard.
DescribeStream has a limit of 10 transactions per second per account.
", + "DisableEnhancedMonitoring": "Disables enhanced monitoring.
", + "EnableEnhancedMonitoring": "Enables enhanced Amazon Kinesis stream monitoring for shard-level metrics.
", + "GetRecords": "Gets data records from an Amazon Kinesis stream's shard.
Specify a shard iterator using the ShardIterator parameter. The shard iterator specifies the position in the shard from which you want to start reading data records sequentially. If there are no records available in the portion of the shard that the iterator points to, GetRecords returns an empty list. Note that it might take multiple calls to get to a portion of the shard that contains records.
You can scale by provisioning multiple shards per stream while considering service limits (for more information, see Streams Limits in the Amazon Kinesis Streams Developer Guide). Your application should have one thread per shard, each reading continuously from its stream. To read from a stream continually, call GetRecords in a loop. Use GetShardIterator to get the shard iterator to specify in the first GetRecords call. GetRecords returns a new shard iterator in NextShardIterator. Specify the shard iterator returned in NextShardIterator in subsequent calls to GetRecords. Note that if the shard has been closed, the shard iterator can't return more data and GetRecords returns null in NextShardIterator. You can terminate the loop when the shard is closed, or when the shard iterator reaches the record with the sequence number or other attribute that marks it as the last record to process.
Each data record can be up to 1 MB in size, and each shard can read up to 2 MB per second. You can ensure that your calls don't exceed the maximum supported size or throughput by using the Limit parameter to specify the maximum number of records that GetRecords can return. Consider your average record size when determining this limit.
The size of the data returned by GetRecords varies depending on the utilization of the shard. The maximum size of data that GetRecords can return is 10 MB. If a call returns this amount of data, subsequent calls made within the next 5 seconds throw ProvisionedThroughputExceededException. If there is insufficient provisioned throughput on the shard, subsequent calls made within the next 1 second throw ProvisionedThroughputExceededException. Note that GetRecords won't return any data when it throws an exception. For this reason, we recommend that you wait one second between calls to GetRecords; however, it's possible that the application will get exceptions for longer than 1 second.
To detect whether the application is falling behind in processing, you can use the MillisBehindLatest response attribute. You can also monitor the stream using CloudWatch metrics and other mechanisms (see Monitoring in the Amazon Kinesis Streams Developer Guide).
Each Amazon Kinesis record includes a value, ApproximateArrivalTimestamp, that is set when a stream successfully receives and stores a record. This is commonly referred to as a server-side timestamp, whereas a client-side timestamp is set when a data producer creates or sends the record to a stream (a data producer is any data source putting data records into a stream, for example with PutRecords). The timestamp has millisecond precision. There are no guarantees about the timestamp accuracy, or that the timestamp is always increasing. For example, records in a shard or across a stream might have timestamps that are out of order.
Gets an Amazon Kinesis shard iterator. A shard iterator expires five minutes after it is returned to the requester.
A shard iterator specifies the shard position from which to start reading data records sequentially. The position is specified using the sequence number of a data record in a shard. A sequence number is the identifier associated with every record ingested in the stream, and is assigned when a record is put into the stream. Each stream has one or more shards.
You must specify the shard iterator type. For example, you can set the ShardIteratorType parameter to read exactly from the position denoted by a specific sequence number by using the AT_SEQUENCE_NUMBER shard iterator type, or right after the sequence number by using the AFTER_SEQUENCE_NUMBER shard iterator type, using sequence numbers returned by earlier calls to PutRecord, PutRecords, GetRecords, or DescribeStream. In the request, you can specify the shard iterator type AT_TIMESTAMP to read records from an arbitrary point in time, TRIM_HORIZON to cause ShardIterator to point to the last untrimmed record in the shard in the system (the oldest data record in the shard), or LATEST so that you always read the most recent data in the shard.
When you read repeatedly from a stream, use a GetShardIterator request to get the first shard iterator for use in your first GetRecords request and for subsequent reads use the shard iterator returned by the GetRecords request in NextShardIterator. A new shard iterator is returned by every GetRecords request in NextShardIterator, which you use in the ShardIterator parameter of the next GetRecords request.
If a GetShardIterator request is made too often, you receive a ProvisionedThroughputExceededException. For more information about throughput limits, see GetRecords, and Streams Limits in the Amazon Kinesis Streams Developer Guide.
If the shard is closed, GetShardIterator returns a valid iterator for the last sequence number of the shard. Note that a shard can be closed as a result of using SplitShard or MergeShards.
GetShardIterator has a limit of 5 transactions per second per account per open shard.
", + "IncreaseStreamRetentionPeriod": "Increases the Amazon Kinesis stream's retention period, which is the length of time data records are accessible after they are added to the stream. The maximum value of a stream's retention period is 168 hours (7 days).
Upon choosing a longer stream retention period, this operation will increase the time period records are accessible that have not yet expired. However, it will not make previous data that has expired (older than the stream's previous retention period) accessible after the operation has been called. For example, if a stream's retention period is set to 24 hours and is increased to 168 hours, any data that is older than 24 hours will remain inaccessible to consumer applications.
", + "ListStreams": "Lists your Amazon Kinesis streams.
The number of streams may be too large to return from a single call to ListStreams. You can limit the number of returned streams using the Limit parameter. If you do not specify a value for the Limit parameter, Amazon Kinesis uses the default limit, which is currently 10.
You can detect if there are more streams available to list by using the HasMoreStreams flag from the returned output. If there are more streams available, you can request more streams by using the name of the last stream returned by the ListStreams request in the ExclusiveStartStreamName parameter in a subsequent request to ListStreams. The group of stream names returned by the subsequent request is then added to the list. You can continue this process until all the stream names have been collected in the list.
ListStreams has a limit of 5 transactions per second per account.
", + "ListTagsForStream": "Lists the tags for the specified Amazon Kinesis stream.
", + "MergeShards": "Merges two adjacent shards in an Amazon Kinesis stream and combines them into a single shard to reduce the stream's capacity to ingest and transport data. Two shards are considered adjacent if the union of the hash key ranges for the two shards form a contiguous set with no gaps. For example, if you have two shards, one with a hash key range of 276...381 and the other with a hash key range of 382...454, then you could merge these two shards into a single shard that would have a hash key range of 276...454. After the merge, the single child shard receives data for all hash key values covered by the two parent shards.
MergeShards is called when there is a need to reduce the overall capacity of a stream because of excess capacity that is not being used. You must specify the shard to be merged and the adjacent shard for a stream. For more information about merging shards, see Merge Two Shards in the Amazon Kinesis Streams Developer Guide.
If the stream is in the ACTIVE state, you can call MergeShards. If a stream is in the CREATING, UPDATING, or DELETING state, MergeShards returns a ResourceInUseException. If the specified stream does not exist, MergeShards returns a ResourceNotFoundException.
You can use DescribeStream to check the state of the stream, which is returned in StreamStatus.
MergeShards is an asynchronous operation. Upon receiving a MergeShards request, Amazon Kinesis immediately returns a response and sets the StreamStatus to UPDATING. After the operation is completed, Amazon Kinesis sets the StreamStatus to ACTIVE. Read and write operations continue to work while the stream is in the UPDATING state.
You use DescribeStream to determine the shard IDs that are specified in the MergeShards request.
If you try to operate on too many streams in parallel using CreateStream, DeleteStream, MergeShards or SplitShard, you will receive a LimitExceededException.
MergeShards has limit of 5 transactions per second per account.
Writes a single data record into an Amazon Kinesis stream. Call PutRecord to send data into the stream for real-time ingestion and subsequent processing, one record at a time. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MB per second.
You must specify the name of the stream that captures, stores, and transports the data; a partition key; and the data blob itself.
The data blob can be any type of data; for example, a segment from a log file, geographic/location data, website clickstream data, and so on.
The partition key is used by Amazon Kinesis to distribute data across shards. Amazon Kinesis segregates the data records that belong to a stream into multiple shards, using the partition key associated with each data record to determine which shard a given data record belongs to.
Partition keys are Unicode strings, with a maximum length limit of 256 characters for each key. An MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards using the hash key ranges of the shards. You can override hashing the partition key to determine the shard by explicitly specifying a hash value using the ExplicitHashKey parameter. For more information, see Adding Data to a Stream in the Amazon Kinesis Streams Developer Guide.
PutRecord returns the shard ID of where the data record was placed and the sequence number that was assigned to the data record.
Sequence numbers increase over time and are specific to a shard within a stream, not across all shards within a stream. To guarantee strictly increasing ordering, write serially to a shard and use the SequenceNumberForOrdering parameter. For more information, see Adding Data to a Stream in the Amazon Kinesis Streams Developer Guide.
If a PutRecord request cannot be processed because of insufficient provisioned throughput on the shard involved in the request, PutRecord throws ProvisionedThroughputExceededException.
Data records are accessible for only 24 hours from the time that they are added to a stream.
", + "PutRecords": "Writes multiple data records into an Amazon Kinesis stream in a single call (also referred to as a PutRecords request). Use this operation to send data into the stream for data ingestion and processing.
Each PutRecords request can support up to 500 records. Each record in the request can be as large as 1 MB, up to a limit of 5 MB for the entire request, including partition keys. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MB per second.
You must specify the name of the stream that captures, stores, and transports the data; and an array of request Records, with each record in the array requiring a partition key and data blob. The record size limit applies to the total size of the partition key and data blob.
The data blob can be any type of data; for example, a segment from a log file, geographic/location data, website clickstream data, and so on.
The partition key is used by Amazon Kinesis as input to a hash function that maps the partition key and associated data to a specific shard. An MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream. For more information, see Adding Data to a Stream in the Amazon Kinesis Streams Developer Guide.
Each record in the Records array may include an optional parameter, ExplicitHashKey, which overrides the partition key to shard mapping. This parameter allows a data producer to determine explicitly the shard where the record is stored. For more information, see Adding Multiple Records with PutRecords in the Amazon Kinesis Streams Developer Guide.
The PutRecords response includes an array of response Records. Each record in the response array directly correlates with a record in the request array using natural ordering, from the top to the bottom of the request and response. The response Records array always includes the same number of records as the request array.
The response Records array includes both successfully and unsuccessfully processed records. Amazon Kinesis attempts to process all records in each PutRecords request. A single record failure does not stop the processing of subsequent records.
A successfully-processed record includes ShardId and SequenceNumber values. The ShardId parameter identifies the shard in the stream where the record is stored. The SequenceNumber parameter is an identifier assigned to the put record, unique to all records in the stream.
An unsuccessfully-processed record includes ErrorCode and ErrorMessage values. ErrorCode reflects the type of error and can be one of the following values: ProvisionedThroughputExceededException or InternalFailure. ErrorMessage provides more detailed information about the ProvisionedThroughputExceededException exception including the account ID, stream name, and shard ID of the record that was throttled. For more information about partially successful responses, see Adding Multiple Records with PutRecords in the Amazon Kinesis Streams Developer Guide.
By default, data records are accessible for only 24 hours from the time that they are added to an Amazon Kinesis stream. This retention period can be modified using the DecreaseStreamRetentionPeriod and IncreaseStreamRetentionPeriod operations.
", + "RemoveTagsFromStream": "Removes tags from the specified Amazon Kinesis stream. Removed tags are deleted and cannot be recovered after this operation successfully completes.
If you specify a tag that does not exist, it is ignored.
", + "SplitShard": "Splits a shard into two new shards in the Amazon Kinesis stream to increase the stream's capacity to ingest and transport data. SplitShard is called when there is a need to increase the overall capacity of a stream because of an expected increase in the volume of data records being ingested.
You can also use SplitShard when a shard appears to be approaching its maximum utilization; for example, the producers sending data into the specific shard are suddenly sending more than previously anticipated. You can also call SplitShard to increase stream capacity, so that more Amazon Kinesis applications can simultaneously read data from the stream for real-time processing.
You must specify the shard to be split and the new hash key, which is the position in the shard where the shard gets split in two. In many cases, the new hash key might simply be the average of the beginning and ending hash key, but it can be any hash key value in the range being mapped into the shard. For more information about splitting shards, see Split a Shard in the Amazon Kinesis Streams Developer Guide.
You can use DescribeStream to determine the shard ID and hash key values for the ShardToSplit and NewStartingHashKey parameters that are specified in the SplitShard request.
SplitShard is an asynchronous operation. Upon receiving a SplitShard request, Amazon Kinesis immediately returns a response and sets the stream status to UPDATING. After the operation is completed, Amazon Kinesis sets the stream status to ACTIVE. Read and write operations continue to work while the stream is in the UPDATING state.
You can use DescribeStream to check the status of the stream, which is returned in StreamStatus. If the stream is in the ACTIVE state, you can call SplitShard. If a stream is in CREATING or UPDATING or DELETING states, DescribeStream returns a ResourceInUseException.
If the specified stream does not exist, DescribeStream returns a ResourceNotFoundException. If you try to create more shards than are authorized for your account, you receive a LimitExceededException.
For the default shard limit for an AWS account, see Streams Limits in the Amazon Kinesis Streams Developer Guide. If you need to increase this limit, contact AWS Support.
If you try to operate on too many streams simultaneously using CreateStream, DeleteStream, MergeShards, and/or SplitShard, you receive a LimitExceededException.
SplitShard has limit of 5 transactions per second per account.
Represents the input for AddTagsToStream.
The approximate time that the record was inserted into the stream.
" + } + }, + "BooleanObject": { + "base": null, + "refs": { + "ListStreamsOutput$HasMoreStreams": "If set to true, there are more streams available to list.
If set to true, more tags are available. To request additional tags, set ExclusiveStartTagKey to the key of the last tag returned.
If set to true, more shards in the stream are available to describe.
Represents the input for CreateStream.
The data blob to put into the record, which is base64-encoded when the blob is serialized. When the data blob (the payload before base64-encoding) is added to the partition key size, the total size must not exceed the maximum record size (1 MB).
", + "PutRecordsRequestEntry$Data": "The data blob to put into the record, which is base64-encoded when the blob is serialized. When the data blob (the payload before base64-encoding) is added to the partition key size, the total size must not exceed the maximum record size (1 MB).
", + "Record$Data": "The data blob. The data in the blob is both opaque and immutable to the Amazon Kinesis service, which does not inspect, interpret, or change the data in the blob in any way. When the data blob (the payload before base64-encoding) is added to the partition key size, the total size must not exceed the maximum record size (1 MB).
" + } + }, + "DecreaseStreamRetentionPeriodInput": { + "base": "Represents the input for DecreaseStreamRetentionPeriod.
", + "refs": { + } + }, + "DeleteStreamInput": { + "base": "Represents the input for DeleteStream.
", + "refs": { + } + }, + "DescribeStreamInput": { + "base": "Represents the input for DescribeStream.
The maximum number of shards to return.
" + } + }, + "DescribeStreamOutput": { + "base": "Represents the output for DescribeStream.
Represents the input for DisableEnhancedMonitoring.
", + "refs": { + } + }, + "EnableEnhancedMonitoringInput": { + "base": "Represents the input for EnableEnhancedMonitoring.
", + "refs": { + } + }, + "EnhancedMetrics": { + "base": "Represents enhanced metrics types.
", + "refs": { + "EnhancedMonitoringList$member": null + } + }, + "EnhancedMonitoringList": { + "base": null, + "refs": { + "StreamDescription$EnhancedMonitoring": "Represents the current enhanced monitoring settings of the stream.
" + } + }, + "EnhancedMonitoringOutput": { + "base": "Represents the output for EnableEnhancedMonitoring and DisableEnhancedMonitoring.
", + "refs": { + } + }, + "ErrorCode": { + "base": null, + "refs": { + "PutRecordsResultEntry$ErrorCode": "The error code for an individual record result. ErrorCodes can be either ProvisionedThroughputExceededException or InternalFailure.
A message that provides information about the error.
", + "InvalidArgumentException$message": "A message that provides information about the error.
", + "LimitExceededException$message": "A message that provides information about the error.
", + "ProvisionedThroughputExceededException$message": "A message that provides information about the error.
", + "PutRecordsResultEntry$ErrorMessage": "The error message for an individual record result. An ErrorCode value of ProvisionedThroughputExceededException has an error message that includes the account ID, stream name, and shard ID. An ErrorCode value of InternalFailure has the error message \"Internal Service Failure\".
A message that provides information about the error.
", + "ResourceNotFoundException$message": "A message that provides information about the error.
" + } + }, + "ExpiredIteratorException": { + "base": "The provided iterator exceeds the maximum age allowed.
", + "refs": { + } + }, + "GetRecordsInput": { + "base": "Represents the input for GetRecords.
", + "refs": { + } + }, + "GetRecordsInputLimit": { + "base": null, + "refs": { + "GetRecordsInput$Limit": "The maximum number of records to return. Specify a value of up to 10,000. If you specify a value that is greater than 10,000, GetRecords throws InvalidArgumentException.
Represents the output for GetRecords.
", + "refs": { + } + }, + "GetShardIteratorInput": { + "base": "Represents the input for GetShardIterator.
Represents the output for GetShardIterator.
The starting hash key of the hash key range.
", + "HashKeyRange$EndingHashKey": "The ending hash key of the hash key range.
", + "PutRecordInput$ExplicitHashKey": "The hash value used to explicitly determine the shard the data record is assigned to by overriding the partition key hash.
", + "PutRecordsRequestEntry$ExplicitHashKey": "The hash value used to determine explicitly the shard that the data record is assigned to by overriding the partition key hash.
", + "SplitShardInput$NewStartingHashKey": "A hash key value for the starting hash key of one of the child shards created by the split. The hash key range for a given shard constitutes a set of ordered contiguous positive integers. The value for NewStartingHashKey must be in the range of hash keys being mapped into the shard. The NewStartingHashKey hash key value and all higher hash key values in hash key range are distributed to one of the child shards. All the lower hash key values in the range are distributed to the other child shard.
The range of possible hash key values for the shard, which is a set of ordered contiguous positive integers.
", + "refs": { + "Shard$HashKeyRange": "The range of possible hash key values for the shard, which is a set of ordered contiguous positive integers.
" + } + }, + "IncreaseStreamRetentionPeriodInput": { + "base": "Represents the input for IncreaseStreamRetentionPeriod.
", + "refs": { + } + }, + "InvalidArgumentException": { + "base": "A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.
", + "refs": { + } + }, + "LimitExceededException": { + "base": "The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed (5).
", + "refs": { + } + }, + "ListStreamsInput": { + "base": "Represents the input for ListStreams.
The maximum number of streams to list.
" + } + }, + "ListStreamsOutput": { + "base": "Represents the output for ListStreams.
Represents the input for ListTagsForStream.
The number of tags to return. If this number is less than the total number of tags associated with the stream, HasMoreTags is set to true. To list additional tags, set ExclusiveStartTagKey to the last key in the response.
Represents the output for ListTagsForStream.
Represents the input for MergeShards.
List of shard-level metrics to disable.
The following are the valid shard-level metrics. The value \"ALL\" disables every metric.
IncomingBytes IncomingRecords OutgoingBytes OutgoingRecords WriteProvisionedThroughputExceeded ReadProvisionedThroughputExceeded IteratorAgeMilliseconds ALL For more information, see Monitoring the Amazon Kinesis Streams Service with Amazon CloudWatch in the Amazon Kinesis Streams Developer Guide.
", + "EnableEnhancedMonitoringInput$ShardLevelMetrics": "List of shard-level metrics to enable.
The following are the valid shard-level metrics. The value \"ALL\" enables every metric.
IncomingBytes IncomingRecords OutgoingBytes OutgoingRecords WriteProvisionedThroughputExceeded ReadProvisionedThroughputExceeded IteratorAgeMilliseconds ALL For more information, see Monitoring the Amazon Kinesis Streams Service with Amazon CloudWatch in the Amazon Kinesis Streams Developer Guide.
", + "EnhancedMetrics$ShardLevelMetrics": "List of shard-level metrics.
The following are the valid shard-level metrics. The value \"ALL\" enhances every metric.
IncomingBytes IncomingRecords OutgoingBytes OutgoingRecords WriteProvisionedThroughputExceeded ReadProvisionedThroughputExceeded IteratorAgeMilliseconds ALL For more information, see Monitoring the Amazon Kinesis Streams Service with Amazon CloudWatch in the Amazon Kinesis Streams Developer Guide.
", + "EnhancedMonitoringOutput$CurrentShardLevelMetrics": "Represents the current state of the metrics that are in the enhanced state before the operation.
", + "EnhancedMonitoringOutput$DesiredShardLevelMetrics": "Represents the list of all the metrics that would be in the enhanced state after the operation.
" + } + }, + "MillisBehindLatest": { + "base": null, + "refs": { + "GetRecordsOutput$MillisBehindLatest": "The number of milliseconds the GetRecords response is from the tip of the stream, indicating how far behind current time the consumer is. A value of zero indicates record processing is caught up, and there are no new records to process at this moment.
" + } + }, + "PartitionKey": { + "base": null, + "refs": { + "PutRecordInput$PartitionKey": "Determines which shard in the stream the data record is assigned to. Partition keys are Unicode strings with a maximum length limit of 256 characters for each key. Amazon Kinesis uses the partition key as input to a hash function that maps the partition key and associated data to a specific shard. Specifically, an MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream.
", + "PutRecordsRequestEntry$PartitionKey": "Determines which shard in the stream the data record is assigned to. Partition keys are Unicode strings with a maximum length limit of 256 characters for each key. Amazon Kinesis uses the partition key as input to a hash function that maps the partition key and associated data to a specific shard. Specifically, an MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream.
", + "Record$PartitionKey": "Identifies which shard in the stream the data record is assigned to.
" + } + }, + "PositiveIntegerObject": { + "base": null, + "refs": { + "CreateStreamInput$ShardCount": "The number of shards that the stream will use. The throughput of the stream is a function of the number of shards; more shards are required for greater provisioned throughput.
DefaultShardLimit;
", + "PutRecordsOutput$FailedRecordCount": "The number of unsuccessfully processed records in a PutRecords request.
The request rate for the stream is too high, or the requested data is too large for the available throughput. Reduce the frequency or size of your requests. For more information, see Streams Limits in the Amazon Kinesis Streams Developer Guide, and Error Retries and Exponential Backoff in AWS in the AWS General Reference.
", + "refs": { + } + }, + "PutRecordInput": { + "base": "Represents the input for PutRecord.
Represents the output for PutRecord.
A PutRecords request.
PutRecords results.
Represents the output for PutRecords.
The records associated with the request.
" + } + }, + "PutRecordsResultEntry": { + "base": "Represents the result of an individual record from a PutRecords request. A record that is successfully added to a stream includes SequenceNumber and ShardId in the result. A record that fails to be added to the stream includes ErrorCode and ErrorMessage in the result.
An array of successfully and unsuccessfully processed record results, correlated with the request by natural ordering. A record that is successfully added to a stream includes SequenceNumber and ShardId in the result. A record that fails to be added to a stream includes ErrorCode and ErrorMessage in the result.
The unit of data of the Amazon Kinesis stream, which is composed of a sequence number, a partition key, and a data blob.
", + "refs": { + "RecordList$member": null + } + }, + "RecordList": { + "base": null, + "refs": { + "GetRecordsOutput$Records": "The data records retrieved from the shard.
" + } + }, + "RemoveTagsFromStreamInput": { + "base": "Represents the input for RemoveTagsFromStream.
The resource is not available for this operation. For successful operation, the resource needs to be in the ACTIVE state.
The requested resource could not be found. The stream might not be specified correctly, or it might not be in the ACTIVE state if the operation requires it.
The new retention period of the stream, in hours. Must be less than the current retention period.
", + "IncreaseStreamRetentionPeriodInput$RetentionPeriodHours": "The new retention period of the stream, in hours. Must be more than the current retention period.
", + "StreamDescription$RetentionPeriodHours": "The current retention period, in hours.
" + } + }, + "SequenceNumber": { + "base": null, + "refs": { + "GetShardIteratorInput$StartingSequenceNumber": "The sequence number of the data record in the shard from which to start reading. Used with shard iterator type AT_SEQUENCE_NUMBER and AFTER_SEQUENCE_NUMBER.
", + "PutRecordInput$SequenceNumberForOrdering": "Guarantees strictly increasing sequence numbers, for puts from the same client and to the same partition key. Usage: set the SequenceNumberForOrdering of record n to the sequence number of record n-1 (as returned in the result when putting record n-1). If this parameter is not set, records will be coarsely ordered based on arrival time.
The sequence number identifier that was assigned to the put data record. The sequence number for the record is unique across all records in the stream. A sequence number is the identifier associated with every record put into the stream.
", + "PutRecordsResultEntry$SequenceNumber": "The sequence number for an individual record result.
", + "Record$SequenceNumber": "The unique identifier of the record in the stream.
", + "SequenceNumberRange$StartingSequenceNumber": "The starting sequence number for the range.
", + "SequenceNumberRange$EndingSequenceNumber": "The ending sequence number for the range. Shards that are in the OPEN state have an ending sequence number of null.
The range of possible sequence numbers for the shard.
", + "refs": { + "Shard$SequenceNumberRange": "The range of possible sequence numbers for the shard.
" + } + }, + "Shard": { + "base": "A uniquely identified group of data records in an Amazon Kinesis stream.
", + "refs": { + "ShardList$member": null + } + }, + "ShardId": { + "base": null, + "refs": { + "DescribeStreamInput$ExclusiveStartShardId": "The shard ID of the shard to start with.
", + "GetShardIteratorInput$ShardId": "The shard ID of the Amazon Kinesis shard to get the iterator for.
", + "MergeShardsInput$ShardToMerge": "The shard ID of the shard to combine with the adjacent shard for the merge.
", + "MergeShardsInput$AdjacentShardToMerge": "The shard ID of the adjacent shard for the merge.
", + "PutRecordOutput$ShardId": "The shard ID of the shard where the data record was placed.
", + "PutRecordsResultEntry$ShardId": "The shard ID for an individual record result.
", + "Shard$ShardId": "The unique identifier of the shard within the stream.
", + "Shard$ParentShardId": "The shard ID of the shard's parent.
", + "Shard$AdjacentParentShardId": "The shard ID of the shard adjacent to the shard's parent.
", + "SplitShardInput$ShardToSplit": "The shard ID of the shard to split.
" + } + }, + "ShardIterator": { + "base": null, + "refs": { + "GetRecordsInput$ShardIterator": "The position in the shard from which you want to start sequentially reading data records. A shard iterator specifies this position using the sequence number of a data record in the shard.
", + "GetRecordsOutput$NextShardIterator": "The next position in the shard from which to start sequentially reading data records. If set to null, the shard has been closed and the requested iterator will not return any more data.
The position in the shard from which to start reading data records sequentially. A shard iterator specifies this position using the sequence number of a data record in a shard.
" + } + }, + "ShardIteratorType": { + "base": null, + "refs": { + "GetShardIteratorInput$ShardIteratorType": "Determines how the shard iterator is used to start reading data records from the shard.
The following are the valid Amazon Kinesis shard iterator types:
StartingSequenceNumber.StartingSequenceNumber.Timestamp.The shards that comprise the stream.
" + } + }, + "SplitShardInput": { + "base": "Represents the input for SplitShard.
The Amazon Resource Name (ARN) for the stream being described.
" + } + }, + "StreamDescription": { + "base": "Represents the output for DescribeStream.
", + "refs": { + "DescribeStreamOutput$StreamDescription": "The current status of the stream, the stream ARN, an array of shard objects that comprise the stream, and states whether there are more shards available.
" + } + }, + "StreamName": { + "base": null, + "refs": { + "AddTagsToStreamInput$StreamName": "The name of the stream.
", + "CreateStreamInput$StreamName": "A name to identify the stream. The stream name is scoped to the AWS account used by the application that creates the stream. It is also scoped by region. That is, two streams in two different AWS accounts can have the same name, and two streams in the same AWS account but in two different regions can have the same name.
", + "DecreaseStreamRetentionPeriodInput$StreamName": "The name of the stream to modify.
", + "DeleteStreamInput$StreamName": "The name of the stream to delete.
", + "DescribeStreamInput$StreamName": "The name of the stream to describe.
", + "DisableEnhancedMonitoringInput$StreamName": "The name of the Amazon Kinesis stream for which to disable enhanced monitoring.
", + "EnableEnhancedMonitoringInput$StreamName": "The name of the stream for which to enable enhanced monitoring.
", + "EnhancedMonitoringOutput$StreamName": "The name of the Amazon Kinesis stream.
", + "GetShardIteratorInput$StreamName": "The name of the Amazon Kinesis stream.
", + "IncreaseStreamRetentionPeriodInput$StreamName": "The name of the stream to modify.
", + "ListStreamsInput$ExclusiveStartStreamName": "The name of the stream to start the list with.
", + "ListTagsForStreamInput$StreamName": "The name of the stream.
", + "MergeShardsInput$StreamName": "The name of the stream for the merge.
", + "PutRecordInput$StreamName": "The name of the stream to put the data record into.
", + "PutRecordsInput$StreamName": "The stream name associated with the request.
", + "RemoveTagsFromStreamInput$StreamName": "The name of the stream.
", + "SplitShardInput$StreamName": "The name of the stream for the shard split.
", + "StreamDescription$StreamName": "The name of the stream being described.
", + "StreamNameList$member": null + } + }, + "StreamNameList": { + "base": null, + "refs": { + "ListStreamsOutput$StreamNames": "The names of the streams that are associated with the AWS account making the ListStreams request.
The current status of the stream being described. The stream status is one of the following states:
CREATING - The stream is being created. Amazon Kinesis immediately returns and sets StreamStatus to CREATING.DELETING - The stream is being deleted. The specified stream is in the DELETING state until Amazon Kinesis completes the deletion.ACTIVE - The stream exists and is ready for read and write operations or deletion. You should perform read and write operations only on an ACTIVE stream.UPDATING - Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in the UPDATING state.Metadata assigned to the stream, consisting of a key-value pair.
", + "refs": { + "TagList$member": null + } + }, + "TagKey": { + "base": null, + "refs": { + "ListTagsForStreamInput$ExclusiveStartTagKey": "The key to use as the starting point for the list of tags. If this parameter is set, ListTagsForStream gets all tags that occur after ExclusiveStartTagKey.
A unique identifier for the tag. Maximum length: 128 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @
", + "TagKeyList$member": null, + "TagMap$key": null + } + }, + "TagKeyList": { + "base": null, + "refs": { + "RemoveTagsFromStreamInput$TagKeys": "A list of tag keys. Each corresponding tag is removed from the stream.
" + } + }, + "TagList": { + "base": null, + "refs": { + "ListTagsForStreamOutput$Tags": "A list of tags associated with StreamName, starting with the first tag after ExclusiveStartTagKey and up to the specified Limit.
The set of key-value pairs to use to create the tags.
" + } + }, + "TagValue": { + "base": null, + "refs": { + "Tag$Value": "An optional string, typically used to describe or define the tag. Maximum length: 256 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @
", + "TagMap$value": null + } + }, + "Timestamp": { + "base": null, + "refs": { + "GetShardIteratorInput$Timestamp": "The timestamp of the data record from which to start reading. Used with shard iterator type AT_TIMESTAMP. A timestamp is the Unix epoch date with precision in milliseconds. For example, 2016-04-04T19:58:46.480-00:00 or 1459799926.480. If a record with this exact timestamp does not exist, the iterator returned is for the next (later) record. If the timestamp is older than the current trim horizon, the iterator returned is for the oldest untrimmed data record (TRIM_HORIZON).
AWS Key Management Service (AWS KMS) is an encryption and key management web service. This guide describes the AWS KMS operations that you can call programmatically. For general information about AWS KMS, see the AWS Key Management Service Developer Guide.
AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to AWS KMS and other AWS services. For example, the SDKs take care of tasks such as signing requests (see below), managing errors, and retrying requests automatically. For more information about the AWS SDKs, including how to download and install them, see Tools for Amazon Web Services.
We recommend that you use the AWS SDKs to make programmatic API calls to AWS KMS.
Clients must support TLS (Transport Layer Security) 1.0. We recommend TLS 1.2. Clients must also support cipher suites with Perfect Forward Secrecy (PFS) such as Ephemeral Diffie-Hellman (DHE) or Elliptic Curve Ephemeral Diffie-Hellman (ECDHE). Most modern systems such as Java 7 and later support these modes.
Signing Requests
Requests must be signed by using an access key ID and a secret access key. We strongly recommend that you do not use your AWS account (root) access key ID and secret key for everyday work with AWS KMS. Instead, use the access key ID and secret access key for an IAM user, or you can use the AWS Security Token Service to generate temporary security credentials that you can use to sign requests.
All AWS KMS operations require Signature Version 4.
Logging API Requests
AWS KMS supports AWS CloudTrail, a service that logs AWS API calls and related events for your AWS account and delivers them to an Amazon S3 bucket that you specify. By using the information collected by CloudTrail, you can determine what requests were made to AWS KMS, who made the request, when it was made, and so on. To learn more about CloudTrail, including how to turn it on and find your log files, see the AWS CloudTrail User Guide.
Additional Resources
For more information about credentials and request signing, see the following:
AWS Security Credentials - This topic provides general information about the types of credentials used for accessing AWS.
Temporary Security Credentials - This section of the IAM User Guide describes how to create and use temporary security credentials.
Signature Version 4 Signing Process - This set of topics walks you through the process of signing a request using an access key ID and a secret access key.
Commonly Used APIs
Of the APIs discussed in this guide, the following will prove the most useful for most applications. You will likely perform actions other than these, such as creating keys and assigning policies, by using the console.
", + "operations": { + "CancelKeyDeletion": "Cancels the deletion of a customer master key (CMK). When this operation is successful, the CMK is set to the Disabled state. To enable a CMK, use EnableKey.
For more information about scheduling and canceling deletion of a CMK, see Deleting Customer Master Keys in the AWS Key Management Service Developer Guide.
", + "CreateAlias": "Creates a display name for a customer master key. An alias can be used to identify a key and should be unique. The console enforces a one-to-one mapping between the alias and a key. An alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). An alias must start with the word \"alias\" followed by a forward slash (alias/). An alias that begins with \"aws\" after the forward slash (alias/aws...) is reserved by Amazon Web Services (AWS).
The alias and the key it is mapped to must be in the same AWS account and the same region.
To map an alias to a different key, call UpdateAlias.
", + "CreateGrant": "Adds a grant to a key to specify who can use the key and under what conditions. Grants are alternate permission mechanisms to key policies.
For more information about grants, see Grants in the AWS Key Management Service Developer Guide.
", + "CreateKey": "Creates a customer master key (CMK).
You can use a CMK to encrypt small amounts of data (4 KiB or less) directly, but CMKs are more commonly used to encrypt data encryption keys (DEKs), which are used to encrypt raw data. For more information about DEKs and the difference between CMKs and DEKs, see the following:
The GenerateDataKey operation
AWS Key Management Service Concepts in the AWS Key Management Service Developer Guide
Decrypts ciphertext. Ciphertext is plaintext that has been previously encrypted by using any of the following functions:
Note that if a caller has been granted access permissions to all keys (through, for example, IAM user policies that grant Decrypt permission on all resources), then ciphertext encrypted by using keys in other accounts where the key grants access to the caller can be decrypted. To remedy this, we recommend that you do not grant Decrypt access in an IAM user policy. Instead grant Decrypt access only in key policies. If you must grant Decrypt access in an IAM user policy, you should scope the resource to specific keys or to specific trusted accounts.
Deletes the specified alias. To map an alias to a different key, call UpdateAlias.
", + "DescribeKey": "Provides detailed information about the specified customer master key.
", + "DisableKey": "Sets the state of a customer master key (CMK) to disabled, thereby preventing its use for cryptographic operations. For more information about how key state affects the use of a CMK, see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
", + "DisableKeyRotation": "Disables rotation of the specified key.
", + "EnableKey": "Marks a key as enabled, thereby permitting its use.
", + "EnableKeyRotation": "Enables rotation of the specified customer master key.
", + "Encrypt": "Encrypts plaintext into ciphertext by using a customer master key. The Encrypt function has two primary use cases:
You can encrypt up to 4 KB of arbitrary data such as an RSA key, a database password, or other sensitive customer information.
If you are moving encrypted data from one region to another, you can use this API to encrypt in the new region the plaintext data key that was used to encrypt the data in the original region. This provides you with an encrypted copy of the data key that can be decrypted in the new region and used there to decrypt the encrypted data.
Unless you are moving encrypted data from one region to another, you don't use this function to encrypt a generated data key within a region. You retrieve data keys already encrypted by calling the GenerateDataKey or GenerateDataKeyWithoutPlaintext function. Data keys don't need to be encrypted again by calling Encrypt.
If you want to encrypt data locally in your application, you can use the GenerateDataKey function to return a plaintext data encryption key and a copy of the key encrypted under the customer master key (CMK) of your choosing.
Generates a data key that you can use in your application to locally encrypt data. This call returns a plaintext version of the key in the Plaintext field of the response object and an encrypted copy of the key in the CiphertextBlob field. The key is encrypted by using the master key specified by the KeyId field. To decrypt the encrypted key, pass it to the Decrypt API.
We recommend that you use the following pattern to locally encrypt data: call the GenerateDataKey API, use the key returned in the Plaintext response field to locally encrypt data, and then erase the plaintext data key from memory. Store the encrypted data key (contained in the CiphertextBlob field) alongside of the locally encrypted data.
You should not call the Encrypt function to re-encrypt your data keys within a region. GenerateDataKey always returns the data key encrypted and tied to the customer master key that will be used to decrypt it. There is no need to decrypt it twice.
If you decide to use the optional EncryptionContext parameter, you must also store the context in full or at least store enough information along with the encrypted data to be able to reconstruct the context when submitting the ciphertext to the Decrypt API. It is a good practice to choose a context that you can reconstruct on the fly to better secure the ciphertext. For more information about how this parameter is used, see Encryption Context.
To decrypt data, pass the encrypted data key to the Decrypt API. Decrypt uses the associated master key to decrypt the encrypted data key and returns it as plaintext. Use the plaintext data key to locally decrypt your data and then erase the key from memory. You must specify the encryption context, if any, that you specified when you generated the key. The encryption context is logged by CloudTrail, and you can use this log to help track the use of particular data.
Returns a data key encrypted by a customer master key without the plaintext copy of that key. Otherwise, this API functions exactly like GenerateDataKey. You can use this API to, for example, satisfy an audit requirement that an encrypted key be made available without exposing the plaintext copy of that key.
", + "GenerateRandom": "Generates an unpredictable byte string.
", + "GetKeyPolicy": "Retrieves a policy attached to the specified key.
", + "GetKeyRotationStatus": "Retrieves a Boolean value that indicates whether key rotation is enabled for the specified key.
", + "ListAliases": "Lists all of the key aliases in the account.
", + "ListGrants": "List the grants for a specified key.
", + "ListKeyPolicies": "Retrieves a list of policies attached to a key.
", + "ListKeys": "Lists the customer master keys.
", + "ListRetirableGrants": "Returns a list of all grants for which the grant's RetiringPrincipal matches the one specified.
A typical use is to list all grants that you are able to retire. To retire a grant, use RetireGrant.
", + "PutKeyPolicy": "Attaches a key policy to the specified customer master key (CMK).
For more information about key policies, see Key Policies in the AWS Key Management Service Developer Guide.
", + "ReEncrypt": "Encrypts data on the server side with a new customer master key without exposing the plaintext of the data on the client side. The data is first decrypted and then encrypted. This operation can also be used to change the encryption context of a ciphertext.
Unlike other actions, ReEncrypt is authorized twice - once as ReEncryptFrom on the source key and once as ReEncryptTo on the destination key. We therefore recommend that you include the \"action\":\"kms:ReEncrypt*\" statement in your key policies to permit re-encryption from or to the key. The statement is included automatically when you authorize use of the key through the console but must be included manually when you set a policy by using the PutKeyPolicy function.
Retires a grant. You can retire a grant when you're done using it to clean up. You should revoke a grant when you intend to actively deny operations that depend on it. The following are permitted to call this API:
The account that created the grant
The RetiringPrincipal, if present
The GranteePrincipal, if RetireGrant is a grantee operation
The grant to retire must be identified by its grant token or by a combination of the key ARN and the grant ID. A grant token is a unique variable-length base64-encoded string. A grant ID is a 64 character unique identifier of a grant. Both are returned by the CreateGrant function.
Revokes a grant. You can revoke a grant to actively deny operations that depend on it.
", + "ScheduleKeyDeletion": "Schedules the deletion of a customer master key (CMK). You may provide a waiting period, specified in days, before deletion occurs. If you do not provide a waiting period, the default period of 30 days is used. When this operation is successful, the state of the CMK changes to PendingDeletion. Before the waiting period ends, you can use CancelKeyDeletion to cancel the deletion of the CMK. After the waiting period ends, AWS KMS deletes the CMK and all AWS KMS data associated with it, including all aliases that point to it.
Deleting a CMK is a destructive and potentially dangerous operation. When a CMK is deleted, all data that was encrypted under the CMK is rendered unrecoverable. To restrict the use of a CMK without deleting it, use DisableKey.
For more information about scheduling a CMK for deletion, see Deleting Customer Master Keys in the AWS Key Management Service Developer Guide.
", + "UpdateAlias": "Updates an alias to map it to a different key.
An alias is not a property of a key. Therefore, an alias can be mapped to and unmapped from an existing key without changing the properties of the key.
An alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). An alias must start with the word \"alias\" followed by a forward slash (alias/). An alias that begins with \"aws\" after the forward slash (alias/aws...) is reserved by Amazon Web Services (AWS).
The alias and the key it is mapped to must be in the same AWS account and the same region.
", + "UpdateKeyDescription": "Updates the description of a key.
" + }, + "shapes": { + "AWSAccountIdType": { + "base": null, + "refs": { + "KeyMetadata$AWSAccountId": "The twelve-digit account ID of the AWS account that owns the key.
" + } + }, + "AliasList": { + "base": null, + "refs": { + "ListAliasesResponse$Aliases": "A list of key aliases in the user's account.
" + } + }, + "AliasListEntry": { + "base": "Contains information about an alias.
", + "refs": { + "AliasList$member": null + } + }, + "AliasNameType": { + "base": null, + "refs": { + "AliasListEntry$AliasName": "String that contains the alias.
", + "CreateAliasRequest$AliasName": "String that contains the display name. The name must start with the word \"alias\" followed by a forward slash (alias/). Aliases that begin with \"alias/AWS\" are reserved.
", + "DeleteAliasRequest$AliasName": "The alias to be deleted. The name must start with the word \"alias\" followed by a forward slash (alias/). Aliases that begin with \"alias/AWS\" are reserved.
", + "UpdateAliasRequest$AliasName": "String that contains the name of the alias to be modified. The name must start with the word \"alias\" followed by a forward slash (alias/). Aliases that begin with \"alias/aws\" are reserved.
" + } + }, + "AlreadyExistsException": { + "base": "The request was rejected because it attempted to create a resource that already exists.
", + "refs": { + } + }, + "ArnType": { + "base": null, + "refs": { + "AliasListEntry$AliasArn": "String that contains the key ARN.
", + "KeyListEntry$KeyArn": "ARN of the key.
", + "KeyMetadata$Arn": "The Amazon Resource Name (ARN) of the key. For examples, see AWS Key Management Service (AWS KMS) in the Example ARNs section of the AWS General Reference.
" + } + }, + "BooleanType": { + "base": null, + "refs": { + "CreateKeyRequest$BypassPolicyLockoutSafetyCheck": "A flag to indicate whether to bypass the key policy lockout safety check.
Setting this value to true increases the likelihood that the CMK becomes unmanageable. Do not set this value to true indiscriminately.
For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide.
Use this parameter only when you include a policy in the request and you intend to prevent the principal making the request from making a subsequent PutKeyPolicy request on the CMK.
The default value is false.
", + "GetKeyRotationStatusResponse$KeyRotationEnabled": "A Boolean value that specifies whether key rotation is enabled.
", + "KeyMetadata$Enabled": "Specifies whether the key is enabled. When KeyState is Enabled this value is true, otherwise it is false.
A flag that indicates whether there are more items in the list. If your results were truncated, you can use the Marker parameter to make a subsequent pagination request to retrieve more items in the list.
A flag that indicates whether there are more items in the list. If your results were truncated, you can use the Marker parameter to make a subsequent pagination request to retrieve more items in the list.
A flag that indicates whether there are more items in the list. If your results were truncated, you can use the Marker parameter to make a subsequent pagination request to retrieve more items in the list.
A flag that indicates whether there are more items in the list. If your results were truncated, you can use the Marker parameter to make a subsequent pagination request to retrieve more items in the list.
A flag to indicate whether to bypass the key policy lockout safety check.
Setting this value to true increases the likelihood that the CMK becomes unmanageable. Do not set this value to true indiscriminately.
For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide.
Use this parameter only when you intend to prevent the principal making the request from making a subsequent PutKeyPolicy request on the CMK.
The default value is false.
" + } + }, + "CancelKeyDeletionRequest": { + "base": null, + "refs": { + } + }, + "CancelKeyDeletionResponse": { + "base": null, + "refs": { + } + }, + "CiphertextType": { + "base": null, + "refs": { + "DecryptRequest$CiphertextBlob": "Ciphertext to be decrypted. The blob includes metadata.
", + "EncryptResponse$CiphertextBlob": "The encrypted plaintext. If you are using the CLI, the value is Base64 encoded. Otherwise, it is not encoded.
", + "GenerateDataKeyResponse$CiphertextBlob": "Ciphertext that contains the encrypted data key. You must store the blob and enough information to reconstruct the encryption context so that the data encrypted by using the key can later be decrypted. You must provide both the ciphertext blob and the encryption context to the Decrypt API to recover the plaintext data key and decrypt the object.
If you are using the CLI, the value is Base64 encoded. Otherwise, it is not encoded.
", + "GenerateDataKeyWithoutPlaintextResponse$CiphertextBlob": "Ciphertext that contains the wrapped data key. You must store the blob and encryption context so that the key can be used in a future decrypt operation.
If you are using the CLI, the value is Base64 encoded. Otherwise, it is not encoded.
", + "ReEncryptRequest$CiphertextBlob": "Ciphertext of the data to re-encrypt.
", + "ReEncryptResponse$CiphertextBlob": "The re-encrypted data. If you are using the CLI, the value is Base64 encoded. Otherwise, it is not encoded.
" + } + }, + "CreateAliasRequest": { + "base": null, + "refs": { + } + }, + "CreateGrantRequest": { + "base": null, + "refs": { + } + }, + "CreateGrantResponse": { + "base": null, + "refs": { + } + }, + "CreateKeyRequest": { + "base": null, + "refs": { + } + }, + "CreateKeyResponse": { + "base": null, + "refs": { + } + }, + "DataKeySpec": { + "base": null, + "refs": { + "GenerateDataKeyRequest$KeySpec": "Value that identifies the encryption algorithm and key size to generate a data key for. Currently this can be AES_128 or AES_256.
", + "GenerateDataKeyWithoutPlaintextRequest$KeySpec": "Value that identifies the encryption algorithm and key size. Currently this can be AES_128 or AES_256.
" + } + }, + "DateType": { + "base": null, + "refs": { + "GrantListEntry$CreationDate": "The date and time when the grant was created.
", + "KeyMetadata$CreationDate": "The date and time when the key was created.
", + "KeyMetadata$DeletionDate": "The date and time after which AWS KMS deletes the customer master key (CMK). This value is present only when KeyState is PendingDeletion, otherwise this value is null.
The date and time after which AWS KMS deletes the customer master key (CMK).
" + } + }, + "DecryptRequest": { + "base": null, + "refs": { + } + }, + "DecryptResponse": { + "base": null, + "refs": { + } + }, + "DeleteAliasRequest": { + "base": null, + "refs": { + } + }, + "DependencyTimeoutException": { + "base": "The system timed out while trying to fulfill the request. The request can be retried.
", + "refs": { + } + }, + "DescribeKeyRequest": { + "base": null, + "refs": { + } + }, + "DescribeKeyResponse": { + "base": null, + "refs": { + } + }, + "DescriptionType": { + "base": null, + "refs": { + "CreateKeyRequest$Description": "A description of the CMK.
Use a description that helps you decide whether the CMK is appropriate for a task.
", + "KeyMetadata$Description": "The friendly description of the key.
", + "UpdateKeyDescriptionRequest$Description": "New description for the key.
" + } + }, + "DisableKeyRequest": { + "base": null, + "refs": { + } + }, + "DisableKeyRotationRequest": { + "base": null, + "refs": { + } + }, + "DisabledException": { + "base": "The request was rejected because the specified key was marked as disabled.
", + "refs": { + } + }, + "EnableKeyRequest": { + "base": null, + "refs": { + } + }, + "EnableKeyRotationRequest": { + "base": null, + "refs": { + } + }, + "EncryptRequest": { + "base": null, + "refs": { + } + }, + "EncryptResponse": { + "base": null, + "refs": { + } + }, + "EncryptionContextKey": { + "base": null, + "refs": { + "EncryptionContextType$key": null + } + }, + "EncryptionContextType": { + "base": null, + "refs": { + "DecryptRequest$EncryptionContext": "The encryption context. If this was specified in the Encrypt function, it must be specified here or the decryption operation will fail. For more information, see Encryption Context.
", + "EncryptRequest$EncryptionContext": "Name/value pair that specifies the encryption context to be used for authenticated encryption. If used here, the same value must be supplied to the Decrypt API or decryption will fail. For more information, see Encryption Context.
Name/value pair that contains additional data to be authenticated during the encryption and decryption processes that use the key. This value is logged by AWS CloudTrail to provide context around the data encrypted by the key.
", + "GenerateDataKeyWithoutPlaintextRequest$EncryptionContext": "Name:value pair that contains additional data to be authenticated during the encryption and decryption processes.
", + "GrantConstraints$EncryptionContextSubset": "Contains a list of key-value pairs, a subset of which must be present in the encryption context of a subsequent operation permitted by the grant. When a subsequent operation permitted by the grant includes an encryption context that matches this list or is a subset of this list, the grant allows the operation. Otherwise, the operation is not allowed.
", + "GrantConstraints$EncryptionContextEquals": "Contains a list of key-value pairs that must be present in the encryption context of a subsequent operation permitted by the grant. When a subsequent operation permitted by the grant includes an encryption context that matches this list, the grant allows the operation. Otherwise, the operation is not allowed.
", + "ReEncryptRequest$SourceEncryptionContext": "Encryption context used to encrypt and decrypt the data specified in the CiphertextBlob parameter.
Encryption context to be used when the data is re-encrypted.
" + } + }, + "EncryptionContextValue": { + "base": null, + "refs": { + "EncryptionContextType$value": null + } + }, + "ErrorMessageType": { + "base": null, + "refs": { + "AlreadyExistsException$message": null, + "DependencyTimeoutException$message": null, + "DisabledException$message": null, + "InvalidAliasNameException$message": null, + "InvalidArnException$message": null, + "InvalidCiphertextException$message": null, + "InvalidGrantIdException$message": null, + "InvalidGrantTokenException$message": null, + "InvalidKeyUsageException$message": null, + "InvalidMarkerException$message": null, + "KMSInternalException$message": null, + "KMSInvalidStateException$message": null, + "KeyUnavailableException$message": null, + "LimitExceededException$message": null, + "MalformedPolicyDocumentException$message": null, + "NotFoundException$message": null, + "UnsupportedOperationException$message": null + } + }, + "GenerateDataKeyRequest": { + "base": null, + "refs": { + } + }, + "GenerateDataKeyResponse": { + "base": null, + "refs": { + } + }, + "GenerateDataKeyWithoutPlaintextRequest": { + "base": null, + "refs": { + } + }, + "GenerateDataKeyWithoutPlaintextResponse": { + "base": null, + "refs": { + } + }, + "GenerateRandomRequest": { + "base": null, + "refs": { + } + }, + "GenerateRandomResponse": { + "base": null, + "refs": { + } + }, + "GetKeyPolicyRequest": { + "base": null, + "refs": { + } + }, + "GetKeyPolicyResponse": { + "base": null, + "refs": { + } + }, + "GetKeyRotationStatusRequest": { + "base": null, + "refs": { + } + }, + "GetKeyRotationStatusResponse": { + "base": null, + "refs": { + } + }, + "GrantConstraints": { + "base": "A structure for specifying the conditions under which the operations permitted by the grant are allowed.
You can use this structure to allow the operations permitted by the grant only when a specified encryption context is present. For more information about encryption context, see Encryption Context in the AWS Key Management Service Developer Guide.
", + "refs": { + "CreateGrantRequest$Constraints": "The conditions under which the operations permitted by the grant are allowed.
You can use this value to allow the operations permitted by the grant only when a specified encryption context is present. For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
", + "GrantListEntry$Constraints": "The conditions under which the grant's operations are allowed.
" + } + }, + "GrantIdType": { + "base": null, + "refs": { + "CreateGrantResponse$GrantId": "The unique identifier for the grant.
You can use the GrantId in a subsequent RetireGrant or RevokeGrant operation.
The unique identifier for the grant.
", + "RetireGrantRequest$GrantId": "Unique identifier of the grant to be retired. The grant ID is returned by the CreateGrant function.
Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123
Identifier of the grant to be revoked.
" + } + }, + "GrantList": { + "base": null, + "refs": { + "ListGrantsResponse$Grants": "A list of grants.
" + } + }, + "GrantListEntry": { + "base": "Contains information about an entry in a list of grants.
", + "refs": { + "GrantList$member": null + } + }, + "GrantNameType": { + "base": null, + "refs": { + "CreateGrantRequest$Name": "A friendly name for identifying the grant. Use this value to prevent unintended creation of duplicate grants when retrying this request.
When this value is absent, all CreateGrant requests result in a new grant with a unique GrantId even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the CreateGrant request.
When this value is present, you can retry a CreateGrant request with identical parameters; if the grant already exists, the original GrantId is returned without creating a new grant. Note that the returned grant token is unique with every CreateGrant request, even when a duplicate GrantId is returned. All grant tokens obtained in this way can be used interchangeably.
The friendly name that identifies the grant. If a name was provided in the CreateGrant request, that name is returned. Otherwise this value is null.
" + } + }, + "GrantOperation": { + "base": null, + "refs": { + "GrantOperationList$member": null + } + }, + "GrantOperationList": { + "base": null, + "refs": { + "CreateGrantRequest$Operations": "A list of operations that the grant permits. The list can contain any combination of one or more of the following values:
The list of operations permitted by the grant.
" + } + }, + "GrantTokenList": { + "base": null, + "refs": { + "CreateGrantRequest$GrantTokens": "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
", + "DecryptRequest$GrantTokens": "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
", + "DescribeKeyRequest$GrantTokens": "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
", + "EncryptRequest$GrantTokens": "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
", + "GenerateDataKeyRequest$GrantTokens": "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
", + "GenerateDataKeyWithoutPlaintextRequest$GrantTokens": "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
", + "ReEncryptRequest$GrantTokens": "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
" + } + }, + "GrantTokenType": { + "base": null, + "refs": { + "CreateGrantResponse$GrantToken": "The grant token.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
", + "GrantTokenList$member": null, + "RetireGrantRequest$GrantToken": "Token that identifies the grant to be retired.
" + } + }, + "InvalidAliasNameException": { + "base": "The request was rejected because the specified alias name is not valid.
", + "refs": { + } + }, + "InvalidArnException": { + "base": "The request was rejected because a specified ARN was not valid.
", + "refs": { + } + }, + "InvalidCiphertextException": { + "base": "The request was rejected because the specified ciphertext has been corrupted or is otherwise invalid.
", + "refs": { + } + }, + "InvalidGrantIdException": { + "base": "The request was rejected because the specified GrantId is not valid.
The request was rejected because a grant token provided as part of the request is invalid.
", + "refs": { + } + }, + "InvalidKeyUsageException": { + "base": "The request was rejected because the specified KeySpec parameter is not valid. The currently supported value is ENCRYPT/DECRYPT.
", + "refs": { + } + }, + "InvalidMarkerException": { + "base": "The request was rejected because the marker that specifies where pagination should next begin is not valid.
", + "refs": { + } + }, + "KMSInternalException": { + "base": "The request was rejected because an internal exception occurred. The request can be retried.
", + "refs": { + } + }, + "KMSInvalidStateException": { + "base": "The request was rejected because the state of the specified resource is not valid for this request.
For more information about how key state affects the use of a customer master key (CMK), see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
", + "refs": { + } + }, + "KeyIdType": { + "base": null, + "refs": { + "AliasListEntry$TargetKeyId": "String that contains the key identifier pointed to by the alias.
", + "CancelKeyDeletionRequest$KeyId": "The unique identifier for the customer master key (CMK) for which to cancel deletion.
To specify this value, use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To obtain the unique key ID and key ARN for a given CMK, use ListKeys or DescribeKey.
", + "CancelKeyDeletionResponse$KeyId": "The unique identifier of the master key for which deletion is canceled.
", + "CreateAliasRequest$TargetKeyId": "An identifier of the key for which you are creating the alias. This value cannot be another alias but can be a globally unique identifier or a fully specified ARN to a key.
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
The unique identifier for the customer master key (CMK) that the grant applies to.
To specify this value, use the globally unique key ID or the Amazon Resource Name (ARN) of the key. Examples:
Globally unique key ID: 12345678-1234-1234-1234-123456789012
Key ARN: arn:aws:kms:us-west-2:123456789012:key/12345678-1234-1234-1234-123456789012
ARN of the key used to perform the decryption. This value is returned if no errors are encountered during the operation.
", + "DescribeKeyRequest$KeyId": "A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias/\".
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
Alias Name Example - alias/MyAliasName
A unique identifier for the CMK.
Use the CMK's unique identifier or its Amazon Resource Name (ARN). For example:
Unique ID: 1234abcd-12ab-34cd-56ef-1234567890ab
ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias/\".
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
Alias Name Example - alias/MyAliasName
The ID of the key used during encryption.
", + "GenerateDataKeyRequest$KeyId": "A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias/\".
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
Alias Name Example - alias/MyAliasName
System generated unique identifier of the key to be used to decrypt the encrypted copy of the data key.
", + "GenerateDataKeyWithoutPlaintextRequest$KeyId": "A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias/\".
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
Alias Name Example - alias/MyAliasName
System generated unique identifier of the key to be used to decrypt the encrypted copy of the data key.
", + "GetKeyPolicyRequest$KeyId": "A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
The unique identifier for the customer master key (CMK) to which the grant applies.
", + "KeyListEntry$KeyId": "Unique identifier of the key.
", + "KeyMetadata$KeyId": "The globally unique identifier for the key.
", + "ListGrantsRequest$KeyId": "A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias/\".
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
Alias Name Example - alias/MyAliasName
A unique identifier for the CMK.
Use the CMK's unique identifier or its Amazon Resource Name (ARN). For example:
Unique ID: 1234abcd-12ab-34cd-56ef-1234567890ab
ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
A unique identifier for the customer master key used to re-encrypt the data. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias/\".
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
Alias Name Example - alias/MyAliasName
Unique identifier of the key used to originally encrypt the data.
", + "ReEncryptResponse$KeyId": "Unique identifier of the key used to re-encrypt the data.
", + "RetireGrantRequest$KeyId": "A unique identifier for the customer master key associated with the grant. This value can be a globally unique identifier or a fully specified ARN of the key.
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
A unique identifier for the customer master key associated with the grant. This value can be a globally unique identifier or the fully specified ARN to a key.
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
The unique identifier for the customer master key (CMK) to delete.
To specify this value, use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To obtain the unique key ID and key ARN for a given CMK, use ListKeys or DescribeKey.
", + "ScheduleKeyDeletionResponse$KeyId": "The unique identifier of the customer master key (CMK) for which deletion is scheduled.
", + "UpdateAliasRequest$TargetKeyId": "Unique identifier of the customer master key to be mapped to the alias. This value can be a globally unique identifier or the fully specified ARN of a key.
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
You can call ListAliases to verify that the alias is mapped to the correct TargetKeyId.
A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
A list of keys.
" + } + }, + "KeyListEntry": { + "base": "Contains information about each entry in the key list.
", + "refs": { + "KeyList$member": null + } + }, + "KeyMetadata": { + "base": "Contains metadata about a customer master key (CMK).
This data type is used as a response element for the CreateKey and DescribeKey operations.
", + "refs": { + "CreateKeyResponse$KeyMetadata": "Metadata associated with the CMK.
", + "DescribeKeyResponse$KeyMetadata": "Metadata associated with the key.
" + } + }, + "KeyState": { + "base": null, + "refs": { + "KeyMetadata$KeyState": "The state of the customer master key (CMK).
For more information about how key state affects the use of a CMK, see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
" + } + }, + "KeyUnavailableException": { + "base": "The request was rejected because the key was not available. The request can be retried.
", + "refs": { + } + }, + "KeyUsageType": { + "base": null, + "refs": { + "CreateKeyRequest$KeyUsage": "The intended use of the CMK.
You can use CMKs only for symmetric encryption and decryption.
", + "KeyMetadata$KeyUsage": "The cryptographic operations for which you can use the key. Currently the only allowed value is ENCRYPT_DECRYPT, which means you can use the key for the Encrypt and Decrypt operations.
The request was rejected because a limit was exceeded. For more information, see Limits in the AWS Key Management Service Developer Guide.
", + "refs": { + } + }, + "LimitType": { + "base": null, + "refs": { + "ListAliasesRequest$Limit": "When paginating results, specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the Truncated element in the response is set to true.
This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.
", + "ListGrantsRequest$Limit": "When paginating results, specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the Truncated element in the response is set to true.
This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.
", + "ListKeyPoliciesRequest$Limit": "When paginating results, specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the Truncated element in the response is set to true.
This value is optional. If you include a value, it must be between 1 and 1000, inclusive. If you do not include a value, it defaults to 100.
Currently only 1 policy can be attached to a key.
", + "ListKeysRequest$Limit": "When paginating results, specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the Truncated element in the response is set to true.
This value is optional. If you include a value, it must be between 1 and 1000, inclusive. If you do not include a value, it defaults to 100.
", + "ListRetirableGrantsRequest$Limit": "When paginating results, specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the Truncated element in the response is set to true.
This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.
" + } + }, + "ListAliasesRequest": { + "base": null, + "refs": { + } + }, + "ListAliasesResponse": { + "base": null, + "refs": { + } + }, + "ListGrantsRequest": { + "base": null, + "refs": { + } + }, + "ListGrantsResponse": { + "base": null, + "refs": { + } + }, + "ListKeyPoliciesRequest": { + "base": null, + "refs": { + } + }, + "ListKeyPoliciesResponse": { + "base": null, + "refs": { + } + }, + "ListKeysRequest": { + "base": null, + "refs": { + } + }, + "ListKeysResponse": { + "base": null, + "refs": { + } + }, + "ListRetirableGrantsRequest": { + "base": null, + "refs": { + } + }, + "MalformedPolicyDocumentException": { + "base": "The request was rejected because the specified policy is not syntactically or semantically correct.
", + "refs": { + } + }, + "MarkerType": { + "base": null, + "refs": { + "ListAliasesRequest$Marker": "Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the response you just received.
When Truncated is true, this value is present and contains the value to use for the Marker parameter in a subsequent pagination request.
Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the response you just received.
When Truncated is true, this value is present and contains the value to use for the Marker parameter in a subsequent pagination request.
Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the response you just received.
When Truncated is true, this value is present and contains the value to use for the Marker parameter in a subsequent pagination request.
Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the response you just received.
When Truncated is true, this value is present and contains the value to use for the Marker parameter in a subsequent pagination request.
Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the response you just received.
The request was rejected because the specified entity or resource could not be found.
", + "refs": { + } + }, + "NumberOfBytesType": { + "base": null, + "refs": { + "GenerateDataKeyRequest$NumberOfBytes": "Integer that contains the number of bytes to generate. Common values are 128, 256, 512, and 1024. 1024 is the current limit. We recommend that you use the KeySpec parameter instead.
Integer that contains the number of bytes to generate. Common values are 128, 256, 512, 1024 and so on. We recommend that you use the KeySpec parameter instead.
Integer that contains the number of bytes to generate. Common values are 128, 256, 512, 1024 and so on. The current limit is 1024 bytes.
" + } + }, + "PendingWindowInDaysType": { + "base": null, + "refs": { + "ScheduleKeyDeletionRequest$PendingWindowInDays": "The waiting period, specified in number of days. After the waiting period ends, AWS KMS deletes the customer master key (CMK).
This value is optional. If you include a value, it must be between 7 and 30, inclusive. If you do not include a value, it defaults to 30.
" + } + }, + "PlaintextType": { + "base": null, + "refs": { + "DecryptResponse$Plaintext": "Decrypted plaintext data. This value may not be returned if the customer master key is not available or if you didn't have permission to use it.
", + "EncryptRequest$Plaintext": "Data to be encrypted.
", + "GenerateDataKeyResponse$Plaintext": "Plaintext that contains the data key. Use this for encryption and decryption and then remove it from memory as soon as possible.
", + "GenerateRandomResponse$Plaintext": "Plaintext that contains the unpredictable byte string.
" + } + }, + "PolicyNameList": { + "base": null, + "refs": { + "ListKeyPoliciesResponse$PolicyNames": "A list of policy names. Currently, there is only one policy and it is named \"Default\".
" + } + }, + "PolicyNameType": { + "base": null, + "refs": { + "GetKeyPolicyRequest$PolicyName": "String that contains the name of the policy. Currently, this must be \"default\". Policy names can be discovered by calling ListKeyPolicies.
", + "PolicyNameList$member": null, + "PutKeyPolicyRequest$PolicyName": "The name of the key policy.
This value must be default.
The key policy to attach to the CMK.
If you specify a key policy, it must meet the following criteria:
It must allow the principal making the CreateKey request to make a subsequent PutKeyPolicy request on the CMK. This reduces the likelihood that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide.
The principal(s) specified in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before specifying the new principal in a key policy because the new principal might not immediately be visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the IAM User Guide.
If you do not specify a policy, AWS KMS attaches a default key policy to the CMK. For more information, see Default Key Policy in the AWS Key Management Service Developer Guide.
The policy size limit is 32 KiB (32768 bytes).
", + "GetKeyPolicyResponse$Policy": "A policy document in JSON format.
", + "PutKeyPolicyRequest$Policy": "The key policy to attach to the CMK.
The key policy must meet the following criteria:
It must allow the principal making the PutKeyPolicy request to make a subsequent PutKeyPolicy request on the CMK. This reduces the likelihood that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide.
The principal(s) specified in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before specifying the new principal in a key policy because the new principal might not immediately be visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the IAM User Guide.
The policy size limit is 32 KiB (32768 bytes).
" + } + }, + "PrincipalIdType": { + "base": null, + "refs": { + "CreateGrantRequest$GranteePrincipal": "The principal that is given permission to perform the operations that the grant permits.
To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.
", + "CreateGrantRequest$RetiringPrincipal": "The principal that is given permission to retire the grant by using RetireGrant operation.
To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.
", + "GrantListEntry$GranteePrincipal": "The principal that receives the grant's permissions.
", + "GrantListEntry$RetiringPrincipal": "The principal that can retire the grant.
", + "GrantListEntry$IssuingAccount": "The AWS account under which the grant was issued.
", + "ListRetirableGrantsRequest$RetiringPrincipal": "The retiring principal for which to list grants.
To specify the retiring principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the Amazon Web Services General Reference.
" + } + }, + "PutKeyPolicyRequest": { + "base": null, + "refs": { + } + }, + "ReEncryptRequest": { + "base": null, + "refs": { + } + }, + "ReEncryptResponse": { + "base": null, + "refs": { + } + }, + "RetireGrantRequest": { + "base": null, + "refs": { + } + }, + "RevokeGrantRequest": { + "base": null, + "refs": { + } + }, + "ScheduleKeyDeletionRequest": { + "base": null, + "refs": { + } + }, + "ScheduleKeyDeletionResponse": { + "base": null, + "refs": { + } + }, + "UnsupportedOperationException": { + "base": "The request was rejected because a specified parameter is not supported.
", + "refs": { + } + }, + "UpdateAliasRequest": { + "base": null, + "refs": { + } + }, + "UpdateKeyDescriptionRequest": { + "base": null, + "refs": { + } + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/kms/2014-11-01/examples-1.json b/vendor/github.com/aws/aws-sdk-go/models/apis/kms/2014-11-01/examples-1.json new file mode 100644 index 000000000..0ea7e3b0b --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/kms/2014-11-01/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/kms/2014-11-01/paginators-1.json b/vendor/github.com/aws/aws-sdk-go/models/apis/kms/2014-11-01/paginators-1.json new file mode 100644 index 000000000..522d171f9 --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/kms/2014-11-01/paginators-1.json @@ -0,0 +1,32 @@ +{ + "pagination": { + "ListAliases": { + "limit_key": "Limit", + "input_token": "Marker", + "output_token": "NextMarker", + "more_results": "Truncated", + "result_key": "Aliases" + }, + "ListGrants": { + "limit_key": "Limit", + "input_token": "Marker", + "output_token": "NextMarker", + "more_results": "Truncated", + "result_key": "Grants" + }, + "ListKeyPolicies": { + "limit_key": "Limit", + "input_token": "Marker", + "output_token": "NextMarker", + "more_results": "Truncated", + "result_key": "PolicyNames" + }, + "ListKeys": { + "limit_key": "Limit", + "input_token": "Marker", + "output_token": "NextMarker", + "more_results": "Truncated", + "result_key": "Keys" + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/lambda/2014-11-11/api-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/lambda/2014-11-11/api-2.json new file mode 100644 index 000000000..3e27914fe --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/lambda/2014-11-11/api-2.json @@ -0,0 +1,667 @@ +{ + "metadata":{ + "apiVersion":"2014-11-11", + "endpointPrefix":"lambda", + "serviceFullName":"AWS Lambda", + "signatureVersion":"v4", + "protocol":"rest-json" + }, + "operations":{ + "AddEventSource":{ + "name":"AddEventSource", + "http":{ + "method":"POST", + "requestUri":"/2014-11-13/event-source-mappings/" + }, + "input":{"shape":"AddEventSourceRequest"}, + "output":{"shape":"EventSourceConfiguration"}, + "errors":[ + { + "shape":"ServiceException", + "error":{"httpStatusCode":500}, + "exception":true + }, + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + } + ] + }, + "DeleteFunction":{ + "name":"DeleteFunction", + "http":{ + "method":"DELETE", + "requestUri":"/2014-11-13/functions/{FunctionName}", + "responseCode":204 + }, + "input":{"shape":"DeleteFunctionRequest"}, + "errors":[ + { + "shape":"ServiceException", + "error":{"httpStatusCode":500}, + "exception":true + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + } + ] + }, + "GetEventSource":{ + "name":"GetEventSource", + "http":{ + "method":"GET", + "requestUri":"/2014-11-13/event-source-mappings/{UUID}", + "responseCode":200 + }, + "input":{"shape":"GetEventSourceRequest"}, + "output":{"shape":"EventSourceConfiguration"}, + "errors":[ + { + "shape":"ServiceException", + "error":{"httpStatusCode":500}, + "exception":true + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + } + ] + }, + "GetFunction":{ + "name":"GetFunction", + "http":{ + "method":"GET", + "requestUri":"/2014-11-13/functions/{FunctionName}", + "responseCode":200 + }, + "input":{"shape":"GetFunctionRequest"}, + "output":{"shape":"GetFunctionResponse"}, + "errors":[ + { + "shape":"ServiceException", + "error":{"httpStatusCode":500}, + "exception":true + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + } + ] + }, + "GetFunctionConfiguration":{ + "name":"GetFunctionConfiguration", + "http":{ + "method":"GET", + "requestUri":"/2014-11-13/functions/{FunctionName}/configuration", + "responseCode":200 + }, + "input":{"shape":"GetFunctionConfigurationRequest"}, + "output":{"shape":"FunctionConfiguration"}, + "errors":[ + { + "shape":"ServiceException", + "error":{"httpStatusCode":500}, + "exception":true + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + } + ] + }, + "InvokeAsync":{ + "name":"InvokeAsync", + "http":{ + "method":"POST", + "requestUri":"/2014-11-13/functions/{FunctionName}/invoke-async/", + "responseCode":202 + }, + "input":{"shape":"InvokeAsyncRequest"}, + "output":{"shape":"InvokeAsyncResponse"}, + "errors":[ + { + "shape":"ServiceException", + "error":{"httpStatusCode":500}, + "exception":true + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InvalidRequestContentException", + "error":{"httpStatusCode":400}, + "exception":true + } + ] + }, + "ListEventSources":{ + "name":"ListEventSources", + "http":{ + "method":"GET", + "requestUri":"/2014-11-13/event-source-mappings/", + "responseCode":200 + }, + "input":{"shape":"ListEventSourcesRequest"}, + "output":{"shape":"ListEventSourcesResponse"}, + "errors":[ + { + "shape":"ServiceException", + "error":{"httpStatusCode":500}, + "exception":true + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + } + ] + }, + "ListFunctions":{ + "name":"ListFunctions", + "http":{ + "method":"GET", + "requestUri":"/2014-11-13/functions/", + "responseCode":200 + }, + "input":{"shape":"ListFunctionsRequest"}, + "output":{"shape":"ListFunctionsResponse"}, + "errors":[ + { + "shape":"ServiceException", + "error":{"httpStatusCode":500}, + "exception":true + } + ] + }, + "RemoveEventSource":{ + "name":"RemoveEventSource", + "http":{ + "method":"DELETE", + "requestUri":"/2014-11-13/event-source-mappings/{UUID}", + "responseCode":204 + }, + "input":{"shape":"RemoveEventSourceRequest"}, + "errors":[ + { + "shape":"ServiceException", + "error":{"httpStatusCode":500}, + "exception":true + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + } + ] + }, + "UpdateFunctionConfiguration":{ + "name":"UpdateFunctionConfiguration", + "http":{ + "method":"PUT", + "requestUri":"/2014-11-13/functions/{FunctionName}/configuration", + "responseCode":200 + }, + "input":{"shape":"UpdateFunctionConfigurationRequest"}, + "output":{"shape":"FunctionConfiguration"}, + "errors":[ + { + "shape":"ServiceException", + "error":{"httpStatusCode":500}, + "exception":true + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + } + ] + }, + "UploadFunction":{ + "name":"UploadFunction", + "http":{ + "method":"PUT", + "requestUri":"/2014-11-13/functions/{FunctionName}", + "responseCode":201 + }, + "input":{"shape":"UploadFunctionRequest"}, + "output":{"shape":"FunctionConfiguration"}, + "errors":[ + { + "shape":"ServiceException", + "error":{"httpStatusCode":500}, + "exception":true + }, + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + } + ] + } + }, + "shapes":{ + "AddEventSourceRequest":{ + "type":"structure", + "required":[ + "EventSource", + "FunctionName", + "Role" + ], + "members":{ + "EventSource":{"shape":"String"}, + "FunctionName":{"shape":"FunctionName"}, + "Role":{"shape":"RoleArn"}, + "BatchSize":{"shape":"Integer"}, + "Parameters":{"shape":"Map"} + } + }, + "Blob":{ + "type":"blob", + "streaming":true + }, + "DeleteFunctionRequest":{ + "type":"structure", + "required":["FunctionName"], + "members":{ + "FunctionName":{ + "shape":"FunctionName", + "location":"uri", + "locationName":"FunctionName" + } + } + }, + "Description":{ + "type":"string", + "min":0, + "max":256 + }, + "EventSourceConfiguration":{ + "type":"structure", + "members":{ + "UUID":{"shape":"String"}, + "BatchSize":{"shape":"Integer"}, + "EventSource":{"shape":"String"}, + "FunctionName":{"shape":"FunctionName"}, + "Parameters":{"shape":"Map"}, + "Role":{"shape":"RoleArn"}, + "LastModified":{"shape":"Timestamp"}, + "IsActive":{"shape":"Boolean"}, + "Status":{"shape":"String"} + } + }, + "EventSourceList":{ + "type":"list", + "member":{"shape":"EventSourceConfiguration"} + }, + "FunctionArn":{ + "type":"string", + "pattern":"arn:aws:lambda:[a-z]{2}-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-_]+(\\/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})?" + }, + "FunctionCodeLocation":{ + "type":"structure", + "members":{ + "RepositoryType":{"shape":"String"}, + "Location":{"shape":"String"} + } + }, + "FunctionConfiguration":{ + "type":"structure", + "members":{ + "FunctionName":{"shape":"FunctionName"}, + "FunctionARN":{"shape":"FunctionArn"}, + "ConfigurationId":{"shape":"String"}, + "Runtime":{"shape":"Runtime"}, + "Role":{"shape":"RoleArn"}, + "Handler":{"shape":"Handler"}, + "Mode":{"shape":"Mode"}, + "CodeSize":{"shape":"Long"}, + "Description":{"shape":"Description"}, + "Timeout":{"shape":"Timeout"}, + "MemorySize":{"shape":"MemorySize"}, + "LastModified":{"shape":"Timestamp"} + } + }, + "FunctionList":{ + "type":"list", + "member":{"shape":"FunctionConfiguration"} + }, + "FunctionName":{ + "type":"string", + "min":1, + "max":64, + "pattern":"[a-zA-Z0-9-_]+" + }, + "GetEventSourceRequest":{ + "type":"structure", + "required":["UUID"], + "members":{ + "UUID":{ + "shape":"String", + "location":"uri", + "locationName":"UUID" + } + } + }, + "GetFunctionConfigurationRequest":{ + "type":"structure", + "required":["FunctionName"], + "members":{ + "FunctionName":{ + "shape":"FunctionName", + "location":"uri", + "locationName":"FunctionName" + } + } + }, + "GetFunctionRequest":{ + "type":"structure", + "required":["FunctionName"], + "members":{ + "FunctionName":{ + "shape":"FunctionName", + "location":"uri", + "locationName":"FunctionName" + } + } + }, + "GetFunctionResponse":{ + "type":"structure", + "members":{ + "Configuration":{"shape":"FunctionConfiguration"}, + "Code":{"shape":"FunctionCodeLocation"} + } + }, + "Handler":{ + "type":"string", + "pattern":"[a-zA-Z0-9./\\-_]+" + }, + "HttpStatus":{"type":"integer"}, + "Integer":{"type":"integer"}, + "InvalidParameterValueException":{ + "type":"structure", + "members":{ + "Type":{"shape":"String"}, + "message":{"shape":"String"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidRequestContentException":{ + "type":"structure", + "members":{ + "Type":{"shape":"String"}, + "message":{"shape":"String"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvokeAsyncRequest":{ + "type":"structure", + "required":[ + "FunctionName", + "InvokeArgs" + ], + "members":{ + "FunctionName":{ + "shape":"FunctionName", + "location":"uri", + "locationName":"FunctionName" + }, + "InvokeArgs":{"shape":"Blob"} + }, + "payload":"InvokeArgs" + }, + "InvokeAsyncResponse":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"HttpStatus", + "location":"statusCode" + } + } + }, + "ListEventSourcesRequest":{ + "type":"structure", + "members":{ + "EventSourceArn":{ + "shape":"String", + "location":"querystring", + "locationName":"EventSource" + }, + "FunctionName":{ + "shape":"FunctionName", + "location":"querystring", + "locationName":"FunctionName" + }, + "Marker":{ + "shape":"String", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"MaxListItems", + "location":"querystring", + "locationName":"MaxItems" + } + } + }, + "ListEventSourcesResponse":{ + "type":"structure", + "members":{ + "NextMarker":{"shape":"String"}, + "EventSources":{"shape":"EventSourceList"} + } + }, + "ListFunctionsRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"MaxListItems", + "location":"querystring", + "locationName":"MaxItems" + } + } + }, + "ListFunctionsResponse":{ + "type":"structure", + "members":{ + "NextMarker":{"shape":"String"}, + "Functions":{"shape":"FunctionList"} + } + }, + "Long":{"type":"long"}, + "Map":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"String"} + }, + "MaxListItems":{ + "type":"integer", + "min":1, + "max":10000 + }, + "MemorySize":{ + "type":"integer", + "min":128, + "max":1024 + }, + "Mode":{ + "type":"string", + "enum":["event"] + }, + "RemoveEventSourceRequest":{ + "type":"structure", + "required":["UUID"], + "members":{ + "UUID":{ + "shape":"String", + "location":"uri", + "locationName":"UUID" + } + } + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "Type":{"shape":"String"}, + "Message":{"shape":"String"} + }, + "error":{"httpStatusCode":404}, + "exception":true + }, + "RoleArn":{ + "type":"string", + "pattern":"arn:aws:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+" + }, + "Runtime":{ + "type":"string", + "enum":["nodejs"] + }, + "ServiceException":{ + "type":"structure", + "members":{ + "Type":{"shape":"String"}, + "Message":{"shape":"String"} + }, + "error":{"httpStatusCode":500}, + "exception":true + }, + "String":{"type":"string"}, + "Timeout":{ + "type":"integer", + "min":1, + "max":60 + }, + "Timestamp":{"type":"string"}, + "UpdateFunctionConfigurationRequest":{ + "type":"structure", + "required":["FunctionName"], + "members":{ + "FunctionName":{ + "shape":"FunctionName", + "location":"uri", + "locationName":"FunctionName" + }, + "Role":{ + "shape":"RoleArn", + "location":"querystring", + "locationName":"Role" + }, + "Handler":{ + "shape":"Handler", + "location":"querystring", + "locationName":"Handler" + }, + "Description":{ + "shape":"Description", + "location":"querystring", + "locationName":"Description" + }, + "Timeout":{ + "shape":"Timeout", + "location":"querystring", + "locationName":"Timeout" + }, + "MemorySize":{ + "shape":"MemorySize", + "location":"querystring", + "locationName":"MemorySize" + } + } + }, + "UploadFunctionRequest":{ + "type":"structure", + "required":[ + "FunctionName", + "FunctionZip", + "Runtime", + "Role", + "Handler", + "Mode" + ], + "members":{ + "FunctionName":{ + "shape":"FunctionName", + "location":"uri", + "locationName":"FunctionName" + }, + "FunctionZip":{"shape":"Blob"}, + "Runtime":{ + "shape":"Runtime", + "location":"querystring", + "locationName":"Runtime" + }, + "Role":{ + "shape":"RoleArn", + "location":"querystring", + "locationName":"Role" + }, + "Handler":{ + "shape":"Handler", + "location":"querystring", + "locationName":"Handler" + }, + "Mode":{ + "shape":"Mode", + "location":"querystring", + "locationName":"Mode" + }, + "Description":{ + "shape":"Description", + "location":"querystring", + "locationName":"Description" + }, + "Timeout":{ + "shape":"Timeout", + "location":"querystring", + "locationName":"Timeout" + }, + "MemorySize":{ + "shape":"MemorySize", + "location":"querystring", + "locationName":"MemorySize" + } + }, + "payload":"FunctionZip" + }, + "Boolean":{"type":"boolean"} + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/lambda/2014-11-11/docs-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/lambda/2014-11-11/docs-2.json new file mode 100644 index 000000000..4ef27761b --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/lambda/2014-11-11/docs-2.json @@ -0,0 +1,303 @@ +{ + "operations": { + "AddEventSource": "Identifies a stream as an event source for an AWS Lambda function. It can be either an Amazon Kinesis stream or a Amazon DynamoDB stream. AWS Lambda invokes the specified function when records are posted to the stream.
This is the pull model, where AWS Lambda invokes the function. For more information, go to AWS Lambda: How it Works in the AWS Lambda Developer Guide.
This association between an Amazon Kinesis stream and an AWS Lambda function is called the event source mapping. You provide the configuration information (for example, which stream to read from and which AWS Lambda function to invoke) for the event source mapping in the request body.
Each event source, such as a Kinesis stream, can only be associated with one AWS Lambda function. If you call AddEventSource for an event source that is already mapped to another AWS Lambda function, the existing mapping is updated to call the new function instead of the old one.
This operation requires permission for the iam:PassRole action for the IAM role. It also requires permission for the lambda:AddEventSource action.
Deletes the specified Lambda function code and configuration.
This operation requires permission for the lambda:DeleteFunction action.
Returns configuration information for the specified event source mapping (see AddEventSource).
This operation requires permission for the lambda:GetEventSource action.
Returns the configuration information of the Lambda function and a presigned URL link to the .zip file you uploaded with UploadFunction so you can download the .zip file. Note that the URL is valid for up to 10 minutes. The configuration information is the same information you provided as parameters when uploading the function.
This operation requires permission for the lambda:GetFunction action.
Returns the configuration information of the Lambda function. This the same information you provided as parameters when uploading the function by using UploadFunction.
This operation requires permission for the lambda:GetFunctionConfiguration operation.
Submits an invocation request to AWS Lambda. Upon receiving the request, Lambda executes the specified function asynchronously. To see the logs generated by the Lambda function execution, see the CloudWatch logs console.
This operation requires permission for the lambda:InvokeFunction action.
Returns a list of event source mappings you created using the AddEventSource (see AddEventSource), where you identify a stream as event source. This list does not include Amazon S3 event sources.
For each mapping, the API returns configuration information. You can optionally specify filters to retrieve specific event source mappings.
This operation requires permission for the lambda:ListEventSources action.
Returns a list of your Lambda functions. For each function, the response includes the function configuration information. You must use GetFunction to retrieve the code for your function.
This operation requires permission for the lambda:ListFunctions action.
Removes an event source mapping. This means AWS Lambda will no longer invoke the function for events in the associated source.
This operation requires permission for the lambda:RemoveEventSource action.
Updates the configuration parameters for the specified Lambda function by using the values provided in the request. You provide only the parameters you want to change. This operation must only be used on an existing Lambda function and cannot be used to update the function's code.
This operation requires permission for the lambda:UpdateFunctionConfiguration action.
Creates a new Lambda function or updates an existing function. The function metadata is created from the request parameters, and the code for the function is provided by a .zip file in the request body. If the function name already exists, the existing Lambda function is updated with the new code and metadata.
This operation requires permission for the lambda:UploadFunction action.
Overview
This is the AWS Lambda API Reference. The AWS Lambda Developer Guide provides additional information. For the service overview, go to What is AWS Lambda, and for information about how the service works, go to AWS LambdaL How it Works in the AWS Lambda Developer Guide.
", + "shapes": { + "AddEventSourceRequest": { + "base": null, + "refs": { + } + }, + "Blob": { + "base": null, + "refs": { + "InvokeAsyncRequest$InvokeArgs": "JSON that you want to provide to your Lambda function as input.
", + "UploadFunctionRequest$FunctionZip": "A .zip file containing your packaged source code. For more information about creating a .zip file, go to AWS LambdaL How it Works in the AWS Lambda Developer Guide.
" + } + }, + "DeleteFunctionRequest": { + "base": null, + "refs": { + } + }, + "Description": { + "base": null, + "refs": { + "FunctionConfiguration$Description": "The user-provided description.
", + "UpdateFunctionConfigurationRequest$Description": "A short user-defined function description. Lambda does not use this value. Assign a meaningful description as you see fit.
", + "UploadFunctionRequest$Description": "A short, user-defined function description. Lambda does not use this value. Assign a meaningful description as you see fit.
" + } + }, + "EventSourceConfiguration": { + "base": "Describes mapping between an Amazon Kinesis stream and a Lambda function.
", + "refs": { + "EventSourceList$member": null + } + }, + "EventSourceList": { + "base": null, + "refs": { + "ListEventSourcesResponse$EventSources": "An arrary of EventSourceConfiguration objects.
The Amazon Resource Name (ARN) assigned to the function.
" + } + }, + "FunctionCodeLocation": { + "base": "The object for the Lambda function location.
", + "refs": { + "GetFunctionResponse$Code": null + } + }, + "FunctionConfiguration": { + "base": "A complex type that describes function metadata.
", + "refs": { + "FunctionList$member": null, + "GetFunctionResponse$Configuration": null + } + }, + "FunctionList": { + "base": null, + "refs": { + "ListFunctionsResponse$Functions": "A list of Lambda functions.
" + } + }, + "FunctionName": { + "base": null, + "refs": { + "AddEventSourceRequest$FunctionName": "The Lambda function to invoke when AWS Lambda detects an event on the stream.
", + "DeleteFunctionRequest$FunctionName": "The Lambda function to delete.
", + "EventSourceConfiguration$FunctionName": "The Lambda function to invoke when AWS Lambda detects an event on the stream.
", + "FunctionConfiguration$FunctionName": "The name of the function.
", + "GetFunctionConfigurationRequest$FunctionName": "The name of the Lambda function for which you want to retrieve the configuration information.
", + "GetFunctionRequest$FunctionName": "The Lambda function name.
", + "InvokeAsyncRequest$FunctionName": "The Lambda function name.
", + "ListEventSourcesRequest$FunctionName": "The name of the AWS Lambda function.
", + "UpdateFunctionConfigurationRequest$FunctionName": "The name of the Lambda function.
", + "UploadFunctionRequest$FunctionName": "The name you want to assign to the function you are uploading. The function names appear in the console and are returned in the ListFunctions API. Function names are used to specify functions to other AWS Lambda APIs, such as InvokeAsync.
" + } + }, + "GetEventSourceRequest": { + "base": null, + "refs": { + } + }, + "GetFunctionConfigurationRequest": { + "base": null, + "refs": { + } + }, + "GetFunctionRequest": { + "base": null, + "refs": { + } + }, + "GetFunctionResponse": { + "base": "This response contains the object for AWS Lambda function location (see API_FunctionCodeLocation
", + "refs": { + } + }, + "Handler": { + "base": null, + "refs": { + "FunctionConfiguration$Handler": "The function Lambda calls to begin executing your function.
", + "UpdateFunctionConfigurationRequest$Handler": "The function that Lambda calls to begin executing your function. For Node.js, it is the module-name.export value in your function.
", + "UploadFunctionRequest$Handler": "The function that Lambda calls to begin execution. For Node.js, it is the module-name.export value in your function.
" + } + }, + "HttpStatus": { + "base": null, + "refs": { + "InvokeAsyncResponse$Status": "It will be 202 upon success.
" + } + }, + "Integer": { + "base": null, + "refs": { + "AddEventSourceRequest$BatchSize": "The largest number of records that AWS Lambda will give to your function in a single event. The default is 100 records.
", + "EventSourceConfiguration$BatchSize": "The largest number of records that AWS Lambda will POST in the invocation request to your function.
" + } + }, + "InvalidParameterValueException": { + "base": "One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the UploadFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception.
The request body could not be parsed as JSON.
", + "refs": { + } + }, + "InvokeAsyncRequest": { + "base": null, + "refs": { + } + }, + "InvokeAsyncResponse": { + "base": "Upon success, it returns empty response. Otherwise, throws an exception.
", + "refs": { + } + }, + "ListEventSourcesRequest": { + "base": null, + "refs": { + } + }, + "ListEventSourcesResponse": { + "base": "Contains a list of event sources (see API_EventSourceConfiguration)
", + "refs": { + } + }, + "ListFunctionsRequest": { + "base": null, + "refs": { + } + }, + "ListFunctionsResponse": { + "base": "Contains a list of AWS Lambda function configurations (see API_FunctionConfiguration.
", + "refs": { + } + }, + "Long": { + "base": null, + "refs": { + "FunctionConfiguration$CodeSize": "The size, in bytes, of the function .zip file you uploaded.
" + } + }, + "Map": { + "base": null, + "refs": { + "AddEventSourceRequest$Parameters": "A map (key-value pairs) defining the configuration for AWS Lambda to use when reading the event source. Currently, AWS Lambda supports only the InitialPositionInStream key. The valid values are: \"TRIM_HORIZON\" and \"LATEST\". The default value is \"TRIM_HORIZON\". For more information, go to ShardIteratorType in the Amazon Kinesis Service API Reference.
The map (key-value pairs) defining the configuration for AWS Lambda to use when reading the event source.
" + } + }, + "MaxListItems": { + "base": null, + "refs": { + "ListEventSourcesRequest$MaxItems": "Optional integer. Specifies the maximum number of event sources to return in response. This value must be greater than 0.
", + "ListFunctionsRequest$MaxItems": "Optional integer. Specifies the maximum number of AWS Lambda functions to return in response. This parameter value must be greater than 0.
" + } + }, + "MemorySize": { + "base": null, + "refs": { + "FunctionConfiguration$MemorySize": "The memory size, in MB, you configured for the function. Must be a multiple of 64 MB.
", + "UpdateFunctionConfigurationRequest$MemorySize": "The amount of memory, in MB, your Lambda function is given. Lambda uses this memory size to infer the amount of CPU allocated to your function. Your function use-case determines your CPU and memory requirements. For example, a database operation might need less memory compared to an image processing function. The default value is 128 MB. The value must be a multiple of 64 MB.
", + "UploadFunctionRequest$MemorySize": "The amount of memory, in MB, your Lambda function is given. Lambda uses this memory size to infer the amount of CPU allocated to your function. Your function use-case determines your CPU and memory requirements. For example, database operation might need less memory compared to image processing function. The default value is 128 MB. The value must be a multiple of 64 MB.
" + } + }, + "Mode": { + "base": null, + "refs": { + "FunctionConfiguration$Mode": "The type of the Lambda function you uploaded.
", + "UploadFunctionRequest$Mode": "How the Lambda function will be invoked. Lambda supports only the \"event\" mode.
" + } + }, + "RemoveEventSourceRequest": { + "base": null, + "refs": { + } + }, + "ResourceNotFoundException": { + "base": "The function or the event source specified in the request does not exist.
", + "refs": { + } + }, + "RoleArn": { + "base": null, + "refs": { + "AddEventSourceRequest$Role": "The ARN of the IAM role (invocation role) that AWS Lambda can assume to read from the stream and invoke the function.
", + "EventSourceConfiguration$Role": "The ARN of the IAM role (invocation role) that AWS Lambda can assume to read from the stream and invoke the function.
", + "FunctionConfiguration$Role": "The Amazon Resource Name (ARN) of the IAM role that Lambda assumes when it executes your function to access any other Amazon Web Services (AWS) resources.
", + "UpdateFunctionConfigurationRequest$Role": "The Amazon Resource Name (ARN) of the IAM role that Lambda will assume when it executes your function.
", + "UploadFunctionRequest$Role": "The Amazon Resource Name (ARN) of the IAM role that Lambda assumes when it executes your function to access any other Amazon Web Services (AWS) resources.
" + } + }, + "Runtime": { + "base": null, + "refs": { + "FunctionConfiguration$Runtime": "The runtime environment for the Lambda function.
", + "UploadFunctionRequest$Runtime": "The runtime environment for the Lambda function you are uploading. Currently, Lambda supports only \"nodejs\" as the runtime.
" + } + }, + "ServiceException": { + "base": "The AWS Lambda service encountered an internal error.
", + "refs": { + } + }, + "String": { + "base": null, + "refs": { + "AddEventSourceRequest$EventSource": "The Amazon Resource Name (ARN) of the Amazon Kinesis stream that is the event source. Any record added to this stream causes AWS Lambda to invoke your Lambda function. AWS Lambda POSTs the Amazon Kinesis event, containing records, to your Lambda function as JSON.
", + "EventSourceConfiguration$UUID": "The AWS Lambda assigned opaque identifier for the mapping.
", + "EventSourceConfiguration$EventSource": "The Amazon Resource Name (ARN) of the Amazon Kinesis stream that is the source of events.
", + "EventSourceConfiguration$Status": "The description of the health of the event source mapping. Valid values are: \"PENDING\", \"OK\", and \"PROBLEM:message\". Initially this staus is \"PENDING\". When AWS Lambda begins processing events, it changes the status to \"OK\".
", + "FunctionCodeLocation$RepositoryType": "The repository from which you can download the function.
", + "FunctionCodeLocation$Location": "The presigned URL you can use to download the function's .zip file that you previously uploaded. The URL is valid for up to 10 minutes.
", + "FunctionConfiguration$ConfigurationId": "A Lambda-assigned unique identifier for the current function code and related configuration.
", + "GetEventSourceRequest$UUID": "The AWS Lambda assigned ID of the event source mapping.
", + "InvalidParameterValueException$Type": null, + "InvalidParameterValueException$message": null, + "InvalidRequestContentException$Type": null, + "InvalidRequestContentException$message": null, + "ListEventSourcesRequest$EventSourceArn": "The Amazon Resource Name (ARN) of the Amazon Kinesis stream.
", + "ListEventSourcesRequest$Marker": "Optional string. An opaque pagination token returned from a previous ListEventSources operation. If present, specifies to continue the list from where the returning call left off.
A string, present if there are more event source mappings.
", + "ListFunctionsRequest$Marker": "Optional string. An opaque pagination token returned from a previous ListFunctions operation. If present, indicates where to continue the listing.
A string, present if there are more functions.
", + "Map$key": null, + "Map$value": null, + "RemoveEventSourceRequest$UUID": "The event source mapping ID.
", + "ResourceNotFoundException$Type": null, + "ResourceNotFoundException$Message": null, + "ServiceException$Type": null, + "ServiceException$Message": null + } + }, + "Timeout": { + "base": null, + "refs": { + "FunctionConfiguration$Timeout": "The function execution time at which Lambda should terminate the function. Because the execution time has cost implications, we recommend you set this value based on your expected execution time. The default is 3 seconds.
", + "UpdateFunctionConfigurationRequest$Timeout": "The function execution time at which Lambda should terminate the function. Because the execution time has cost implications, we recommend you set this value based on your expected execution time. The default is 3 seconds.
", + "UploadFunctionRequest$Timeout": "The function execution time at which Lambda should terminate the function. Because the execution time has cost implications, we recommend you set this value based on your expected execution time. The default is 3 seconds.
" + } + }, + "Timestamp": { + "base": null, + "refs": { + "EventSourceConfiguration$LastModified": "The UTC time string indicating the last time the event mapping was updated.
", + "FunctionConfiguration$LastModified": "The timestamp of the last time you updated the function.
" + } + }, + "UpdateFunctionConfigurationRequest": { + "base": null, + "refs": { + } + }, + "UploadFunctionRequest": { + "base": null, + "refs": { + } + }, + "Boolean": { + "base": null, + "refs": { + "EventSourceConfiguration$IsActive": "Indicates whether the event source mapping is currently honored. Events are only processes if IsActive is true.
" + } + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/lambda/2014-11-11/paginators-1.json b/vendor/github.com/aws/aws-sdk-go/models/apis/lambda/2014-11-11/paginators-1.json new file mode 100644 index 000000000..deaf07d38 --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/lambda/2014-11-11/paginators-1.json @@ -0,0 +1,16 @@ +{ + "pagination": { + "ListEventSources": { + "input_token": "Marker", + "output_token": "NextMarker", + "limit_key": "MaxItems", + "result_key": "EventSources" + }, + "ListFunctions": { + "input_token": "Marker", + "output_token": "NextMarker", + "limit_key": "MaxItems", + "result_key": "Functions" + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/lambda/2015-03-31/api-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/lambda/2015-03-31/api-2.json new file mode 100644 index 000000000..93c5e2e72 --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/lambda/2015-03-31/api-2.json @@ -0,0 +1,1342 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2015-03-31", + "endpointPrefix":"lambda", + "protocol":"rest-json", + "serviceFullName":"AWS Lambda", + "signatureVersion":"v4" + }, + "operations":{ + "AddPermission":{ + "name":"AddPermission", + "http":{ + "method":"POST", + "requestUri":"/2015-03-31/functions/{FunctionName}/policy", + "responseCode":201 + }, + "input":{"shape":"AddPermissionRequest"}, + "output":{"shape":"AddPermissionResponse"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceConflictException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"PolicyLengthExceededException"}, + {"shape":"TooManyRequestsException"} + ] + }, + "CreateAlias":{ + "name":"CreateAlias", + "http":{ + "method":"POST", + "requestUri":"/2015-03-31/functions/{FunctionName}/aliases", + "responseCode":201 + }, + "input":{"shape":"CreateAliasRequest"}, + "output":{"shape":"AliasConfiguration"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceConflictException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"TooManyRequestsException"} + ] + }, + "CreateEventSourceMapping":{ + "name":"CreateEventSourceMapping", + "http":{ + "method":"POST", + "requestUri":"/2015-03-31/event-source-mappings/", + "responseCode":202 + }, + "input":{"shape":"CreateEventSourceMappingRequest"}, + "output":{"shape":"EventSourceMappingConfiguration"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ResourceConflictException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "CreateFunction":{ + "name":"CreateFunction", + "http":{ + "method":"POST", + "requestUri":"/2015-03-31/functions", + "responseCode":201 + }, + "input":{"shape":"CreateFunctionRequest"}, + "output":{"shape":"FunctionConfiguration"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceConflictException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"CodeStorageExceededException"} + ] + }, + "DeleteAlias":{ + "name":"DeleteAlias", + "http":{ + "method":"DELETE", + "requestUri":"/2015-03-31/functions/{FunctionName}/aliases/{Name}", + "responseCode":204 + }, + "input":{"shape":"DeleteAliasRequest"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"TooManyRequestsException"} + ] + }, + "DeleteEventSourceMapping":{ + "name":"DeleteEventSourceMapping", + "http":{ + "method":"DELETE", + "requestUri":"/2015-03-31/event-source-mappings/{UUID}", + "responseCode":202 + }, + "input":{"shape":"DeleteEventSourceMappingRequest"}, + "output":{"shape":"EventSourceMappingConfiguration"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"TooManyRequestsException"} + ] + }, + "DeleteFunction":{ + "name":"DeleteFunction", + "http":{ + "method":"DELETE", + "requestUri":"/2015-03-31/functions/{FunctionName}", + "responseCode":204 + }, + "input":{"shape":"DeleteFunctionRequest"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ResourceConflictException"} + ] + }, + "GetAlias":{ + "name":"GetAlias", + "http":{ + "method":"GET", + "requestUri":"/2015-03-31/functions/{FunctionName}/aliases/{Name}", + "responseCode":200 + }, + "input":{"shape":"GetAliasRequest"}, + "output":{"shape":"AliasConfiguration"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"TooManyRequestsException"} + ] + }, + "GetEventSourceMapping":{ + "name":"GetEventSourceMapping", + "http":{ + "method":"GET", + "requestUri":"/2015-03-31/event-source-mappings/{UUID}", + "responseCode":200 + }, + "input":{"shape":"GetEventSourceMappingRequest"}, + "output":{"shape":"EventSourceMappingConfiguration"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"TooManyRequestsException"} + ] + }, + "GetFunction":{ + "name":"GetFunction", + "http":{ + "method":"GET", + "requestUri":"/2015-03-31/functions/{FunctionName}", + "responseCode":200 + }, + "input":{"shape":"GetFunctionRequest"}, + "output":{"shape":"GetFunctionResponse"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InvalidParameterValueException"} + ] + }, + "GetFunctionConfiguration":{ + "name":"GetFunctionConfiguration", + "http":{ + "method":"GET", + "requestUri":"/2015-03-31/functions/{FunctionName}/configuration", + "responseCode":200 + }, + "input":{"shape":"GetFunctionConfigurationRequest"}, + "output":{"shape":"FunctionConfiguration"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InvalidParameterValueException"} + ] + }, + "GetPolicy":{ + "name":"GetPolicy", + "http":{ + "method":"GET", + "requestUri":"/2015-03-31/functions/{FunctionName}/policy", + "responseCode":200 + }, + "input":{"shape":"GetPolicyRequest"}, + "output":{"shape":"GetPolicyResponse"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InvalidParameterValueException"} + ] + }, + "Invoke":{ + "name":"Invoke", + "http":{ + "method":"POST", + "requestUri":"/2015-03-31/functions/{FunctionName}/invocations" + }, + "input":{"shape":"InvocationRequest"}, + "output":{"shape":"InvocationResponse"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidRequestContentException"}, + {"shape":"RequestTooLargeException"}, + {"shape":"UnsupportedMediaTypeException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"EC2UnexpectedException"}, + {"shape":"SubnetIPAddressLimitReachedException"}, + {"shape":"ENILimitReachedException"}, + {"shape":"EC2ThrottledException"}, + {"shape":"EC2AccessDeniedException"}, + {"shape":"InvalidSubnetIDException"}, + {"shape":"InvalidSecurityGroupIDException"} + ] + }, + "InvokeAsync":{ + "name":"InvokeAsync", + "http":{ + "method":"POST", + "requestUri":"/2014-11-13/functions/{FunctionName}/invoke-async/", + "responseCode":202 + }, + "input":{"shape":"InvokeAsyncRequest"}, + "output":{"shape":"InvokeAsyncResponse"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidRequestContentException"} + ], + "deprecated":true + }, + "ListAliases":{ + "name":"ListAliases", + "http":{ + "method":"GET", + "requestUri":"/2015-03-31/functions/{FunctionName}/aliases", + "responseCode":200 + }, + "input":{"shape":"ListAliasesRequest"}, + "output":{"shape":"ListAliasesResponse"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"TooManyRequestsException"} + ] + }, + "ListEventSourceMappings":{ + "name":"ListEventSourceMappings", + "http":{ + "method":"GET", + "requestUri":"/2015-03-31/event-source-mappings/", + "responseCode":200 + }, + "input":{"shape":"ListEventSourceMappingsRequest"}, + "output":{"shape":"ListEventSourceMappingsResponse"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"TooManyRequestsException"} + ] + }, + "ListFunctions":{ + "name":"ListFunctions", + "http":{ + "method":"GET", + "requestUri":"/2015-03-31/functions/", + "responseCode":200 + }, + "input":{"shape":"ListFunctionsRequest"}, + "output":{"shape":"ListFunctionsResponse"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"TooManyRequestsException"} + ] + }, + "ListVersionsByFunction":{ + "name":"ListVersionsByFunction", + "http":{ + "method":"GET", + "requestUri":"/2015-03-31/functions/{FunctionName}/versions", + "responseCode":200 + }, + "input":{"shape":"ListVersionsByFunctionRequest"}, + "output":{"shape":"ListVersionsByFunctionResponse"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"TooManyRequestsException"} + ] + }, + "PublishVersion":{ + "name":"PublishVersion", + "http":{ + "method":"POST", + "requestUri":"/2015-03-31/functions/{FunctionName}/versions", + "responseCode":201 + }, + "input":{"shape":"PublishVersionRequest"}, + "output":{"shape":"FunctionConfiguration"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"CodeStorageExceededException"} + ] + }, + "RemovePermission":{ + "name":"RemovePermission", + "http":{ + "method":"DELETE", + "requestUri":"/2015-03-31/functions/{FunctionName}/policy/{StatementId}", + "responseCode":204 + }, + "input":{"shape":"RemovePermissionRequest"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"TooManyRequestsException"} + ] + }, + "UpdateAlias":{ + "name":"UpdateAlias", + "http":{ + "method":"PUT", + "requestUri":"/2015-03-31/functions/{FunctionName}/aliases/{Name}", + "responseCode":200 + }, + "input":{"shape":"UpdateAliasRequest"}, + "output":{"shape":"AliasConfiguration"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"TooManyRequestsException"} + ] + }, + "UpdateEventSourceMapping":{ + "name":"UpdateEventSourceMapping", + "http":{ + "method":"PUT", + "requestUri":"/2015-03-31/event-source-mappings/{UUID}", + "responseCode":202 + }, + "input":{"shape":"UpdateEventSourceMappingRequest"}, + "output":{"shape":"EventSourceMappingConfiguration"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"ResourceConflictException"} + ] + }, + "UpdateFunctionCode":{ + "name":"UpdateFunctionCode", + "http":{ + "method":"PUT", + "requestUri":"/2015-03-31/functions/{FunctionName}/code", + "responseCode":200 + }, + "input":{"shape":"UpdateFunctionCodeRequest"}, + "output":{"shape":"FunctionConfiguration"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"CodeStorageExceededException"} + ] + }, + "UpdateFunctionConfiguration":{ + "name":"UpdateFunctionConfiguration", + "http":{ + "method":"PUT", + "requestUri":"/2015-03-31/functions/{FunctionName}/configuration", + "responseCode":200 + }, + "input":{"shape":"UpdateFunctionConfigurationRequest"}, + "output":{"shape":"FunctionConfiguration"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"TooManyRequestsException"} + ] + } + }, + "shapes":{ + "Action":{ + "type":"string", + "pattern":"(lambda:[*]|lambda:[a-zA-Z]+|[*])" + }, + "AddPermissionRequest":{ + "type":"structure", + "required":[ + "FunctionName", + "StatementId", + "Action", + "Principal" + ], + "members":{ + "FunctionName":{ + "shape":"FunctionName", + "location":"uri", + "locationName":"FunctionName" + }, + "StatementId":{"shape":"StatementId"}, + "Action":{"shape":"Action"}, + "Principal":{"shape":"Principal"}, + "SourceArn":{"shape":"Arn"}, + "SourceAccount":{"shape":"SourceOwner"}, + "EventSourceToken":{"shape":"EventSourceToken"}, + "Qualifier":{ + "shape":"Qualifier", + "location":"querystring", + "locationName":"Qualifier" + } + } + }, + "AddPermissionResponse":{ + "type":"structure", + "members":{ + "Statement":{"shape":"String"} + } + }, + "Alias":{ + "type":"string", + "max":128, + "min":1, + "pattern":"(?!^[0-9]+$)([a-zA-Z0-9-_]+)" + }, + "AliasConfiguration":{ + "type":"structure", + "members":{ + "AliasArn":{"shape":"FunctionArn"}, + "Name":{"shape":"Alias"}, + "FunctionVersion":{"shape":"Version"}, + "Description":{"shape":"Description"} + } + }, + "AliasList":{ + "type":"list", + "member":{"shape":"AliasConfiguration"} + }, + "Arn":{ + "type":"string", + "pattern":"arn:aws:([a-zA-Z0-9\\-])+:([a-z]{2}-[a-z]+-\\d{1})?:(\\d{12})?:(.*)" + }, + "BatchSize":{ + "type":"integer", + "max":10000, + "min":1 + }, + "Blob":{"type":"blob"}, + "BlobStream":{ + "type":"blob", + "streaming":true + }, + "Boolean":{"type":"boolean"}, + "CodeStorageExceededException":{ + "type":"structure", + "members":{ + "Type":{"shape":"String"}, + "message":{"shape":"String"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "CreateAliasRequest":{ + "type":"structure", + "required":[ + "FunctionName", + "Name", + "FunctionVersion" + ], + "members":{ + "FunctionName":{ + "shape":"FunctionName", + "location":"uri", + "locationName":"FunctionName" + }, + "Name":{"shape":"Alias"}, + "FunctionVersion":{"shape":"Version"}, + "Description":{"shape":"Description"} + } + }, + "CreateEventSourceMappingRequest":{ + "type":"structure", + "required":[ + "EventSourceArn", + "FunctionName", + "StartingPosition" + ], + "members":{ + "EventSourceArn":{"shape":"Arn"}, + "FunctionName":{"shape":"FunctionName"}, + "Enabled":{"shape":"Enabled"}, + "BatchSize":{"shape":"BatchSize"}, + "StartingPosition":{"shape":"EventSourcePosition"} + } + }, + "CreateFunctionRequest":{ + "type":"structure", + "required":[ + "FunctionName", + "Runtime", + "Role", + "Handler", + "Code" + ], + "members":{ + "FunctionName":{"shape":"FunctionName"}, + "Runtime":{"shape":"Runtime"}, + "Role":{"shape":"RoleArn"}, + "Handler":{"shape":"Handler"}, + "Code":{"shape":"FunctionCode"}, + "Description":{"shape":"Description"}, + "Timeout":{"shape":"Timeout"}, + "MemorySize":{"shape":"MemorySize"}, + "Publish":{"shape":"Boolean"}, + "VpcConfig":{"shape":"VpcConfig"} + } + }, + "Date":{"type":"timestamp"}, + "DeleteAliasRequest":{ + "type":"structure", + "required":[ + "FunctionName", + "Name" + ], + "members":{ + "FunctionName":{ + "shape":"FunctionName", + "location":"uri", + "locationName":"FunctionName" + }, + "Name":{ + "shape":"Alias", + "location":"uri", + "locationName":"Name" + } + } + }, + "DeleteEventSourceMappingRequest":{ + "type":"structure", + "required":["UUID"], + "members":{ + "UUID":{ + "shape":"String", + "location":"uri", + "locationName":"UUID" + } + } + }, + "DeleteFunctionRequest":{ + "type":"structure", + "required":["FunctionName"], + "members":{ + "FunctionName":{ + "shape":"FunctionName", + "location":"uri", + "locationName":"FunctionName" + }, + "Qualifier":{ + "shape":"Qualifier", + "location":"querystring", + "locationName":"Qualifier" + } + } + }, + "Description":{ + "type":"string", + "max":256, + "min":0 + }, + "EC2AccessDeniedException":{ + "type":"structure", + "members":{ + "Type":{"shape":"String"}, + "Message":{"shape":"String"} + }, + "error":{"httpStatusCode":502}, + "exception":true + }, + "EC2ThrottledException":{ + "type":"structure", + "members":{ + "Type":{"shape":"String"}, + "Message":{"shape":"String"} + }, + "error":{"httpStatusCode":502}, + "exception":true + }, + "EC2UnexpectedException":{ + "type":"structure", + "members":{ + "Type":{"shape":"String"}, + "Message":{"shape":"String"}, + "EC2ErrorCode":{"shape":"String"} + }, + "error":{"httpStatusCode":502}, + "exception":true + }, + "ENILimitReachedException":{ + "type":"structure", + "members":{ + "Type":{"shape":"String"}, + "Message":{"shape":"String"} + }, + "error":{"httpStatusCode":502}, + "exception":true + }, + "Enabled":{"type":"boolean"}, + "EventSourceMappingConfiguration":{ + "type":"structure", + "members":{ + "UUID":{"shape":"String"}, + "BatchSize":{"shape":"BatchSize"}, + "EventSourceArn":{"shape":"Arn"}, + "FunctionArn":{"shape":"FunctionArn"}, + "LastModified":{"shape":"Date"}, + "LastProcessingResult":{"shape":"String"}, + "State":{"shape":"String"}, + "StateTransitionReason":{"shape":"String"} + } + }, + "EventSourceMappingsList":{ + "type":"list", + "member":{"shape":"EventSourceMappingConfiguration"} + }, + "EventSourcePosition":{ + "type":"string", + "enum":[ + "TRIM_HORIZON", + "LATEST" + ] + }, + "EventSourceToken":{ + "type":"string", + "max":256, + "min":0, + "pattern":"[a-zA-Z0-9._\\-]+" + }, + "FunctionArn":{ + "type":"string", + "pattern":"arn:aws:lambda:[a-z]{2}-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-_]+(:(\\$LATEST|[a-zA-Z0-9-_]+))?" + }, + "FunctionCode":{ + "type":"structure", + "members":{ + "ZipFile":{"shape":"Blob"}, + "S3Bucket":{"shape":"S3Bucket"}, + "S3Key":{"shape":"S3Key"}, + "S3ObjectVersion":{"shape":"S3ObjectVersion"} + } + }, + "FunctionCodeLocation":{ + "type":"structure", + "members":{ + "RepositoryType":{"shape":"String"}, + "Location":{"shape":"String"} + } + }, + "FunctionConfiguration":{ + "type":"structure", + "members":{ + "FunctionName":{"shape":"FunctionName"}, + "FunctionArn":{"shape":"FunctionArn"}, + "Runtime":{"shape":"Runtime"}, + "Role":{"shape":"RoleArn"}, + "Handler":{"shape":"Handler"}, + "CodeSize":{"shape":"Long"}, + "Description":{"shape":"Description"}, + "Timeout":{"shape":"Timeout"}, + "MemorySize":{"shape":"MemorySize"}, + "LastModified":{"shape":"Timestamp"}, + "CodeSha256":{"shape":"String"}, + "Version":{"shape":"Version"}, + "VpcConfig":{"shape":"VpcConfigResponse"} + } + }, + "FunctionList":{ + "type":"list", + "member":{"shape":"FunctionConfiguration"} + }, + "FunctionName":{ + "type":"string", + "max":140, + "min":1, + "pattern":"(arn:aws:lambda:)?([a-z]{2}-[a-z]+-\\d{1}:)?(\\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\\$LATEST|[a-zA-Z0-9-_]+))?" + }, + "GetAliasRequest":{ + "type":"structure", + "required":[ + "FunctionName", + "Name" + ], + "members":{ + "FunctionName":{ + "shape":"FunctionName", + "location":"uri", + "locationName":"FunctionName" + }, + "Name":{ + "shape":"Alias", + "location":"uri", + "locationName":"Name" + } + } + }, + "GetEventSourceMappingRequest":{ + "type":"structure", + "required":["UUID"], + "members":{ + "UUID":{ + "shape":"String", + "location":"uri", + "locationName":"UUID" + } + } + }, + "GetFunctionConfigurationRequest":{ + "type":"structure", + "required":["FunctionName"], + "members":{ + "FunctionName":{ + "shape":"FunctionName", + "location":"uri", + "locationName":"FunctionName" + }, + "Qualifier":{ + "shape":"Qualifier", + "location":"querystring", + "locationName":"Qualifier" + } + } + }, + "GetFunctionRequest":{ + "type":"structure", + "required":["FunctionName"], + "members":{ + "FunctionName":{ + "shape":"FunctionName", + "location":"uri", + "locationName":"FunctionName" + }, + "Qualifier":{ + "shape":"Qualifier", + "location":"querystring", + "locationName":"Qualifier" + } + } + }, + "GetFunctionResponse":{ + "type":"structure", + "members":{ + "Configuration":{"shape":"FunctionConfiguration"}, + "Code":{"shape":"FunctionCodeLocation"} + } + }, + "GetPolicyRequest":{ + "type":"structure", + "required":["FunctionName"], + "members":{ + "FunctionName":{ + "shape":"FunctionName", + "location":"uri", + "locationName":"FunctionName" + }, + "Qualifier":{ + "shape":"Qualifier", + "location":"querystring", + "locationName":"Qualifier" + } + } + }, + "GetPolicyResponse":{ + "type":"structure", + "members":{ + "Policy":{"shape":"String"} + } + }, + "Handler":{ + "type":"string", + "max":128, + "pattern":"[^\\s]+" + }, + "HttpStatus":{"type":"integer"}, + "Integer":{"type":"integer"}, + "InvalidParameterValueException":{ + "type":"structure", + "members":{ + "Type":{"shape":"String"}, + "message":{"shape":"String"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidRequestContentException":{ + "type":"structure", + "members":{ + "Type":{"shape":"String"}, + "message":{"shape":"String"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidSecurityGroupIDException":{ + "type":"structure", + "members":{ + "Type":{"shape":"String"}, + "Message":{"shape":"String"} + }, + "error":{"httpStatusCode":502}, + "exception":true + }, + "InvalidSubnetIDException":{ + "type":"structure", + "members":{ + "Type":{"shape":"String"}, + "Message":{"shape":"String"} + }, + "error":{"httpStatusCode":502}, + "exception":true + }, + "InvocationRequest":{ + "type":"structure", + "required":["FunctionName"], + "members":{ + "FunctionName":{ + "shape":"FunctionName", + "location":"uri", + "locationName":"FunctionName" + }, + "InvocationType":{ + "shape":"InvocationType", + "location":"header", + "locationName":"X-Amz-Invocation-Type" + }, + "LogType":{ + "shape":"LogType", + "location":"header", + "locationName":"X-Amz-Log-Type" + }, + "ClientContext":{ + "shape":"String", + "location":"header", + "locationName":"X-Amz-Client-Context" + }, + "Payload":{"shape":"Blob"}, + "Qualifier":{ + "shape":"Qualifier", + "location":"querystring", + "locationName":"Qualifier" + } + }, + "payload":"Payload" + }, + "InvocationResponse":{ + "type":"structure", + "members":{ + "StatusCode":{ + "shape":"Integer", + "location":"statusCode" + }, + "FunctionError":{ + "shape":"String", + "location":"header", + "locationName":"X-Amz-Function-Error" + }, + "LogResult":{ + "shape":"String", + "location":"header", + "locationName":"X-Amz-Log-Result" + }, + "Payload":{"shape":"Blob"} + }, + "payload":"Payload" + }, + "InvocationType":{ + "type":"string", + "enum":[ + "Event", + "RequestResponse", + "DryRun" + ] + }, + "InvokeAsyncRequest":{ + "type":"structure", + "required":[ + "FunctionName", + "InvokeArgs" + ], + "members":{ + "FunctionName":{ + "shape":"FunctionName", + "location":"uri", + "locationName":"FunctionName" + }, + "InvokeArgs":{"shape":"BlobStream"} + }, + "deprecated":true, + "payload":"InvokeArgs" + }, + "InvokeAsyncResponse":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"HttpStatus", + "location":"statusCode" + } + }, + "deprecated":true + }, + "ListAliasesRequest":{ + "type":"structure", + "required":["FunctionName"], + "members":{ + "FunctionName":{ + "shape":"FunctionName", + "location":"uri", + "locationName":"FunctionName" + }, + "FunctionVersion":{ + "shape":"Version", + "location":"querystring", + "locationName":"FunctionVersion" + }, + "Marker":{ + "shape":"String", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"MaxListItems", + "location":"querystring", + "locationName":"MaxItems" + } + } + }, + "ListAliasesResponse":{ + "type":"structure", + "members":{ + "NextMarker":{"shape":"String"}, + "Aliases":{"shape":"AliasList"} + } + }, + "ListEventSourceMappingsRequest":{ + "type":"structure", + "members":{ + "EventSourceArn":{ + "shape":"Arn", + "location":"querystring", + "locationName":"EventSourceArn" + }, + "FunctionName":{ + "shape":"FunctionName", + "location":"querystring", + "locationName":"FunctionName" + }, + "Marker":{ + "shape":"String", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"MaxListItems", + "location":"querystring", + "locationName":"MaxItems" + } + } + }, + "ListEventSourceMappingsResponse":{ + "type":"structure", + "members":{ + "NextMarker":{"shape":"String"}, + "EventSourceMappings":{"shape":"EventSourceMappingsList"} + } + }, + "ListFunctionsRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"MaxListItems", + "location":"querystring", + "locationName":"MaxItems" + } + } + }, + "ListFunctionsResponse":{ + "type":"structure", + "members":{ + "NextMarker":{"shape":"String"}, + "Functions":{"shape":"FunctionList"} + } + }, + "ListVersionsByFunctionRequest":{ + "type":"structure", + "required":["FunctionName"], + "members":{ + "FunctionName":{ + "shape":"FunctionName", + "location":"uri", + "locationName":"FunctionName" + }, + "Marker":{ + "shape":"String", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"MaxListItems", + "location":"querystring", + "locationName":"MaxItems" + } + } + }, + "ListVersionsByFunctionResponse":{ + "type":"structure", + "members":{ + "NextMarker":{"shape":"String"}, + "Versions":{"shape":"FunctionList"} + } + }, + "LogType":{ + "type":"string", + "enum":[ + "None", + "Tail" + ] + }, + "Long":{"type":"long"}, + "MaxListItems":{ + "type":"integer", + "max":10000, + "min":1 + }, + "MemorySize":{ + "type":"integer", + "max":1536, + "min":128 + }, + "PolicyLengthExceededException":{ + "type":"structure", + "members":{ + "Type":{"shape":"String"}, + "message":{"shape":"String"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "Principal":{ + "type":"string", + "pattern":".*" + }, + "PublishVersionRequest":{ + "type":"structure", + "required":["FunctionName"], + "members":{ + "FunctionName":{ + "shape":"FunctionName", + "location":"uri", + "locationName":"FunctionName" + }, + "CodeSha256":{"shape":"String"}, + "Description":{"shape":"Description"} + } + }, + "Qualifier":{ + "type":"string", + "max":128, + "min":1, + "pattern":"(|[a-zA-Z0-9$_-]+)" + }, + "RemovePermissionRequest":{ + "type":"structure", + "required":[ + "FunctionName", + "StatementId" + ], + "members":{ + "FunctionName":{ + "shape":"FunctionName", + "location":"uri", + "locationName":"FunctionName" + }, + "StatementId":{ + "shape":"StatementId", + "location":"uri", + "locationName":"StatementId" + }, + "Qualifier":{ + "shape":"Qualifier", + "location":"querystring", + "locationName":"Qualifier" + } + } + }, + "RequestTooLargeException":{ + "type":"structure", + "members":{ + "Type":{"shape":"String"}, + "message":{"shape":"String"} + }, + "error":{"httpStatusCode":413}, + "exception":true + }, + "ResourceConflictException":{ + "type":"structure", + "members":{ + "Type":{"shape":"String"}, + "message":{"shape":"String"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "Type":{"shape":"String"}, + "Message":{"shape":"String"} + }, + "error":{"httpStatusCode":404}, + "exception":true + }, + "RoleArn":{ + "type":"string", + "pattern":"arn:aws:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+" + }, + "Runtime":{ + "type":"string", + "enum":[ + "nodejs", + "nodejs4.3", + "java8", + "python2.7" + ] + }, + "S3Bucket":{ + "type":"string", + "max":63, + "min":3, + "pattern":"^[0-9A-Za-z\\.\\-_]*(?AWS LambdaOverview
This is the AWS Lambda API Reference. The AWS Lambda Developer Guide provides additional information. For the service overview, go to What is AWS Lambda, and for information about how the service works, go to AWS Lambda: How it Works in the AWS Lambda Developer Guide.
", + "operations": { + "AddPermission": "Adds a permission to the resource policy associated with the specified AWS Lambda function. You use resource policies to grant permissions to event sources that use push model. In a push model, event sources (such as Amazon S3 and custom applications) invoke your Lambda function. Each permission you add to the resource policy allows an event source, permission to invoke the Lambda function.
For information about the push model, see AWS Lambda: How it Works.
If you are using versioning, the permissions you add are specific to the Lambda function version or alias you specify in the AddPermission request via the Qualifier parameter. For more information about versioning, see AWS Lambda Function Versioning and Aliases.
This operation requires permission for the lambda:AddPermission action.
Creates an alias that points to the specified Lambda function version. For more information, see Introduction to AWS Lambda Aliases.
Alias names are unique for a given function.This requires permission for the lambda:CreateAlias action.
", + "CreateEventSourceMapping": "Identifies a stream as an event source for a Lambda function. It can be either an Amazon Kinesis stream or an Amazon DynamoDB stream. AWS Lambda invokes the specified function when records are posted to the stream.
This association between a stream source and a Lambda function is called the event source mapping.
You provide mapping information (for example, which stream to read from and which Lambda function to invoke) in the request body.
Each event source, such as an Amazon Kinesis or a DynamoDB stream, can be associated with multiple AWS Lambda function. A given Lambda function can be associated with multiple AWS event sources.
If you are using versioning, you can specify a specific function version or an alias via the function name parameter. For more information about versioning, see AWS Lambda Function Versioning and Aliases.
This operation requires permission for the lambda:CreateEventSourceMapping action.
Creates a new Lambda function. The function metadata is created from the request parameters, and the code for the function is provided by a .zip file in the request body. If the function name already exists, the operation will fail. Note that the function name is case-sensitive.
If you are using versioning, you can also publish a version of the Lambda function you are creating using the Publish parameter. For more information about versioning, see AWS Lambda Function Versioning and Aliases.
This operation requires permission for the lambda:CreateFunction action.
Deletes the specified Lambda function alias. For more information, see Introduction to AWS Lambda Aliases.
This requires permission for the lambda:DeleteAlias action.
", + "DeleteEventSourceMapping": "Removes an event source mapping. This means AWS Lambda will no longer invoke the function for events in the associated source.
This operation requires permission for the lambda:DeleteEventSourceMapping action.
Deletes the specified Lambda function code and configuration.
If you are using the versioning feature and you don't specify a function version in your DeleteFunction request, AWS Lambda will delete the function, including all its versions, and any aliases pointing to the function versions. To delete a specific function version, you must provide the function version via the Qualifier parameter. For information about function versioning, see AWS Lambda Function Versioning and Aliases.
When you delete a function the associated resource policy is also deleted. You will need to delete the event source mappings explicitly.
This operation requires permission for the lambda:DeleteFunction action.
Returns the specified alias information such as the alias ARN, description, and function version it is pointing to. For more information, see Introduction to AWS Lambda Aliases.
This requires permission for the lambda:GetAlias action.
Returns configuration information for the specified event source mapping (see CreateEventSourceMapping).
This operation requires permission for the lambda:GetEventSourceMapping action.
Returns the configuration information of the Lambda function and a presigned URL link to the .zip file you uploaded with CreateFunction so you can download the .zip file. Note that the URL is valid for up to 10 minutes. The configuration information is the same information you provided as parameters when uploading the function.
Using the optional Qualifier parameter, you can specify a specific function version for which you want this information. If you don't specify this parameter, the API uses unqualified function ARN which return information about the $LATEST version of the Lambda function. For more information, see AWS Lambda Function Versioning and Aliases.
This operation requires permission for the lambda:GetFunction action.
Returns the configuration information of the Lambda function. This the same information you provided as parameters when uploading the function by using CreateFunction.
If you are using the versioning feature, you can retrieve this information for a specific function version by using the optional Qualifier parameter and specifying the function version or alias that points to it. If you don't provide it, the API returns information about the $LATEST version of the function. For more information about versioning, see AWS Lambda Function Versioning and Aliases.
This operation requires permission for the lambda:GetFunctionConfiguration operation.
Returns the resource policy associated with the specified Lambda function.
If you are using the versioning feature, you can get the resource policy associated with the specific Lambda function version or alias by specifying the version or alias name using the Qualifier parameter. For more information about versioning, see AWS Lambda Function Versioning and Aliases.
For information about adding permissions, see AddPermission.
You need permission for the lambda:GetPolicy action.
Invokes a specific Lambda function.
If you are using the versioning feature, you can invoke the specific function version by providing function version or alias name that is pointing to the function version using the Qualifier parameter in the request. If you don't provide the Qualifier parameter, the $LATEST version of the Lambda function is invoked. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases.
This operation requires permission for the lambda:InvokeFunction action.
Invoke API (see Invoke).Submits an invocation request to AWS Lambda. Upon receiving the request, Lambda executes the specified function asynchronously. To see the logs generated by the Lambda function execution, see the CloudWatch Logs console.
This operation requires permission for the lambda:InvokeFunction action.
Returns list of aliases created for a Lambda function. For each alias, the response includes information such as the alias ARN, description, alias name, and the function version to which it points. For more information, see Introduction to AWS Lambda Aliases.
This requires permission for the lambda:ListAliases action.
", + "ListEventSourceMappings": "Returns a list of event source mappings you created using the CreateEventSourceMapping (see CreateEventSourceMapping).
For each mapping, the API returns configuration information. You can optionally specify filters to retrieve specific event source mappings.
If you are using the versioning feature, you can get list of event source mappings for a specific Lambda function version or an alias as described in the FunctionName parameter. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases.
This operation requires permission for the lambda:ListEventSourceMappings action.
Returns a list of your Lambda functions. For each function, the response includes the function configuration information. You must use GetFunction to retrieve the code for your function.
This operation requires permission for the lambda:ListFunctions action.
If you are using versioning feature, the response returns list of $LATEST versions of your functions. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases.
", + "ListVersionsByFunction": "List all versions of a function. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases.
", + "PublishVersion": "Publishes a version of your function from the current snapshot of $LATEST. That is, AWS Lambda takes a snapshot of the function code and configuration information from $LATEST and publishes a new version. The code and configuration cannot be modified after publication. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases.
", + "RemovePermission": "You can remove individual permissions from an resource policy associated with a Lambda function by providing a statement ID that you provided when you added the permission.
If you are using versioning, the permissions you remove are specific to the Lambda function version or alias you specify in the AddPermission request via the Qualifier parameter. For more information about versioning, see AWS Lambda Function Versioning and Aliases.
Note that removal of a permission will cause an active event source to lose permission to the function.
You need permission for the lambda:RemovePermission action.
Using this API you can update the function version to which the alias points and the alias description. For more information, see Introduction to AWS Lambda Aliases.
This requires permission for the lambda:UpdateAlias action.
", + "UpdateEventSourceMapping": "You can update an event source mapping. This is useful if you want to change the parameters of the existing mapping without losing your position in the stream. You can change which function will receive the stream records, but to change the stream itself, you must create a new mapping.
If you are using the versioning feature, you can update the event source mapping to map to a specific Lambda function version or alias as described in the FunctionName parameter. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases.
If you disable the event source mapping, AWS Lambda stops polling. If you enable again, it will resume polling from the time it had stopped polling, so you don't lose processing of any records. However, if you delete event source mapping and create it again, it will reset.
This operation requires permission for the lambda:UpdateEventSourceMapping action.
Updates the code for the specified Lambda function. This operation must only be used on an existing Lambda function and cannot be used to update the function configuration.
If you are using the versioning feature, note this API will always update the $LATEST version of your Lambda function. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases.
This operation requires permission for the lambda:UpdateFunctionCode action.
Updates the configuration parameters for the specified Lambda function by using the values provided in the request. You provide only the parameters you want to change. This operation must only be used on an existing Lambda function and cannot be used to update the function's code.
If you are using the versioning feature, note this API will always update the $LATEST version of your Lambda function. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases.
This operation requires permission for the lambda:UpdateFunctionConfiguration action.
The AWS Lambda action you want to allow in this statement. Each Lambda action is a string starting with lambda: followed by the API name (see Operations). For example, lambda:CreateFunction. You can use wildcard (lambda:*) to grant permission for all AWS Lambda actions.
Alias name.
", + "CreateAliasRequest$Name": "Name for the alias you are creating.
", + "DeleteAliasRequest$Name": "Name of the alias to delete.
", + "GetAliasRequest$Name": "Name of the alias for which you want to retrieve information.
", + "UpdateAliasRequest$Name": "The alias name.
" + } + }, + "AliasConfiguration": { + "base": "Provides configuration information about a Lambda function version alias.
", + "refs": { + "AliasList$member": null + } + }, + "AliasList": { + "base": null, + "refs": { + "ListAliasesResponse$Aliases": "A list of aliases.
" + } + }, + "Arn": { + "base": null, + "refs": { + "AddPermissionRequest$SourceArn": "This is optional; however, when granting Amazon S3 permission to invoke your function, you should specify this field with the bucket Amazon Resource Name (ARN) as its value. This ensures that only events generated from the specified bucket can invoke the function.
The Amazon Resource Name (ARN) of the Amazon Kinesis or the Amazon DynamoDB stream that is the event source. Any record added to this stream could cause AWS Lambda to invoke your Lambda function, it depends on the BatchSize. AWS Lambda POSTs the Amazon Kinesis event, containing records, to your Lambda function as JSON.
The Amazon Resource Name (ARN) of the Amazon Kinesis stream that is the source of events.
", + "ListEventSourceMappingsRequest$EventSourceArn": "The Amazon Resource Name (ARN) of the Amazon Kinesis stream.
" + } + }, + "BatchSize": { + "base": null, + "refs": { + "CreateEventSourceMappingRequest$BatchSize": "The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function. Your function receives an event with all the retrieved records. The default is 100 records.
", + "EventSourceMappingConfiguration$BatchSize": "The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function. Your function receives an event with all the retrieved records.
", + "UpdateEventSourceMappingRequest$BatchSize": "The maximum number of stream records that can be sent to your Lambda function for a single invocation.
" + } + }, + "Blob": { + "base": null, + "refs": { + "FunctionCode$ZipFile": "A zip file containing your deployment package. If you are using the API directly, the zip file must be base64-encoded (if you are using the AWS SDKs or the AWS CLI, the SDKs or CLI will do the encoding for you). For more information about creating a .zip file, go to Execution Permissions in the AWS Lambda Developer Guide.
", + "InvocationRequest$Payload": "JSON that you want to provide to your Lambda function as input.
", + "InvocationResponse$Payload": " It is the JSON representation of the object returned by the Lambda function. In This is present only if the invocation type is RequestResponse.
In the event of a function error this field contains a message describing the error. For the Handled errors the Lambda function will report this message. For Unhandled errors AWS Lambda reports the message.
Based64-encoded .zip file containing your packaged source code.
" + } + }, + "BlobStream": { + "base": null, + "refs": { + "InvokeAsyncRequest$InvokeArgs": "JSON that you want to provide to your Lambda function as input.
" + } + }, + "Boolean": { + "base": null, + "refs": { + "CreateFunctionRequest$Publish": "This boolean parameter can be used to request AWS Lambda to create the Lambda function and publish a version as an atomic operation.
", + "UpdateFunctionCodeRequest$Publish": "This boolean parameter can be used to request AWS Lambda to update the Lambda function and publish a version as an atomic operation.
" + } + }, + "CodeStorageExceededException": { + "base": "You have exceeded your maximum total code size per account. Limits
", + "refs": { + } + }, + "CreateAliasRequest": { + "base": null, + "refs": { + } + }, + "CreateEventSourceMappingRequest": { + "base": null, + "refs": { + } + }, + "CreateFunctionRequest": { + "base": null, + "refs": { + } + }, + "Date": { + "base": null, + "refs": { + "EventSourceMappingConfiguration$LastModified": "The UTC time string indicating the last time the event mapping was updated.
" + } + }, + "DeleteAliasRequest": { + "base": null, + "refs": { + } + }, + "DeleteEventSourceMappingRequest": { + "base": null, + "refs": { + } + }, + "DeleteFunctionRequest": { + "base": null, + "refs": { + } + }, + "Description": { + "base": null, + "refs": { + "AliasConfiguration$Description": "Alias description.
", + "CreateAliasRequest$Description": "Description of the alias.
", + "CreateFunctionRequest$Description": "A short, user-defined function description. Lambda does not use this value. Assign a meaningful description as you see fit.
", + "FunctionConfiguration$Description": "The user-provided description.
", + "PublishVersionRequest$Description": "The description for the version you are publishing. If not provided, AWS Lambda copies the description from the $LATEST version.
", + "UpdateAliasRequest$Description": "You can change the description of the alias using this parameter.
", + "UpdateFunctionConfigurationRequest$Description": "A short user-defined function description. AWS Lambda does not use this value. Assign a meaningful description as you see fit.
" + } + }, + "EC2AccessDeniedException": { + "base": null, + "refs": { + } + }, + "EC2ThrottledException": { + "base": "AWS Lambda was throttled by Amazon EC2 during Lambda function initiatization using the execution role provided for the Lambda function.
", + "refs": { + } + }, + "EC2UnexpectedException": { + "base": "AWS Lambda received an unexpected EC2 client exception while setting up for the Lambda function.
", + "refs": { + } + }, + "ENILimitReachedException": { + "base": "AWS Lambda was not able to create an Elastic Network Interface (ENI) in the VPC, specified as part of Lambda function configuration, because the limit for network interfaces has been reached.
", + "refs": { + } + }, + "Enabled": { + "base": null, + "refs": { + "CreateEventSourceMappingRequest$Enabled": "Indicates whether AWS Lambda should begin polling the event source. By default, Enabled is true.
Specifies whether AWS Lambda should actively poll the stream or not. If disabled, AWS Lambda will not poll the stream.
" + } + }, + "EventSourceMappingConfiguration": { + "base": "Describes mapping between an Amazon Kinesis stream and a Lambda function.
", + "refs": { + "EventSourceMappingsList$member": null + } + }, + "EventSourceMappingsList": { + "base": null, + "refs": { + "ListEventSourceMappingsResponse$EventSourceMappings": "An array of EventSourceMappingConfiguration objects.
The position in the stream where AWS Lambda should start reading. For more information, go to ShardIteratorType in the Amazon Kinesis API Reference.
" + } + }, + "EventSourceToken": { + "base": null, + "refs": { + "AddPermissionRequest$EventSourceToken": null + } + }, + "FunctionArn": { + "base": null, + "refs": { + "AliasConfiguration$AliasArn": "Lambda function ARN that is qualified using the alias name as the suffix. For example, if you create an alias called BETA that points to a helloworld function version, the ARN is arn:aws:lambda:aws-regions:acct-id:function:helloworld:BETA.
The Lambda function to invoke when AWS Lambda detects an event on the stream.
", + "FunctionConfiguration$FunctionArn": "The Amazon Resource Name (ARN) assigned to the function.
" + } + }, + "FunctionCode": { + "base": "The code for the Lambda function.
", + "refs": { + "CreateFunctionRequest$Code": "The code for the Lambda function.
" + } + }, + "FunctionCodeLocation": { + "base": "The object for the Lambda function location.
", + "refs": { + "GetFunctionResponse$Code": null + } + }, + "FunctionConfiguration": { + "base": "A complex type that describes function metadata.
", + "refs": { + "FunctionList$member": null, + "GetFunctionResponse$Configuration": null + } + }, + "FunctionList": { + "base": null, + "refs": { + "ListFunctionsResponse$Functions": "A list of Lambda functions.
", + "ListVersionsByFunctionResponse$Versions": "A list of Lambda function versions.
" + } + }, + "FunctionName": { + "base": null, + "refs": { + "AddPermissionRequest$FunctionName": "Name of the Lambda function whose resource policy you are updating by adding a new permission.
You can specify a function name (for example, Thumbnail) or you can specify Amazon Resource Name (ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail). AWS Lambda also allows you to specify partial ARN (for example, account-id:Thumbnail). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.
Name of the Lambda function for which you want to create an alias.
", + "CreateEventSourceMappingRequest$FunctionName": "The Lambda function to invoke when AWS Lambda detects an event on the stream.
You can specify the function name (for example, Thumbnail) or you can specify Amazon Resource Name (ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail).
If you are using versioning, you can also provide a qualified function ARN (ARN that is qualified with function version or alias name as suffix). For more information about versioning, see AWS Lambda Function Versioning and Aliases
AWS Lambda also allows you to specify only the function name with the account ID qualifier (for example, account-id:Thumbnail).
Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.
", + "CreateFunctionRequest$FunctionName": "The name you want to assign to the function you are uploading. The function names appear in the console and are returned in the ListFunctions API. Function names are used to specify functions to other AWS Lambda APIs, such as Invoke.
", + "DeleteAliasRequest$FunctionName": "The Lambda function name for which the alias is created. Deleting an alias does not delete the function version to which it is pointing.
", + "DeleteFunctionRequest$FunctionName": "The Lambda function to delete.
You can specify the function name (for example, Thumbnail) or you can specify Amazon Resource Name (ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail). If you are using versioning, you can also provide a qualified function ARN (ARN that is qualified with function version or alias name as suffix). AWS Lambda also allows you to specify only the function name with the account ID qualifier (for example, account-id:Thumbnail). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.
The name of the function.
", + "GetAliasRequest$FunctionName": "Function name for which the alias is created. An alias is a subresource that exists only in the context of an existing Lambda function so you must specify the function name.
", + "GetFunctionConfigurationRequest$FunctionName": "The name of the Lambda function for which you want to retrieve the configuration information.
You can specify a function name (for example, Thumbnail) or you can specify Amazon Resource Name (ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail). AWS Lambda also allows you to specify a partial ARN (for example, account-id:Thumbnail). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.
The Lambda function name.
You can specify a function name (for example, Thumbnail) or you can specify Amazon Resource Name (ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail). AWS Lambda also allows you to specify a partial ARN (for example, account-id:Thumbnail). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.
Function name whose resource policy you want to retrieve.
You can specify the function name (for example, Thumbnail) or you can specify Amazon Resource Name (ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail). If you are using versioning, you can also provide a qualified function ARN (ARN that is qualified with function version or alias name as suffix). AWS Lambda also allows you to specify only the function name with the account ID qualifier (for example, account-id:Thumbnail). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.
The Lambda function name.
You can specify a function name (for example, Thumbnail) or you can specify Amazon Resource Name (ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail). AWS Lambda also allows you to specify a partial ARN (for example, account-id:Thumbnail). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.
The Lambda function name.
", + "ListAliasesRequest$FunctionName": "Lambda function name for which the alias is created.
", + "ListEventSourceMappingsRequest$FunctionName": "The name of the Lambda function.
You can specify the function name (for example, Thumbnail) or you can specify Amazon Resource Name (ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail). If you are using versioning, you can also provide a qualified function ARN (ARN that is qualified with function version or alias name as suffix). AWS Lambda also allows you to specify only the function name with the account ID qualifier (for example, account-id:Thumbnail). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.
Function name whose versions to list. You can specify a function name (for example, Thumbnail) or you can specify Amazon Resource Name (ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail). AWS Lambda also allows you to specify a partial ARN (for example, account-id:Thumbnail). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.
The Lambda function name. You can specify a function name (for example, Thumbnail) or you can specify Amazon Resource Name (ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail). AWS Lambda also allows you to specify a partial ARN (for example, account-id:Thumbnail). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.
Lambda function whose resource policy you want to remove a permission from.
You can specify a function name (for example, Thumbnail) or you can specify Amazon Resource Name (ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail). AWS Lambda also allows you to specify a partial ARN (for example, account-id:Thumbnail). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.
The function name for which the alias is created.
", + "UpdateEventSourceMappingRequest$FunctionName": "The Lambda function to which you want the stream records sent.
You can specify a function name (for example, Thumbnail) or you can specify Amazon Resource Name (ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail). AWS Lambda also allows you to specify a partial ARN (for example, account-id:Thumbnail).
If you are using versioning, you can also provide a qualified function ARN (ARN that is qualified with function version or alias name as suffix). For more information about versioning, see AWS Lambda Function Versioning and Aliases
Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.
", + "UpdateFunctionCodeRequest$FunctionName": "The existing Lambda function name whose code you want to replace.
You can specify a function name (for example, Thumbnail) or you can specify Amazon Resource Name (ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail). AWS Lambda also allows you to specify a partial ARN (for example, account-id:Thumbnail). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.
The name of the Lambda function.
You can specify a function name (for example, Thumbnail) or you can specify Amazon Resource Name (ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail). AWS Lambda also allows you to specify a partial ARN (for example, account-id:Thumbnail). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.
This response contains the object for the Lambda function location (see API_FunctionCodeLocation.
", + "refs": { + } + }, + "GetPolicyRequest": { + "base": null, + "refs": { + } + }, + "GetPolicyResponse": { + "base": null, + "refs": { + } + }, + "Handler": { + "base": null, + "refs": { + "CreateFunctionRequest$Handler": "The function within your code that Lambda calls to begin execution. For Node.js, it is the module-name.export value in your function. For Java, it can be package.class-name::handler or package.class-name. For more information, see Lambda Function Handler (Java).
The function Lambda calls to begin executing your function.
", + "UpdateFunctionConfigurationRequest$Handler": "The function that Lambda calls to begin executing your function. For Node.js, it is the module-name.export value in your function.
It will be 202 upon success.
" + } + }, + "Integer": { + "base": null, + "refs": { + "InvocationResponse$StatusCode": "The HTTP status code will be in the 200 range for successful request. For the RequestResonse invocation type this status code will be 200. For the Event invocation type this status code will be 202. For the DryRun invocation type the status code will be 204.
One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the CreateFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception.
The request body could not be parsed as JSON.
", + "refs": { + } + }, + "InvalidSecurityGroupIDException": { + "base": "The Security Group ID provided in the Lambda function VPC configuration is invalid.
", + "refs": { + } + }, + "InvalidSubnetIDException": { + "base": "The Subnet ID provided in the Lambda function VPC configuration is invalid.
", + "refs": { + } + }, + "InvocationRequest": { + "base": null, + "refs": { + } + }, + "InvocationResponse": { + "base": "Upon success, returns an empty response. Otherwise, throws an exception.
", + "refs": { + } + }, + "InvocationType": { + "base": null, + "refs": { + "InvocationRequest$InvocationType": "By default, the Invoke API assumes RequestResponse invocation type. You can optionally request asynchronous execution by specifying Event as the InvocationType. You can also use this parameter to request AWS Lambda to not execute the function but do some verification, such as if the caller is authorized to invoke the function and if the inputs are valid. You request this by specifying DryRun as the InvocationType. This is useful in a cross-account scenario when you want to verify access to a function without running it.
Upon success, it returns empty response. Otherwise, throws an exception.
", + "refs": { + } + }, + "ListAliasesRequest": { + "base": null, + "refs": { + } + }, + "ListAliasesResponse": { + "base": null, + "refs": { + } + }, + "ListEventSourceMappingsRequest": { + "base": null, + "refs": { + } + }, + "ListEventSourceMappingsResponse": { + "base": "Contains a list of event sources (see API_EventSourceMappingConfiguration)
", + "refs": { + } + }, + "ListFunctionsRequest": { + "base": null, + "refs": { + } + }, + "ListFunctionsResponse": { + "base": "Contains a list of AWS Lambda function configurations (see FunctionConfiguration.
", + "refs": { + } + }, + "ListVersionsByFunctionRequest": { + "base": null, + "refs": { + } + }, + "ListVersionsByFunctionResponse": { + "base": null, + "refs": { + } + }, + "LogType": { + "base": null, + "refs": { + "InvocationRequest$LogType": "You can set this optional parameter to Tail in the request only if you specify the InvocationType parameter with value RequestResponse. In this case, AWS Lambda returns the base64-encoded last 4 KB of log data produced by your Lambda function in the x-amz-log-results header.
The size, in bytes, of the function .zip file you uploaded.
" + } + }, + "MaxListItems": { + "base": null, + "refs": { + "ListAliasesRequest$MaxItems": "Optional integer. Specifies the maximum number of aliases to return in response. This parameter value must be greater than 0.
", + "ListEventSourceMappingsRequest$MaxItems": "Optional integer. Specifies the maximum number of event sources to return in response. This value must be greater than 0.
", + "ListFunctionsRequest$MaxItems": "Optional integer. Specifies the maximum number of AWS Lambda functions to return in response. This parameter value must be greater than 0.
", + "ListVersionsByFunctionRequest$MaxItems": "Optional integer. Specifies the maximum number of AWS Lambda function versions to return in response. This parameter value must be greater than 0.
" + } + }, + "MemorySize": { + "base": null, + "refs": { + "CreateFunctionRequest$MemorySize": "The amount of memory, in MB, your Lambda function is given. Lambda uses this memory size to infer the amount of CPU and memory allocated to your function. Your function use-case determines your CPU and memory requirements. For example, a database operation might need less memory compared to an image processing function. The default value is 128 MB. The value must be a multiple of 64 MB.
", + "FunctionConfiguration$MemorySize": "The memory size, in MB, you configured for the function. Must be a multiple of 64 MB.
", + "UpdateFunctionConfigurationRequest$MemorySize": "The amount of memory, in MB, your Lambda function is given. AWS Lambda uses this memory size to infer the amount of CPU allocated to your function. Your function use-case determines your CPU and memory requirements. For example, a database operation might need less memory compared to an image processing function. The default value is 128 MB. The value must be a multiple of 64 MB.
" + } + }, + "PolicyLengthExceededException": { + "base": "Lambda function access policy is limited to 20 KB.
", + "refs": { + } + }, + "Principal": { + "base": null, + "refs": { + "AddPermissionRequest$Principal": "The principal who is getting this permission. It can be Amazon S3 service Principal (s3.amazonaws.com) if you want Amazon S3 to invoke the function, an AWS account ID if you are granting cross-account permission, or any valid AWS service principal such as sns.amazonaws.com. For example, you might want to allow a custom application in another AWS account to push events to AWS Lambda by invoking your function.
You can use this optional query parameter to describe a qualified ARN using a function version or an alias name. The permission will then apply to the specific qualified ARN. For example, if you specify function version 2 as the qualifier, then permission applies only when request is made using qualified function ARN:
arn:aws:lambda:aws-region:acct-id:function:function-name:2
If you specify an alias name, for example PROD, then the permission is valid only for requests made using the alias ARN:
arn:aws:lambda:aws-region:acct-id:function:function-name:PROD
If the qualifier is not specified, the permission is valid only when requests is made using unqualified function ARN.
arn:aws:lambda:aws-region:acct-id:function:function-name
Using this optional parameter you can specify a function version (but not the $LATEST version) to direct AWS Lambda to delete a specific function version. If the function version has one or more aliases pointing to it, you will get an error because you cannot have aliases pointing to it. You can delete any function version but not the $LATEST, that is, you cannot specify $LATEST as the value of this parameter. The $LATEST version can be deleted only when you want to delete all the function versions and aliases.
You can only specify a function version, not an alias name, using this parameter. You cannot delete a function version using its alias.
If you don't specify this parameter, AWS Lambda will delete the function, including all of its versions and aliases.
", + "GetFunctionConfigurationRequest$Qualifier": "Using this optional parameter you can specify a function version or an alias name. If you specify function version, the API uses qualified function ARN and returns information about the specific function version. If you specify an alias name, the API uses the alias ARN and returns information about the function version to which the alias points.
If you don't specify this parameter, the API uses unqualified function ARN, and returns information about the $LATEST function version.
Using this optional parameter to specify a function version or an alias name. If you specify function version, the API uses qualified function ARN for the request and returns information about the specific Lambda function version. If you specify an alias name, the API uses the alias ARN and returns information about the function version to which the alias points. If you don't provide this parameter, the API uses unqualified function ARN and returns information about the $LATEST version of the Lambda function.
You can specify this optional query parameter to specify a function version or an alias name in which case this API will return all permissions associated with the specific qualified ARN. If you don't provide this parameter, the API will return permissions that apply to the unqualified function ARN.
", + "InvocationRequest$Qualifier": "You can use this optional parameter to specify a Lambda function version or alias name. If you specify a function version, the API uses the qualified function ARN to invoke a specific Lambda function. If you specify an alias name, the API uses the alias ARN to invoke the Lambda function version to which the alias points.
If you don't provide this parameter, then the API uses unqualified function ARN which results in invocation of the $LATEST version.
You can specify this optional parameter to remove permission associated with a specific function version or function alias. If you don't specify this parameter, the API removes permission associated with the unqualified function ARN.
" + } + }, + "RemovePermissionRequest": { + "base": null, + "refs": { + } + }, + "RequestTooLargeException": { + "base": "The request payload exceeded the Invoke request body JSON input limit. For more information, see Limits.
The resource already exists.
", + "refs": { + } + }, + "ResourceNotFoundException": { + "base": "The resource (for example, a Lambda function or access policy statement) specified in the request does not exist.
", + "refs": { + } + }, + "RoleArn": { + "base": null, + "refs": { + "CreateFunctionRequest$Role": "The Amazon Resource Name (ARN) of the IAM role that Lambda assumes when it executes your function to access any other Amazon Web Services (AWS) resources. For more information, see AWS Lambda: How it Works.
", + "FunctionConfiguration$Role": "The Amazon Resource Name (ARN) of the IAM role that Lambda assumes when it executes your function to access any other Amazon Web Services (AWS) resources.
", + "UpdateFunctionConfigurationRequest$Role": "The Amazon Resource Name (ARN) of the IAM role that Lambda will assume when it executes your function.
" + } + }, + "Runtime": { + "base": null, + "refs": { + "CreateFunctionRequest$Runtime": "The runtime environment for the Lambda function you are uploading.
", + "FunctionConfiguration$Runtime": "The runtime environment for the Lambda function.
", + "UpdateFunctionConfigurationRequest$Runtime": null + } + }, + "S3Bucket": { + "base": null, + "refs": { + "FunctionCode$S3Bucket": "Amazon S3 bucket name where the .zip file containing your deployment package is stored. This bucket must reside in the same AWS region where you are creating the Lambda function.
", + "UpdateFunctionCodeRequest$S3Bucket": "Amazon S3 bucket name where the .zip file containing your deployment package is stored. This bucket must reside in the same AWS region where you are creating the Lambda function.
" + } + }, + "S3Key": { + "base": null, + "refs": { + "FunctionCode$S3Key": "The Amazon S3 object (the deployment package) key name you want to upload.
", + "UpdateFunctionCodeRequest$S3Key": "The Amazon S3 object (the deployment package) key name you want to upload.
" + } + }, + "S3ObjectVersion": { + "base": null, + "refs": { + "FunctionCode$S3ObjectVersion": "The Amazon S3 object (the deployment package) version you want to upload.
", + "UpdateFunctionCodeRequest$S3ObjectVersion": "The Amazon S3 object (the deployment package) version you want to upload.
" + } + }, + "SecurityGroupId": { + "base": null, + "refs": { + "SecurityGroupIds$member": null + } + }, + "SecurityGroupIds": { + "base": null, + "refs": { + "VpcConfig$SecurityGroupIds": "A list of one or more security groups IDs in your VPC.
", + "VpcConfigResponse$SecurityGroupIds": "A list of security group IDs associated with the Lambda function.
" + } + }, + "ServiceException": { + "base": "The AWS Lambda service encountered an internal error.
", + "refs": { + } + }, + "SourceOwner": { + "base": null, + "refs": { + "AddPermissionRequest$SourceAccount": "The AWS account ID (without a hyphen) of the source owner. For example, if the SourceArn identifies a bucket, then this is the bucket owner's account ID. You can use this additional condition to ensure the bucket you specify is owned by a specific account (it is possible the bucket owner deleted the bucket and some other AWS account created the bucket). You can also use this condition to specify all sources (that is, you don't specify the SourceArn) owned by a specific account.
A unique statement identifier.
", + "RemovePermissionRequest$StatementId": "Statement ID of the permission to remove.
" + } + }, + "String": { + "base": null, + "refs": { + "AddPermissionResponse$Statement": "The permission statement you specified in the request. The response returns the same as a string using a backslash (\"\\\") as an escape character in the JSON.
", + "CodeStorageExceededException$Type": null, + "CodeStorageExceededException$message": null, + "DeleteEventSourceMappingRequest$UUID": "The event source mapping ID.
", + "EC2AccessDeniedException$Type": null, + "EC2AccessDeniedException$Message": null, + "EC2ThrottledException$Type": null, + "EC2ThrottledException$Message": null, + "EC2UnexpectedException$Type": null, + "EC2UnexpectedException$Message": null, + "EC2UnexpectedException$EC2ErrorCode": null, + "ENILimitReachedException$Type": null, + "ENILimitReachedException$Message": null, + "EventSourceMappingConfiguration$UUID": "The AWS Lambda assigned opaque identifier for the mapping.
", + "EventSourceMappingConfiguration$LastProcessingResult": "The result of the last AWS Lambda invocation of your Lambda function.
", + "EventSourceMappingConfiguration$State": "The state of the event source mapping. It can be Creating, Enabled, Disabled, Enabling, Disabling, Updating, or Deleting.
The reason the event source mapping is in its current state. It is either user-requested or an AWS Lambda-initiated state transition.
", + "FunctionCodeLocation$RepositoryType": "The repository from which you can download the function.
", + "FunctionCodeLocation$Location": "The presigned URL you can use to download the function's .zip file that you previously uploaded. The URL is valid for up to 10 minutes.
", + "FunctionConfiguration$CodeSha256": "It is the SHA256 hash of your function deployment package.
", + "GetEventSourceMappingRequest$UUID": "The AWS Lambda assigned ID of the event source mapping.
", + "GetPolicyResponse$Policy": "The resource policy associated with the specified function. The response returns the same as a string using a backslash (\"\\\") as an escape character in the JSON.
", + "InvalidParameterValueException$Type": null, + "InvalidParameterValueException$message": null, + "InvalidRequestContentException$Type": null, + "InvalidRequestContentException$message": null, + "InvalidSecurityGroupIDException$Type": null, + "InvalidSecurityGroupIDException$Message": null, + "InvalidSubnetIDException$Type": null, + "InvalidSubnetIDException$Message": null, + "InvocationRequest$ClientContext": "Using the ClientContext you can pass client-specific information to the Lambda function you are invoking. You can then process the client information in your Lambda function as you choose through the context variable. For an example of a ClientContext JSON, see PutEvents in the Amazon Mobile Analytics API Reference and User Guide.
The ClientContext JSON must be base64-encoded.
", + "InvocationResponse$FunctionError": "Indicates whether an error occurred while executing the Lambda function. If an error occurred this field will have one of two values; Handled or Unhandled. Handled errors are errors that are reported by the function while the Unhandled errors are those detected and reported by AWS Lambda. Unhandled errors include out of memory errors and function timeouts. For information about how to report an Handled error, see Programming Model.
It is the base64-encoded logs for the Lambda function invocation. This is present only if the invocation type is RequestResponse and the logs were requested.
Optional string. An opaque pagination token returned from a previous ListAliases operation. If present, indicates where to continue the listing.
A string, present if there are more aliases.
", + "ListEventSourceMappingsRequest$Marker": "Optional string. An opaque pagination token returned from a previous ListEventSourceMappings operation. If present, specifies to continue the list from where the returning call left off.
A string, present if there are more event source mappings.
", + "ListFunctionsRequest$Marker": "Optional string. An opaque pagination token returned from a previous ListFunctions operation. If present, indicates where to continue the listing.
A string, present if there are more functions.
", + "ListVersionsByFunctionRequest$Marker": " Optional string. An opaque pagination token returned from a previous ListVersionsByFunction operation. If present, indicates where to continue the listing.
A string, present if there are more function versions.
", + "PolicyLengthExceededException$Type": null, + "PolicyLengthExceededException$message": null, + "PublishVersionRequest$CodeSha256": "The SHA256 hash of the deployment package you want to publish. This provides validation on the code you are publishing. If you provide this parameter value must match the SHA256 of the $LATEST version for the publication to succeed.
", + "RequestTooLargeException$Type": null, + "RequestTooLargeException$message": null, + "ResourceConflictException$Type": null, + "ResourceConflictException$message": null, + "ResourceNotFoundException$Type": null, + "ResourceNotFoundException$Message": null, + "ServiceException$Type": null, + "ServiceException$Message": null, + "SubnetIPAddressLimitReachedException$Type": null, + "SubnetIPAddressLimitReachedException$Message": null, + "TooManyRequestsException$retryAfterSeconds": "The number of seconds the caller should wait before retrying.
", + "TooManyRequestsException$Type": null, + "TooManyRequestsException$message": null, + "UnsupportedMediaTypeException$Type": null, + "UnsupportedMediaTypeException$message": null, + "UpdateEventSourceMappingRequest$UUID": "The event source mapping identifier.
" + } + }, + "SubnetIPAddressLimitReachedException": { + "base": "AWS Lambda was not able to set up VPC access for the Lambda function because one or more configured subnets has no available IP addresses.
", + "refs": { + } + }, + "SubnetId": { + "base": null, + "refs": { + "SubnetIds$member": null + } + }, + "SubnetIds": { + "base": null, + "refs": { + "VpcConfig$SubnetIds": "A list of one or more subnet IDs in your VPC.
", + "VpcConfigResponse$SubnetIds": "A list of subnet IDs associated with the Lambda function.
" + } + }, + "Timeout": { + "base": null, + "refs": { + "CreateFunctionRequest$Timeout": "The function execution time at which Lambda should terminate the function. Because the execution time has cost implications, we recommend you set this value based on your expected execution time. The default is 3 seconds.
", + "FunctionConfiguration$Timeout": "The function execution time at which Lambda should terminate the function. Because the execution time has cost implications, we recommend you set this value based on your expected execution time. The default is 3 seconds.
", + "UpdateFunctionConfigurationRequest$Timeout": "The function execution time at which AWS Lambda should terminate the function. Because the execution time has cost implications, we recommend you set this value based on your expected execution time. The default is 3 seconds.
" + } + }, + "Timestamp": { + "base": null, + "refs": { + "FunctionConfiguration$LastModified": "The time stamp of the last time you updated the function.
" + } + }, + "TooManyRequestsException": { + "base": null, + "refs": { + } + }, + "UnsupportedMediaTypeException": { + "base": "The content type of the Invoke request body is not JSON.
Function version to which the alias points.
", + "CreateAliasRequest$FunctionVersion": "Lambda function version for which you are creating the alias.
", + "FunctionConfiguration$Version": "The version of the Lambda function.
", + "ListAliasesRequest$FunctionVersion": "If you specify this optional parameter, the API returns only the aliases that are pointing to the specific Lambda function version, otherwise the API returns all of the aliases created for the Lambda function.
", + "UpdateAliasRequest$FunctionVersion": "Using this parameter you can change the Lambda function version to which the alias points.
" + } + }, + "VpcConfig": { + "base": "If your Lambda function accesses resources in a VPC, you provide this parameter identifying the list of security group IDs and subnet IDs. These must belong to the same VPC. You must provide at least one security group and one subnet ID.
", + "refs": { + "CreateFunctionRequest$VpcConfig": "If your Lambda function accesses resources in a VPC, you provide this parameter identifying the list of security group IDs and subnet IDs. These must belong to the same VPC. You must provide at least one security group and one subnet ID.
", + "UpdateFunctionConfigurationRequest$VpcConfig": null + } + }, + "VpcConfigResponse": { + "base": "VPC configuration associated with your Lambda function.
", + "refs": { + "FunctionConfiguration$VpcConfig": "VPC configuration associated with your Lambda function.
" + } + }, + "VpcId": { + "base": null, + "refs": { + "VpcConfigResponse$VpcId": "The VPC ID associated with you Lambda function.
" + } + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/lambda/2015-03-31/examples-1.json b/vendor/github.com/aws/aws-sdk-go/models/apis/lambda/2015-03-31/examples-1.json new file mode 100644 index 000000000..0ea7e3b0b --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/lambda/2015-03-31/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/lambda/2015-03-31/paginators-1.json b/vendor/github.com/aws/aws-sdk-go/models/apis/lambda/2015-03-31/paginators-1.json new file mode 100644 index 000000000..da00fb78f --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/lambda/2015-03-31/paginators-1.json @@ -0,0 +1,16 @@ +{ + "pagination": { + "ListEventSourceMappings": { + "input_token": "Marker", + "output_token": "NextMarker", + "limit_key": "MaxItems", + "result_key": "EventSourceMappings" + }, + "ListFunctions": { + "input_token": "Marker", + "output_token": "NextMarker", + "limit_key": "MaxItems", + "result_key": "Functions" + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/logs/2014-03-28/api-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/logs/2014-03-28/api-2.json new file mode 100644 index 000000000..9b08376c1 --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/logs/2014-03-28/api-2.json @@ -0,0 +1,1138 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2014-03-28", + "endpointPrefix":"logs", + "jsonVersion":"1.1", + "protocol":"json", + "serviceFullName":"Amazon CloudWatch Logs", + "signatureVersion":"v4", + "targetPrefix":"Logs_20140328" + }, + "operations":{ + "CancelExportTask":{ + "name":"CancelExportTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelExportTaskRequest"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidOperationException"}, + {"shape":"ServiceUnavailableException"} + ] + }, + "CreateExportTask":{ + "name":"CreateExportTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateExportTaskRequest"}, + "output":{"shape":"CreateExportTaskResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"LimitExceededException"}, + {"shape":"OperationAbortedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceAlreadyExistsException"} + ] + }, + "CreateLogGroup":{ + "name":"CreateLogGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateLogGroupRequest"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"LimitExceededException"}, + {"shape":"OperationAbortedException"}, + {"shape":"ServiceUnavailableException"} + ] + }, + "CreateLogStream":{ + "name":"CreateLogStream", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateLogStreamRequest"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ServiceUnavailableException"} + ] + }, + "DeleteDestination":{ + "name":"DeleteDestination", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDestinationRequest"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"OperationAbortedException"}, + {"shape":"ServiceUnavailableException"} + ] + }, + "DeleteLogGroup":{ + "name":"DeleteLogGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteLogGroupRequest"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"OperationAbortedException"}, + {"shape":"ServiceUnavailableException"} + ] + }, + "DeleteLogStream":{ + "name":"DeleteLogStream", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteLogStreamRequest"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"OperationAbortedException"}, + {"shape":"ServiceUnavailableException"} + ] + }, + "DeleteMetricFilter":{ + "name":"DeleteMetricFilter", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteMetricFilterRequest"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"OperationAbortedException"}, + {"shape":"ServiceUnavailableException"} + ] + }, + "DeleteRetentionPolicy":{ + "name":"DeleteRetentionPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteRetentionPolicyRequest"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"OperationAbortedException"}, + {"shape":"ServiceUnavailableException"} + ] + }, + "DeleteSubscriptionFilter":{ + "name":"DeleteSubscriptionFilter", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSubscriptionFilterRequest"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"OperationAbortedException"}, + {"shape":"ServiceUnavailableException"} + ] + }, + "DescribeDestinations":{ + "name":"DescribeDestinations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDestinationsRequest"}, + "output":{"shape":"DescribeDestinationsResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ServiceUnavailableException"} + ] + }, + "DescribeExportTasks":{ + "name":"DescribeExportTasks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeExportTasksRequest"}, + "output":{"shape":"DescribeExportTasksResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ServiceUnavailableException"} + ] + }, + "DescribeLogGroups":{ + "name":"DescribeLogGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeLogGroupsRequest"}, + "output":{"shape":"DescribeLogGroupsResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ServiceUnavailableException"} + ] + }, + "DescribeLogStreams":{ + "name":"DescribeLogStreams", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeLogStreamsRequest"}, + "output":{"shape":"DescribeLogStreamsResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ServiceUnavailableException"} + ] + }, + "DescribeMetricFilters":{ + "name":"DescribeMetricFilters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeMetricFiltersRequest"}, + "output":{"shape":"DescribeMetricFiltersResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ServiceUnavailableException"} + ] + }, + "DescribeSubscriptionFilters":{ + "name":"DescribeSubscriptionFilters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSubscriptionFiltersRequest"}, + "output":{"shape":"DescribeSubscriptionFiltersResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ServiceUnavailableException"} + ] + }, + "FilterLogEvents":{ + "name":"FilterLogEvents", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"FilterLogEventsRequest"}, + "output":{"shape":"FilterLogEventsResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ServiceUnavailableException"} + ] + }, + "GetLogEvents":{ + "name":"GetLogEvents", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetLogEventsRequest"}, + "output":{"shape":"GetLogEventsResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ServiceUnavailableException"} + ] + }, + "PutDestination":{ + "name":"PutDestination", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutDestinationRequest"}, + "output":{"shape":"PutDestinationResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"OperationAbortedException"}, + {"shape":"ServiceUnavailableException"} + ] + }, + "PutDestinationPolicy":{ + "name":"PutDestinationPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutDestinationPolicyRequest"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"OperationAbortedException"}, + {"shape":"ServiceUnavailableException"} + ] + }, + "PutLogEvents":{ + "name":"PutLogEvents", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutLogEventsRequest"}, + "output":{"shape":"PutLogEventsResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"InvalidSequenceTokenException"}, + {"shape":"DataAlreadyAcceptedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"OperationAbortedException"}, + {"shape":"ServiceUnavailableException"} + ] + }, + "PutMetricFilter":{ + "name":"PutMetricFilter", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutMetricFilterRequest"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"OperationAbortedException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceUnavailableException"} + ] + }, + "PutRetentionPolicy":{ + "name":"PutRetentionPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutRetentionPolicyRequest"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"OperationAbortedException"}, + {"shape":"ServiceUnavailableException"} + ] + }, + "PutSubscriptionFilter":{ + "name":"PutSubscriptionFilter", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutSubscriptionFilterRequest"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"OperationAbortedException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceUnavailableException"} + ] + }, + "TestMetricFilter":{ + "name":"TestMetricFilter", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TestMetricFilterRequest"}, + "output":{"shape":"TestMetricFilterResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ServiceUnavailableException"} + ] + } + }, + "shapes":{ + "AccessPolicy":{ + "type":"string", + "min":1 + }, + "Arn":{"type":"string"}, + "CancelExportTaskRequest":{ + "type":"structure", + "required":["taskId"], + "members":{ + "taskId":{"shape":"ExportTaskId"} + } + }, + "CreateExportTaskRequest":{ + "type":"structure", + "required":[ + "logGroupName", + "from", + "to", + "destination" + ], + "members":{ + "taskName":{"shape":"ExportTaskName"}, + "logGroupName":{"shape":"LogGroupName"}, + "logStreamNamePrefix":{"shape":"LogStreamName"}, + "from":{"shape":"Timestamp"}, + "to":{"shape":"Timestamp"}, + "destination":{"shape":"ExportDestinationBucket"}, + "destinationPrefix":{"shape":"ExportDestinationPrefix"} + } + }, + "CreateExportTaskResponse":{ + "type":"structure", + "members":{ + "taskId":{"shape":"ExportTaskId"} + } + }, + "CreateLogGroupRequest":{ + "type":"structure", + "required":["logGroupName"], + "members":{ + "logGroupName":{"shape":"LogGroupName"} + } + }, + "CreateLogStreamRequest":{ + "type":"structure", + "required":[ + "logGroupName", + "logStreamName" + ], + "members":{ + "logGroupName":{"shape":"LogGroupName"}, + "logStreamName":{"shape":"LogStreamName"} + } + }, + "DataAlreadyAcceptedException":{ + "type":"structure", + "members":{ + "expectedSequenceToken":{"shape":"SequenceToken"} + }, + "exception":true + }, + "Days":{"type":"integer"}, + "DeleteDestinationRequest":{ + "type":"structure", + "required":["destinationName"], + "members":{ + "destinationName":{"shape":"DestinationName"} + } + }, + "DeleteLogGroupRequest":{ + "type":"structure", + "required":["logGroupName"], + "members":{ + "logGroupName":{"shape":"LogGroupName"} + } + }, + "DeleteLogStreamRequest":{ + "type":"structure", + "required":[ + "logGroupName", + "logStreamName" + ], + "members":{ + "logGroupName":{"shape":"LogGroupName"}, + "logStreamName":{"shape":"LogStreamName"} + } + }, + "DeleteMetricFilterRequest":{ + "type":"structure", + "required":[ + "logGroupName", + "filterName" + ], + "members":{ + "logGroupName":{"shape":"LogGroupName"}, + "filterName":{"shape":"FilterName"} + } + }, + "DeleteRetentionPolicyRequest":{ + "type":"structure", + "required":["logGroupName"], + "members":{ + "logGroupName":{"shape":"LogGroupName"} + } + }, + "DeleteSubscriptionFilterRequest":{ + "type":"structure", + "required":[ + "logGroupName", + "filterName" + ], + "members":{ + "logGroupName":{"shape":"LogGroupName"}, + "filterName":{"shape":"FilterName"} + } + }, + "Descending":{"type":"boolean"}, + "DescribeDestinationsRequest":{ + "type":"structure", + "members":{ + "DestinationNamePrefix":{"shape":"DestinationName"}, + "nextToken":{"shape":"NextToken"}, + "limit":{"shape":"DescribeLimit"} + } + }, + "DescribeDestinationsResponse":{ + "type":"structure", + "members":{ + "destinations":{"shape":"Destinations"}, + "nextToken":{"shape":"NextToken"} + } + }, + "DescribeExportTasksRequest":{ + "type":"structure", + "members":{ + "taskId":{"shape":"ExportTaskId"}, + "statusCode":{"shape":"ExportTaskStatusCode"}, + "nextToken":{"shape":"NextToken"}, + "limit":{"shape":"DescribeLimit"} + } + }, + "DescribeExportTasksResponse":{ + "type":"structure", + "members":{ + "exportTasks":{"shape":"ExportTasks"}, + "nextToken":{"shape":"NextToken"} + } + }, + "DescribeLimit":{ + "type":"integer", + "max":50, + "min":1 + }, + "DescribeLogGroupsRequest":{ + "type":"structure", + "members":{ + "logGroupNamePrefix":{"shape":"LogGroupName"}, + "nextToken":{"shape":"NextToken"}, + "limit":{"shape":"DescribeLimit"} + } + }, + "DescribeLogGroupsResponse":{ + "type":"structure", + "members":{ + "logGroups":{"shape":"LogGroups"}, + "nextToken":{"shape":"NextToken"} + } + }, + "DescribeLogStreamsRequest":{ + "type":"structure", + "required":["logGroupName"], + "members":{ + "logGroupName":{"shape":"LogGroupName"}, + "logStreamNamePrefix":{"shape":"LogStreamName"}, + "orderBy":{"shape":"OrderBy"}, + "descending":{"shape":"Descending"}, + "nextToken":{"shape":"NextToken"}, + "limit":{"shape":"DescribeLimit"} + } + }, + "DescribeLogStreamsResponse":{ + "type":"structure", + "members":{ + "logStreams":{"shape":"LogStreams"}, + "nextToken":{"shape":"NextToken"} + } + }, + "DescribeMetricFiltersRequest":{ + "type":"structure", + "required":["logGroupName"], + "members":{ + "logGroupName":{"shape":"LogGroupName"}, + "filterNamePrefix":{"shape":"FilterName"}, + "nextToken":{"shape":"NextToken"}, + "limit":{"shape":"DescribeLimit"} + } + }, + "DescribeMetricFiltersResponse":{ + "type":"structure", + "members":{ + "metricFilters":{"shape":"MetricFilters"}, + "nextToken":{"shape":"NextToken"} + } + }, + "DescribeSubscriptionFiltersRequest":{ + "type":"structure", + "required":["logGroupName"], + "members":{ + "logGroupName":{"shape":"LogGroupName"}, + "filterNamePrefix":{"shape":"FilterName"}, + "nextToken":{"shape":"NextToken"}, + "limit":{"shape":"DescribeLimit"} + } + }, + "DescribeSubscriptionFiltersResponse":{ + "type":"structure", + "members":{ + "subscriptionFilters":{"shape":"SubscriptionFilters"}, + "nextToken":{"shape":"NextToken"} + } + }, + "Destination":{ + "type":"structure", + "members":{ + "destinationName":{"shape":"DestinationName"}, + "targetArn":{"shape":"TargetArn"}, + "roleArn":{"shape":"RoleArn"}, + "accessPolicy":{"shape":"AccessPolicy"}, + "arn":{"shape":"Arn"}, + "creationTime":{"shape":"Timestamp"} + } + }, + "DestinationArn":{ + "type":"string", + "min":1 + }, + "DestinationName":{ + "type":"string", + "max":512, + "min":1, + "pattern":"[^:*]*" + }, + "Destinations":{ + "type":"list", + "member":{"shape":"Destination"} + }, + "EventId":{"type":"string"}, + "EventMessage":{ + "type":"string", + "min":1 + }, + "EventNumber":{"type":"long"}, + "EventsLimit":{ + "type":"integer", + "max":10000, + "min":1 + }, + "ExportDestinationBucket":{ + "type":"string", + "max":512, + "min":1 + }, + "ExportDestinationPrefix":{"type":"string"}, + "ExportTask":{ + "type":"structure", + "members":{ + "taskId":{"shape":"ExportTaskId"}, + "taskName":{"shape":"ExportTaskName"}, + "logGroupName":{"shape":"LogGroupName"}, + "from":{"shape":"Timestamp"}, + "to":{"shape":"Timestamp"}, + "destination":{"shape":"ExportDestinationBucket"}, + "destinationPrefix":{"shape":"ExportDestinationPrefix"}, + "status":{"shape":"ExportTaskStatus"}, + "executionInfo":{"shape":"ExportTaskExecutionInfo"} + } + }, + "ExportTaskExecutionInfo":{ + "type":"structure", + "members":{ + "creationTime":{"shape":"Timestamp"}, + "completionTime":{"shape":"Timestamp"} + } + }, + "ExportTaskId":{ + "type":"string", + "max":512, + "min":1 + }, + "ExportTaskName":{ + "type":"string", + "max":512, + "min":1 + }, + "ExportTaskStatus":{ + "type":"structure", + "members":{ + "code":{"shape":"ExportTaskStatusCode"}, + "message":{"shape":"ExportTaskStatusMessage"} + } + }, + "ExportTaskStatusCode":{ + "type":"string", + "enum":[ + "CANCELLED", + "COMPLETED", + "FAILED", + "PENDING", + "PENDING_CANCEL", + "RUNNING" + ] + }, + "ExportTaskStatusMessage":{"type":"string"}, + "ExportTasks":{ + "type":"list", + "member":{"shape":"ExportTask"} + }, + "ExtractedValues":{ + "type":"map", + "key":{"shape":"Token"}, + "value":{"shape":"Value"} + }, + "FilterCount":{"type":"integer"}, + "FilterLogEventsRequest":{ + "type":"structure", + "required":["logGroupName"], + "members":{ + "logGroupName":{"shape":"LogGroupName"}, + "logStreamNames":{"shape":"InputLogStreamNames"}, + "startTime":{"shape":"Timestamp"}, + "endTime":{"shape":"Timestamp"}, + "filterPattern":{"shape":"FilterPattern"}, + "nextToken":{"shape":"NextToken"}, + "limit":{"shape":"EventsLimit"}, + "interleaved":{"shape":"Interleaved"} + } + }, + "FilterLogEventsResponse":{ + "type":"structure", + "members":{ + "events":{"shape":"FilteredLogEvents"}, + "searchedLogStreams":{"shape":"SearchedLogStreams"}, + "nextToken":{"shape":"NextToken"} + } + }, + "FilterName":{ + "type":"string", + "max":512, + "min":1, + "pattern":"[^:*]*" + }, + "FilterPattern":{ + "type":"string", + "max":1024, + "min":0 + }, + "FilteredLogEvent":{ + "type":"structure", + "members":{ + "logStreamName":{"shape":"LogStreamName"}, + "timestamp":{"shape":"Timestamp"}, + "message":{"shape":"EventMessage"}, + "ingestionTime":{"shape":"Timestamp"}, + "eventId":{"shape":"EventId"} + } + }, + "FilteredLogEvents":{ + "type":"list", + "member":{"shape":"FilteredLogEvent"} + }, + "GetLogEventsRequest":{ + "type":"structure", + "required":[ + "logGroupName", + "logStreamName" + ], + "members":{ + "logGroupName":{"shape":"LogGroupName"}, + "logStreamName":{"shape":"LogStreamName"}, + "startTime":{"shape":"Timestamp"}, + "endTime":{"shape":"Timestamp"}, + "nextToken":{"shape":"NextToken"}, + "limit":{"shape":"EventsLimit"}, + "startFromHead":{"shape":"StartFromHead"} + } + }, + "GetLogEventsResponse":{ + "type":"structure", + "members":{ + "events":{"shape":"OutputLogEvents"}, + "nextForwardToken":{"shape":"NextToken"}, + "nextBackwardToken":{"shape":"NextToken"} + } + }, + "InputLogEvent":{ + "type":"structure", + "required":[ + "timestamp", + "message" + ], + "members":{ + "timestamp":{"shape":"Timestamp"}, + "message":{"shape":"EventMessage"} + } + }, + "InputLogEvents":{ + "type":"list", + "member":{"shape":"InputLogEvent"}, + "max":10000, + "min":1 + }, + "InputLogStreamNames":{ + "type":"list", + "member":{"shape":"LogStreamName"}, + "max":100, + "min":1 + }, + "Interleaved":{"type":"boolean"}, + "InvalidOperationException":{ + "type":"structure", + "members":{ + }, + "exception":true + }, + "InvalidParameterException":{ + "type":"structure", + "members":{ + }, + "exception":true + }, + "InvalidSequenceTokenException":{ + "type":"structure", + "members":{ + "expectedSequenceToken":{"shape":"SequenceToken"} + }, + "exception":true + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + }, + "exception":true + }, + "LogEventIndex":{"type":"integer"}, + "LogGroup":{ + "type":"structure", + "members":{ + "logGroupName":{"shape":"LogGroupName"}, + "creationTime":{"shape":"Timestamp"}, + "retentionInDays":{"shape":"Days"}, + "metricFilterCount":{"shape":"FilterCount"}, + "arn":{"shape":"Arn"}, + "storedBytes":{"shape":"StoredBytes"} + } + }, + "LogGroupName":{ + "type":"string", + "max":512, + "min":1, + "pattern":"[\\.\\-_/#A-Za-z0-9]+" + }, + "LogGroups":{ + "type":"list", + "member":{"shape":"LogGroup"} + }, + "LogStream":{ + "type":"structure", + "members":{ + "logStreamName":{"shape":"LogStreamName"}, + "creationTime":{"shape":"Timestamp"}, + "firstEventTimestamp":{"shape":"Timestamp"}, + "lastEventTimestamp":{"shape":"Timestamp"}, + "lastIngestionTime":{"shape":"Timestamp"}, + "uploadSequenceToken":{"shape":"SequenceToken"}, + "arn":{"shape":"Arn"}, + "storedBytes":{"shape":"StoredBytes"} + } + }, + "LogStreamName":{ + "type":"string", + "max":512, + "min":1, + "pattern":"[^:*]*" + }, + "LogStreamSearchedCompletely":{"type":"boolean"}, + "LogStreams":{ + "type":"list", + "member":{"shape":"LogStream"} + }, + "MetricFilter":{ + "type":"structure", + "members":{ + "filterName":{"shape":"FilterName"}, + "filterPattern":{"shape":"FilterPattern"}, + "metricTransformations":{"shape":"MetricTransformations"}, + "creationTime":{"shape":"Timestamp"} + } + }, + "MetricFilterMatchRecord":{ + "type":"structure", + "members":{ + "eventNumber":{"shape":"EventNumber"}, + "eventMessage":{"shape":"EventMessage"}, + "extractedValues":{"shape":"ExtractedValues"} + } + }, + "MetricFilterMatches":{ + "type":"list", + "member":{"shape":"MetricFilterMatchRecord"} + }, + "MetricFilters":{ + "type":"list", + "member":{"shape":"MetricFilter"} + }, + "MetricName":{ + "type":"string", + "max":255, + "pattern":"[^:*$]*" + }, + "MetricNamespace":{ + "type":"string", + "max":255, + "pattern":"[^:*$]*" + }, + "MetricTransformation":{ + "type":"structure", + "required":[ + "metricName", + "metricNamespace", + "metricValue" + ], + "members":{ + "metricName":{"shape":"MetricName"}, + "metricNamespace":{"shape":"MetricNamespace"}, + "metricValue":{"shape":"MetricValue"} + } + }, + "MetricTransformations":{ + "type":"list", + "member":{"shape":"MetricTransformation"}, + "max":1, + "min":1 + }, + "MetricValue":{ + "type":"string", + "max":100 + }, + "NextToken":{ + "type":"string", + "min":1 + }, + "OperationAbortedException":{ + "type":"structure", + "members":{ + }, + "exception":true + }, + "OrderBy":{ + "type":"string", + "enum":[ + "LogStreamName", + "LastEventTime" + ] + }, + "OutputLogEvent":{ + "type":"structure", + "members":{ + "timestamp":{"shape":"Timestamp"}, + "message":{"shape":"EventMessage"}, + "ingestionTime":{"shape":"Timestamp"} + } + }, + "OutputLogEvents":{ + "type":"list", + "member":{"shape":"OutputLogEvent"} + }, + "PutDestinationPolicyRequest":{ + "type":"structure", + "required":[ + "destinationName", + "accessPolicy" + ], + "members":{ + "destinationName":{"shape":"DestinationName"}, + "accessPolicy":{"shape":"AccessPolicy"} + } + }, + "PutDestinationRequest":{ + "type":"structure", + "required":[ + "destinationName", + "targetArn", + "roleArn" + ], + "members":{ + "destinationName":{"shape":"DestinationName"}, + "targetArn":{"shape":"TargetArn"}, + "roleArn":{"shape":"RoleArn"} + } + }, + "PutDestinationResponse":{ + "type":"structure", + "members":{ + "destination":{"shape":"Destination"} + } + }, + "PutLogEventsRequest":{ + "type":"structure", + "required":[ + "logGroupName", + "logStreamName", + "logEvents" + ], + "members":{ + "logGroupName":{"shape":"LogGroupName"}, + "logStreamName":{"shape":"LogStreamName"}, + "logEvents":{"shape":"InputLogEvents"}, + "sequenceToken":{"shape":"SequenceToken"} + } + }, + "PutLogEventsResponse":{ + "type":"structure", + "members":{ + "nextSequenceToken":{"shape":"SequenceToken"}, + "rejectedLogEventsInfo":{"shape":"RejectedLogEventsInfo"} + } + }, + "PutMetricFilterRequest":{ + "type":"structure", + "required":[ + "logGroupName", + "filterName", + "filterPattern", + "metricTransformations" + ], + "members":{ + "logGroupName":{"shape":"LogGroupName"}, + "filterName":{"shape":"FilterName"}, + "filterPattern":{"shape":"FilterPattern"}, + "metricTransformations":{"shape":"MetricTransformations"} + } + }, + "PutRetentionPolicyRequest":{ + "type":"structure", + "required":[ + "logGroupName", + "retentionInDays" + ], + "members":{ + "logGroupName":{"shape":"LogGroupName"}, + "retentionInDays":{"shape":"Days"} + } + }, + "PutSubscriptionFilterRequest":{ + "type":"structure", + "required":[ + "logGroupName", + "filterName", + "filterPattern", + "destinationArn" + ], + "members":{ + "logGroupName":{"shape":"LogGroupName"}, + "filterName":{"shape":"FilterName"}, + "filterPattern":{"shape":"FilterPattern"}, + "destinationArn":{"shape":"DestinationArn"}, + "roleArn":{"shape":"RoleArn"} + } + }, + "RejectedLogEventsInfo":{ + "type":"structure", + "members":{ + "tooNewLogEventStartIndex":{"shape":"LogEventIndex"}, + "tooOldLogEventEndIndex":{"shape":"LogEventIndex"}, + "expiredLogEventEndIndex":{"shape":"LogEventIndex"} + } + }, + "ResourceAlreadyExistsException":{ + "type":"structure", + "members":{ + }, + "exception":true + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + }, + "exception":true + }, + "RoleArn":{ + "type":"string", + "min":1 + }, + "SearchedLogStream":{ + "type":"structure", + "members":{ + "logStreamName":{"shape":"LogStreamName"}, + "searchedCompletely":{"shape":"LogStreamSearchedCompletely"} + } + }, + "SearchedLogStreams":{ + "type":"list", + "member":{"shape":"SearchedLogStream"} + }, + "SequenceToken":{ + "type":"string", + "min":1 + }, + "ServiceUnavailableException":{ + "type":"structure", + "members":{ + }, + "exception":true, + "fault":true + }, + "StartFromHead":{"type":"boolean"}, + "StoredBytes":{ + "type":"long", + "min":0 + }, + "SubscriptionFilter":{ + "type":"structure", + "members":{ + "filterName":{"shape":"FilterName"}, + "logGroupName":{"shape":"LogGroupName"}, + "filterPattern":{"shape":"FilterPattern"}, + "destinationArn":{"shape":"DestinationArn"}, + "roleArn":{"shape":"RoleArn"}, + "creationTime":{"shape":"Timestamp"} + } + }, + "SubscriptionFilters":{ + "type":"list", + "member":{"shape":"SubscriptionFilter"} + }, + "TargetArn":{ + "type":"string", + "min":1 + }, + "TestEventMessages":{ + "type":"list", + "member":{"shape":"EventMessage"}, + "max":50, + "min":1 + }, + "TestMetricFilterRequest":{ + "type":"structure", + "required":[ + "filterPattern", + "logEventMessages" + ], + "members":{ + "filterPattern":{"shape":"FilterPattern"}, + "logEventMessages":{"shape":"TestEventMessages"} + } + }, + "TestMetricFilterResponse":{ + "type":"structure", + "members":{ + "matches":{"shape":"MetricFilterMatches"} + } + }, + "Timestamp":{ + "type":"long", + "min":0 + }, + "Token":{"type":"string"}, + "Value":{"type":"string"} + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/logs/2014-03-28/docs-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/logs/2014-03-28/docs-2.json new file mode 100644 index 000000000..4b9ba501d --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/logs/2014-03-28/docs-2.json @@ -0,0 +1,789 @@ +{ + "version": "2.0", + "service": "You can use Amazon CloudWatch Logs to monitor, store, and access your log files from Amazon Elastic Compute Cloud (Amazon EC2) instances, Amazon CloudTrail, or other sources. You can then retrieve the associated log data from CloudWatch Logs using the Amazon CloudWatch console, the CloudWatch Logs commands in the AWS CLI, the CloudWatch Logs API, or the CloudWatch Logs SDK.
You can use CloudWatch Logs to:
Monitor Logs from Amazon EC2 Instances in Real-time: You can use CloudWatch Logs to monitor applications and systems using log data. For example, CloudWatch Logs can track the number of errors that occur in your application logs and send you a notification whenever the rate of errors exceeds a threshold you specify. CloudWatch Logs uses your log data for monitoring; so, no code changes are required. For example, you can monitor application logs for specific literal terms (such as \"NullReferenceException\") or count the number of occurrences of a literal term at a particular position in log data (such as \"404\" status codes in an Apache access log). When the term you are searching for is found, CloudWatch Logs reports the data to a Amazon CloudWatch metric that you specify.
Monitor Amazon CloudTrail Logged Events: You can create alarms in Amazon CloudWatch and receive notifications of particular API activity as captured by CloudTrail and use the notification to perform troubleshooting.
Archive Log Data: You can use CloudWatch Logs to store your log data in highly durable storage. You can change the log retention setting so that any log events older than this setting are automatically deleted. The CloudWatch Logs agent makes it easy to quickly send both rotated and non-rotated log data off of a host and into the log service. You can then access the raw log data when you need it.
Cancels an export task if it is in PENDING or RUNNING state.
Creates an ExportTask which allows you to efficiently export data from a Log Group to your Amazon S3 bucket.
This is an asynchronous call. If all the required information is provided, this API will initiate an export task and respond with the task Id. Once started, DescribeExportTasks can be used to get the status of an export task. You can only have one active (RUNNING or PENDING) export task at a time, per account.
You can export logs from multiple log groups or multiple time ranges to the same Amazon S3 bucket. To separate out log data for each export task, you can specify a prefix that will be used as the Amazon S3 key prefix for all exported objects.
", + "CreateLogGroup": "Creates a new log group with the specified name. The name of the log group must be unique within a region for an AWS account. You can create up to 500 log groups per account.
You must use the following guidelines when naming a log group:
Creates a new log stream in the specified log group. The name of the log stream must be unique within the log group. There is no limit on the number of log streams that can exist in a log group.
You must use the following guidelines when naming a log stream:
Deletes the destination with the specified name and eventually disables all the subscription filters that publish to it. This will not delete the physical resource encapsulated by the destination.
", + "DeleteLogGroup": "Deletes the log group with the specified name and permanently deletes all the archived log events associated with it.
", + "DeleteLogStream": "Deletes a log stream and permanently deletes all the archived log events associated with it.
", + "DeleteMetricFilter": "Deletes a metric filter associated with the specified log group.
", + "DeleteRetentionPolicy": "Deletes the retention policy of the specified log group. Log events would not expire if they belong to log groups without a retention policy.
", + "DeleteSubscriptionFilter": "Deletes a subscription filter associated with the specified log group.
", + "DescribeDestinations": "Returns all the destinations that are associated with the AWS account making the request. The list returned in the response is ASCII-sorted by destination name.
By default, this operation returns up to 50 destinations. If there are more destinations to list, the response would contain a nextToken value in the response body. You can also limit the number of destinations returned in the response by specifying the limit parameter in the request.
Returns all the export tasks that are associated with the AWS account making the request. The export tasks can be filtered based on TaskId or TaskStatus.
By default, this operation returns up to 50 export tasks that satisfy the specified filters. If there are more export tasks to list, the response would contain a nextToken value in the response body. You can also limit the number of export tasks returned in the response by specifying the limit parameter in the request.
Returns all the log groups that are associated with the AWS account making the request. The list returned in the response is ASCII-sorted by log group name.
By default, this operation returns up to 50 log groups. If there are more log groups to list, the response would contain a nextToken value in the response body. You can also limit the number of log groups returned in the response by specifying the limit parameter in the request.
Returns all the log streams that are associated with the specified log group. The list returned in the response is ASCII-sorted by log stream name.
By default, this operation returns up to 50 log streams. If there are more log streams to list, the response would contain a nextToken value in the response body. You can also limit the number of log streams returned in the response by specifying the limit parameter in the request. This operation has a limit of five transactions per second, after which transactions are throttled.
Returns all the metrics filters associated with the specified log group. The list returned in the response is ASCII-sorted by filter name.
By default, this operation returns up to 50 metric filters. If there are more metric filters to list, the response would contain a nextToken value in the response body. You can also limit the number of metric filters returned in the response by specifying the limit parameter in the request.
Returns all the subscription filters associated with the specified log group. The list returned in the response is ASCII-sorted by filter name.
By default, this operation returns up to 50 subscription filters. If there are more subscription filters to list, the response would contain a nextToken value in the response body. You can also limit the number of subscription filters returned in the response by specifying the limit parameter in the request.
Retrieves log events, optionally filtered by a filter pattern from the specified log group. You can provide an optional time range to filter the results on the event timestamp. You can limit the streams searched to an explicit list of logStreamNames.
By default, this operation returns as much matching log events as can fit in a response size of 1MB, up to 10,000 log events, or all the events found within a time-bounded scan window. If the response includes a nextToken, then there is more data to search, and the search can be resumed with a new request providing the nextToken. The response will contain a list of searchedLogStreams that contains information about which streams were searched in the request and whether they have been searched completely or require further pagination. The limit parameter in the request. can be used to specify the maximum number of events to return in a page.
Retrieves log events from the specified log stream. You can provide an optional time range to filter the results on the event timestamp.
By default, this operation returns as much log events as can fit in a response size of 1MB, up to 10,000 log events. The response will always include a nextForwardToken and a nextBackwardToken in the response body. You can use any of these tokens in subsequent GetLogEvents requests to paginate through events in either forward or backward direction. You can also limit the number of log events returned in the response by specifying the limit parameter in the request.
Creates or updates a Destination. A destination encapsulates a physical resource (such as a Kinesis stream) and allows you to subscribe to a real-time stream of log events of a different account, ingested through PutLogEvents requests. Currently, the only supported physical resource is a Amazon Kinesis stream belonging to the same account as the destination.
A destination controls what is written to its Amazon Kinesis stream through an access policy. By default, PutDestination does not set any access policy with the destination, which means a cross-account user will not be able to call PutSubscriptionFilter against this destination. To enable that, the destination owner must call PutDestinationPolicy after PutDestination.
Creates or updates an access policy associated with an existing Destination. An access policy is an IAM policy document that is used to authorize claims to register a subscription filter against a given destination.
Uploads a batch of log events to the specified log stream.
Every PutLogEvents request must include the sequenceToken obtained from the response of the previous request. An upload in a newly created log stream does not require a sequenceToken.
The batch of events must satisfy the following constraints:
timestamp. Creates or updates a metric filter and associates it with the specified log group. Metric filters allow you to configure rules to extract metric data from log events ingested through PutLogEvents requests.
The maximum number of metric filters that can be associated with a log group is 100.
", + "PutRetentionPolicy": "Sets the retention of the specified log group. A retention policy allows you to configure the number of days you want to retain log events in the specified log group.
", + "PutSubscriptionFilter": " Creates or updates a subscription filter and associates it with the specified log group. Subscription filters allow you to subscribe to a real-time stream of log events ingested through PutLogEvents requests and have them delivered to a specific destination. Currently, the supported destinations are:
Destination) belonging to a different account, for cross-account delivery. Currently there can only be one subscription filter associated with a log group.
", + "TestMetricFilter": "Tests the filter pattern of a metric filter against a sample of log event messages. You can use this operation to validate the correctness of a metric filter pattern.
" + }, + "shapes": { + "AccessPolicy": { + "base": null, + "refs": { + "Destination$accessPolicy": "An IAM policy document that governs which AWS accounts can create subscription filters against this destination.
", + "PutDestinationPolicyRequest$accessPolicy": "An IAM policy document that authorizes cross-account users to deliver their log events to associated destination.
" + } + }, + "Arn": { + "base": null, + "refs": { + "Destination$arn": "ARN of this destination.
", + "LogGroup$arn": null, + "LogStream$arn": null + } + }, + "CancelExportTaskRequest": { + "base": null, + "refs": { + } + }, + "CreateExportTaskRequest": { + "base": null, + "refs": { + } + }, + "CreateExportTaskResponse": { + "base": null, + "refs": { + } + }, + "CreateLogGroupRequest": { + "base": null, + "refs": { + } + }, + "CreateLogStreamRequest": { + "base": null, + "refs": { + } + }, + "DataAlreadyAcceptedException": { + "base": null, + "refs": { + } + }, + "Days": { + "base": "Specifies the number of days you want to retain log events in the specified log group. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, 3653.
", + "refs": { + "LogGroup$retentionInDays": null, + "PutRetentionPolicyRequest$retentionInDays": null + } + }, + "DeleteDestinationRequest": { + "base": null, + "refs": { + } + }, + "DeleteLogGroupRequest": { + "base": null, + "refs": { + } + }, + "DeleteLogStreamRequest": { + "base": null, + "refs": { + } + }, + "DeleteMetricFilterRequest": { + "base": null, + "refs": { + } + }, + "DeleteRetentionPolicyRequest": { + "base": null, + "refs": { + } + }, + "DeleteSubscriptionFilterRequest": { + "base": null, + "refs": { + } + }, + "Descending": { + "base": null, + "refs": { + "DescribeLogStreamsRequest$descending": "If set to true, results are returned in descending order. If you don't specify a value or set it to false, results are returned in ascending order.
" + } + }, + "DescribeDestinationsRequest": { + "base": null, + "refs": { + } + }, + "DescribeDestinationsResponse": { + "base": null, + "refs": { + } + }, + "DescribeExportTasksRequest": { + "base": null, + "refs": { + } + }, + "DescribeExportTasksResponse": { + "base": null, + "refs": { + } + }, + "DescribeLimit": { + "base": "The maximum number of results to return.
", + "refs": { + "DescribeDestinationsRequest$limit": null, + "DescribeExportTasksRequest$limit": "The maximum number of items returned in the response. If you don't specify a value, the request would return up to 50 items.
", + "DescribeLogGroupsRequest$limit": "The maximum number of items returned in the response. If you don't specify a value, the request would return up to 50 items.
", + "DescribeLogStreamsRequest$limit": "The maximum number of items returned in the response. If you don't specify a value, the request would return up to 50 items.
", + "DescribeMetricFiltersRequest$limit": "The maximum number of items returned in the response. If you don't specify a value, the request would return up to 50 items.
", + "DescribeSubscriptionFiltersRequest$limit": null + } + }, + "DescribeLogGroupsRequest": { + "base": null, + "refs": { + } + }, + "DescribeLogGroupsResponse": { + "base": null, + "refs": { + } + }, + "DescribeLogStreamsRequest": { + "base": null, + "refs": { + } + }, + "DescribeLogStreamsResponse": { + "base": null, + "refs": { + } + }, + "DescribeMetricFiltersRequest": { + "base": null, + "refs": { + } + }, + "DescribeMetricFiltersResponse": { + "base": null, + "refs": { + } + }, + "DescribeSubscriptionFiltersRequest": { + "base": null, + "refs": { + } + }, + "DescribeSubscriptionFiltersResponse": { + "base": null, + "refs": { + } + }, + "Destination": { + "base": "A cross account destination that is the recipient of subscription log events.
", + "refs": { + "Destinations$member": null, + "PutDestinationResponse$destination": null + } + }, + "DestinationArn": { + "base": null, + "refs": { + "PutSubscriptionFilterRequest$destinationArn": "The ARN of the destination to deliver matching log events to. Currently, the supported destinations are:
Destination) belonging to a different account, for cross-account delivery. The name of destination to delete.
", + "DescribeDestinationsRequest$DestinationNamePrefix": "Will only return destinations that match the provided destinationNamePrefix. If you don't specify a value, no prefix is applied.
", + "Destination$destinationName": "Name of the destination.
", + "PutDestinationPolicyRequest$destinationName": "A name for an existing destination.
", + "PutDestinationRequest$destinationName": "A name for the destination.
" + } + }, + "Destinations": { + "base": null, + "refs": { + "DescribeDestinationsResponse$destinations": null + } + }, + "EventId": { + "base": null, + "refs": { + "FilteredLogEvent$eventId": "A unique identifier for this event.
" + } + }, + "EventMessage": { + "base": null, + "refs": { + "FilteredLogEvent$message": "The data contained in the log event.
", + "InputLogEvent$message": null, + "MetricFilterMatchRecord$eventMessage": null, + "OutputLogEvent$message": null, + "TestEventMessages$member": null + } + }, + "EventNumber": { + "base": null, + "refs": { + "MetricFilterMatchRecord$eventNumber": null + } + }, + "EventsLimit": { + "base": "The maximum number of events to return.
", + "refs": { + "FilterLogEventsRequest$limit": "The maximum number of events to return in a page of results. Default is 10,000 events.
", + "GetLogEventsRequest$limit": "The maximum number of log events returned in the response. If you don't specify a value, the request would return as many log events as can fit in a response size of 1MB, up to 10,000 log events.
" + } + }, + "ExportDestinationBucket": { + "base": null, + "refs": { + "CreateExportTaskRequest$destination": "Name of Amazon S3 bucket to which the log data will be exported.
Note: Only buckets in the same AWS region are supported.
", + "ExportTask$destination": "Name of Amazon S3 bucket to which the log data was exported.
" + } + }, + "ExportDestinationPrefix": { + "base": null, + "refs": { + "CreateExportTaskRequest$destinationPrefix": "Prefix that will be used as the start of Amazon S3 key for every object exported. If not specified, this defaults to 'exportedlogs'.
", + "ExportTask$destinationPrefix": "Prefix that was used as the start of Amazon S3 key for every object exported.
" + } + }, + "ExportTask": { + "base": "Represents an export task.
", + "refs": { + "ExportTasks$member": null + } + }, + "ExportTaskExecutionInfo": { + "base": "Represents the status of an export task.
", + "refs": { + "ExportTask$executionInfo": "Execution info about the export task.
" + } + }, + "ExportTaskId": { + "base": null, + "refs": { + "CancelExportTaskRequest$taskId": "Id of the export task to cancel.
", + "CreateExportTaskResponse$taskId": "Id of the export task that got created.
", + "DescribeExportTasksRequest$taskId": "Export task that matches the specified task Id will be returned. This can result in zero or one export task.
", + "ExportTask$taskId": "Id of the export task.
" + } + }, + "ExportTaskName": { + "base": null, + "refs": { + "CreateExportTaskRequest$taskName": "The name of the export task.
", + "ExportTask$taskName": "The name of the export task.
" + } + }, + "ExportTaskStatus": { + "base": "Represents the status of an export task.
", + "refs": { + "ExportTask$status": "Status of the export task.
" + } + }, + "ExportTaskStatusCode": { + "base": null, + "refs": { + "DescribeExportTasksRequest$statusCode": "All export tasks that matches the specified status code will be returned. This can return zero or more export tasks.
", + "ExportTaskStatus$code": "Status code of the export task.
" + } + }, + "ExportTaskStatusMessage": { + "base": null, + "refs": { + "ExportTaskStatus$message": "Status message related to the code.
A list of export tasks.
", + "refs": { + "DescribeExportTasksResponse$exportTasks": null + } + }, + "ExtractedValues": { + "base": null, + "refs": { + "MetricFilterMatchRecord$extractedValues": null + } + }, + "FilterCount": { + "base": "The number of metric filters associated with the log group.
", + "refs": { + "LogGroup$metricFilterCount": null + } + }, + "FilterLogEventsRequest": { + "base": null, + "refs": { + } + }, + "FilterLogEventsResponse": { + "base": null, + "refs": { + } + }, + "FilterName": { + "base": "A name for a metric or subscription filter.
", + "refs": { + "DeleteMetricFilterRequest$filterName": "The name of the metric filter to delete.
", + "DeleteSubscriptionFilterRequest$filterName": "The name of the subscription filter to delete.
", + "DescribeMetricFiltersRequest$filterNamePrefix": "Will only return metric filters that match the provided filterNamePrefix. If you don't specify a value, no prefix filter is applied.
", + "DescribeSubscriptionFiltersRequest$filterNamePrefix": "Will only return subscription filters that match the provided filterNamePrefix. If you don't specify a value, no prefix filter is applied.
", + "MetricFilter$filterName": null, + "PutMetricFilterRequest$filterName": "A name for the metric filter.
", + "PutSubscriptionFilterRequest$filterName": "A name for the subscription filter.
", + "SubscriptionFilter$filterName": null + } + }, + "FilterPattern": { + "base": "A symbolic description of how CloudWatch Logs should interpret the data in each log event. For example, a log event may contain timestamps, IP addresses, strings, and so on. You use the filter pattern to specify what to look for in the log event message.
", + "refs": { + "FilterLogEventsRequest$filterPattern": "A valid CloudWatch Logs filter pattern to use for filtering the response. If not provided, all the events are matched.
", + "MetricFilter$filterPattern": null, + "PutMetricFilterRequest$filterPattern": "A valid CloudWatch Logs filter pattern for extracting metric data out of ingested log events.
", + "PutSubscriptionFilterRequest$filterPattern": "A valid CloudWatch Logs filter pattern for subscribing to a filtered stream of log events.
", + "SubscriptionFilter$filterPattern": null, + "TestMetricFilterRequest$filterPattern": null + } + }, + "FilteredLogEvent": { + "base": "Represents a matched event from a FilterLogEvents request.
A list of matched FilteredLogEvent objects returned from a FilterLogEvents request.
A list of FilteredLogEvent objects representing the matched events from the request.
A log event is a record of some activity that was recorded by the application or resource being monitored. The log event record that CloudWatch Logs understands contains two properties: the timestamp of when the event occurred, and the raw event message.
", + "refs": { + "InputLogEvents$member": null + } + }, + "InputLogEvents": { + "base": "A list of log events belonging to a log stream.
", + "refs": { + "PutLogEventsRequest$logEvents": null + } + }, + "InputLogStreamNames": { + "base": "A list of log stream names.
", + "refs": { + "FilterLogEventsRequest$logStreamNames": "Optional list of log stream names within the specified log group to search. Defaults to all the log streams in the log group.
" + } + }, + "Interleaved": { + "base": null, + "refs": { + "FilterLogEventsRequest$interleaved": "If provided, the API will make a best effort to provide responses that contain events from multiple log streams within the log group interleaved in a single response. If not provided, all the matched log events in the first log stream will be searched first, then those in the next log stream, etc.
" + } + }, + "InvalidOperationException": { + "base": "Returned if the operation is not valid on the specified resource
", + "refs": { + } + }, + "InvalidParameterException": { + "base": "Returned if a parameter of the request is incorrectly specified.
", + "refs": { + } + }, + "InvalidSequenceTokenException": { + "base": null, + "refs": { + } + }, + "LimitExceededException": { + "base": "Returned if you have reached the maximum number of resources that can be created.
", + "refs": { + } + }, + "LogEventIndex": { + "base": null, + "refs": { + "RejectedLogEventsInfo$tooNewLogEventStartIndex": null, + "RejectedLogEventsInfo$tooOldLogEventEndIndex": null, + "RejectedLogEventsInfo$expiredLogEventEndIndex": null + } + }, + "LogGroup": { + "base": null, + "refs": { + "LogGroups$member": null + } + }, + "LogGroupName": { + "base": null, + "refs": { + "CreateExportTaskRequest$logGroupName": "The name of the log group to export.
", + "CreateLogGroupRequest$logGroupName": "The name of the log group to create.
", + "CreateLogStreamRequest$logGroupName": "The name of the log group under which the log stream is to be created.
", + "DeleteLogGroupRequest$logGroupName": "The name of the log group to delete.
", + "DeleteLogStreamRequest$logGroupName": "The name of the log group under which the log stream to delete belongs.
", + "DeleteMetricFilterRequest$logGroupName": "The name of the log group that is associated with the metric filter to delete.
", + "DeleteRetentionPolicyRequest$logGroupName": "The name of the log group that is associated with the retention policy to delete.
", + "DeleteSubscriptionFilterRequest$logGroupName": "The name of the log group that is associated with the subscription filter to delete.
", + "DescribeLogGroupsRequest$logGroupNamePrefix": "Will only return log groups that match the provided logGroupNamePrefix. If you don't specify a value, no prefix filter is applied.
", + "DescribeLogStreamsRequest$logGroupName": "The log group name for which log streams are to be listed.
", + "DescribeMetricFiltersRequest$logGroupName": "The log group name for which metric filters are to be listed.
", + "DescribeSubscriptionFiltersRequest$logGroupName": "The log group name for which subscription filters are to be listed.
", + "ExportTask$logGroupName": "The name of the log group from which logs data was exported.
", + "FilterLogEventsRequest$logGroupName": "The name of the log group to query.
", + "GetLogEventsRequest$logGroupName": "The name of the log group to query.
", + "LogGroup$logGroupName": null, + "PutLogEventsRequest$logGroupName": "The name of the log group to put log events to.
", + "PutMetricFilterRequest$logGroupName": "The name of the log group to associate the metric filter with.
", + "PutRetentionPolicyRequest$logGroupName": "The name of the log group to associate the retention policy with.
", + "PutSubscriptionFilterRequest$logGroupName": "The name of the log group to associate the subscription filter with.
", + "SubscriptionFilter$logGroupName": null + } + }, + "LogGroups": { + "base": "A list of log groups.
", + "refs": { + "DescribeLogGroupsResponse$logGroups": null + } + }, + "LogStream": { + "base": "A log stream is sequence of log events from a single emitter of logs.
", + "refs": { + "LogStreams$member": null + } + }, + "LogStreamName": { + "base": null, + "refs": { + "CreateExportTaskRequest$logStreamNamePrefix": "Will only export log streams that match the provided logStreamNamePrefix. If you don't specify a value, no prefix filter is applied.
", + "CreateLogStreamRequest$logStreamName": "The name of the log stream to create.
", + "DeleteLogStreamRequest$logStreamName": "The name of the log stream to delete.
", + "DescribeLogStreamsRequest$logStreamNamePrefix": "Will only return log streams that match the provided logStreamNamePrefix. If you don't specify a value, no prefix filter is applied.
", + "FilteredLogEvent$logStreamName": "The name of the log stream this event belongs to.
", + "GetLogEventsRequest$logStreamName": "The name of the log stream to query.
", + "InputLogStreamNames$member": null, + "LogStream$logStreamName": null, + "PutLogEventsRequest$logStreamName": "The name of the log stream to put log events to.
", + "SearchedLogStream$logStreamName": "The name of the log stream.
" + } + }, + "LogStreamSearchedCompletely": { + "base": null, + "refs": { + "SearchedLogStream$searchedCompletely": "Indicates whether all the events in this log stream were searched or more data exists to search by paginating further.
" + } + }, + "LogStreams": { + "base": "A list of log streams.
", + "refs": { + "DescribeLogStreamsResponse$logStreams": null + } + }, + "MetricFilter": { + "base": "Metric filters can be used to express how CloudWatch Logs would extract metric observations from ingested log events and transform them to metric data in a CloudWatch metric.
", + "refs": { + "MetricFilters$member": null + } + }, + "MetricFilterMatchRecord": { + "base": null, + "refs": { + "MetricFilterMatches$member": null + } + }, + "MetricFilterMatches": { + "base": null, + "refs": { + "TestMetricFilterResponse$matches": null + } + }, + "MetricFilters": { + "base": null, + "refs": { + "DescribeMetricFiltersResponse$metricFilters": null + } + }, + "MetricName": { + "base": "The name of the CloudWatch metric to which the monitored log information should be published. For example, you may publish to a metric called ErrorCount.
", + "refs": { + "MetricTransformation$metricName": null + } + }, + "MetricNamespace": { + "base": "The destination namespace of the new CloudWatch metric.
", + "refs": { + "MetricTransformation$metricNamespace": null + } + }, + "MetricTransformation": { + "base": null, + "refs": { + "MetricTransformations$member": null + } + }, + "MetricTransformations": { + "base": null, + "refs": { + "MetricFilter$metricTransformations": null, + "PutMetricFilterRequest$metricTransformations": "A collection of information needed to define how metric data gets emitted.
" + } + }, + "MetricValue": { + "base": "What to publish to the metric. For example, if you're counting the occurrences of a particular term like \"Error\", the value will be \"1\" for each occurrence. If you're counting the bytes transferred the published value will be the value in the log event.
", + "refs": { + "MetricTransformation$metricValue": null + } + }, + "NextToken": { + "base": "A string token used for pagination that points to the next page of results. It must be a value obtained from the response of the previous request. The token expires after 24 hours.
", + "refs": { + "DescribeDestinationsRequest$nextToken": null, + "DescribeDestinationsResponse$nextToken": null, + "DescribeExportTasksRequest$nextToken": " A string token used for pagination that points to the next page of results. It must be a value obtained from the response of the previous DescribeExportTasks request.
A string token used for pagination that points to the next page of results. It must be a value obtained from the response of the previous DescribeLogGroups request.
A string token used for pagination that points to the next page of results. It must be a value obtained from the response of the previous DescribeLogStreams request.
A string token used for pagination that points to the next page of results. It must be a value obtained from the response of the previous DescribeMetricFilters request.
A pagination token obtained from a FilterLogEvents response to continue paginating the FilterLogEvents results. This token is omitted from the response when there are no other events to display.
A pagination token obtained from a FilterLogEvents response to continue paginating the FilterLogEvents results. This token is omitted from the response when there are no other events to display.
A string token used for pagination that points to the next page of results. It must be a value obtained from the nextForwardToken or nextBackwardToken fields in the response of the previous GetLogEvents request.
Returned if multiple requests to update the same resource were in conflict.
", + "refs": { + } + }, + "OrderBy": { + "base": null, + "refs": { + "DescribeLogStreamsRequest$orderBy": "Specifies what to order the returned log streams by. Valid arguments are 'LogStreamName' or 'LastEventTime'. If you don't specify a value, results are ordered by LogStreamName. If 'LastEventTime' is chosen, the request cannot also contain a logStreamNamePrefix.
" + } + }, + "OutputLogEvent": { + "base": null, + "refs": { + "OutputLogEvents$member": null + } + }, + "OutputLogEvents": { + "base": null, + "refs": { + "GetLogEventsResponse$events": null + } + }, + "PutDestinationPolicyRequest": { + "base": null, + "refs": { + } + }, + "PutDestinationRequest": { + "base": null, + "refs": { + } + }, + "PutDestinationResponse": { + "base": null, + "refs": { + } + }, + "PutLogEventsRequest": { + "base": null, + "refs": { + } + }, + "PutLogEventsResponse": { + "base": null, + "refs": { + } + }, + "PutMetricFilterRequest": { + "base": null, + "refs": { + } + }, + "PutRetentionPolicyRequest": { + "base": null, + "refs": { + } + }, + "PutSubscriptionFilterRequest": { + "base": null, + "refs": { + } + }, + "RejectedLogEventsInfo": { + "base": null, + "refs": { + "PutLogEventsResponse$rejectedLogEventsInfo": null + } + }, + "ResourceAlreadyExistsException": { + "base": "Returned if the specified resource already exists.
", + "refs": { + } + }, + "ResourceNotFoundException": { + "base": "Returned if the specified resource does not exist.
", + "refs": { + } + }, + "RoleArn": { + "base": null, + "refs": { + "Destination$roleArn": "A role for impersonation for delivering log events to the target.
", + "PutDestinationRequest$roleArn": "The ARN of an IAM role that grants CloudWatch Logs permissions to do Amazon Kinesis PutRecord requests on the desitnation stream.
", + "PutSubscriptionFilterRequest$roleArn": "The ARN of an IAM role that grants CloudWatch Logs permissions to deliver ingested log events to the destination stream. You don't need to provide the ARN when you are working with a logical destination (used via an ARN of Destination) for cross-account delivery.
An object indicating the search status of a log stream in a FilterLogEvents request.
A list of SearchedLogStream objects indicating the search status for log streams in a FilterLogEvents request.
A list of SearchedLogStream objects indicating which log streams have been searched in this request and whether each has been searched completely or still has more to be paginated.
A string token used for making PutLogEvents requests. A sequenceToken can only be used once, and PutLogEvents requests must include the sequenceToken obtained from the response of the previous request.
A string token that must be obtained from the response of the previous PutLogEvents request.
Returned if the service cannot complete the request.
", + "refs": { + } + }, + "StartFromHead": { + "base": null, + "refs": { + "GetLogEventsRequest$startFromHead": "If set to true, the earliest log events would be returned first. The default is false (the latest log events are returned first).
" + } + }, + "StoredBytes": { + "base": null, + "refs": { + "LogGroup$storedBytes": null, + "LogStream$storedBytes": null + } + }, + "SubscriptionFilter": { + "base": null, + "refs": { + "SubscriptionFilters$member": null + } + }, + "SubscriptionFilters": { + "base": null, + "refs": { + "DescribeSubscriptionFiltersResponse$subscriptionFilters": null + } + }, + "TargetArn": { + "base": null, + "refs": { + "Destination$targetArn": "ARN of the physical target where the log events will be delivered (eg. ARN of a Kinesis stream).
", + "PutDestinationRequest$targetArn": "The ARN of an Amazon Kinesis stream to deliver matching log events to.
" + } + }, + "TestEventMessages": { + "base": null, + "refs": { + "TestMetricFilterRequest$logEventMessages": "A list of log event messages to test.
" + } + }, + "TestMetricFilterRequest": { + "base": null, + "refs": { + } + }, + "TestMetricFilterResponse": { + "base": null, + "refs": { + } + }, + "Timestamp": { + "base": "A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.
", + "refs": { + "CreateExportTaskRequest$from": "A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. It indicates the start time of the range for the request. Events with a timestamp prior to this time will not be exported.
", + "CreateExportTaskRequest$to": "A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. It indicates the end time of the range for the request. Events with a timestamp later than this time will not be exported.
", + "Destination$creationTime": "A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC specifying when this destination was created.
", + "ExportTask$from": "A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. Events with a timestamp prior to this time are not exported.
", + "ExportTask$to": "A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than this time are not exported.
", + "ExportTaskExecutionInfo$creationTime": "A point in time when the export task got created.
", + "ExportTaskExecutionInfo$completionTime": "A point in time when the export task got completed.
", + "FilterLogEventsRequest$startTime": "A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. If provided, events with a timestamp prior to this time are not returned.
", + "FilterLogEventsRequest$endTime": "A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. If provided, events with a timestamp later than this time are not returned.
", + "FilteredLogEvent$timestamp": null, + "FilteredLogEvent$ingestionTime": null, + "GetLogEventsRequest$startTime": null, + "GetLogEventsRequest$endTime": null, + "InputLogEvent$timestamp": null, + "LogGroup$creationTime": null, + "LogStream$creationTime": null, + "LogStream$firstEventTimestamp": null, + "LogStream$lastEventTimestamp": null, + "LogStream$lastIngestionTime": null, + "MetricFilter$creationTime": null, + "OutputLogEvent$timestamp": null, + "OutputLogEvent$ingestionTime": null, + "SubscriptionFilter$creationTime": null + } + }, + "Token": { + "base": null, + "refs": { + "ExtractedValues$key": null + } + }, + "Value": { + "base": null, + "refs": { + "ExtractedValues$value": null + } + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/logs/2014-03-28/examples-1.json b/vendor/github.com/aws/aws-sdk-go/models/apis/logs/2014-03-28/examples-1.json new file mode 100644 index 000000000..0ea7e3b0b --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/logs/2014-03-28/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/logs/2014-03-28/paginators-1.json b/vendor/github.com/aws/aws-sdk-go/models/apis/logs/2014-03-28/paginators-1.json new file mode 100644 index 000000000..f68932415 --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/logs/2014-03-28/paginators-1.json @@ -0,0 +1,49 @@ +{ + "pagination": { + "DescribeDestinations": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "limit", + "result_key": "destinations" + }, + "DescribeLogGroups": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "limit", + "result_key": "logGroups" + }, + "DescribeLogStreams": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "limit", + "result_key": "logStreams" + }, + "DescribeMetricFilters": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "limit", + "result_key": "metricFilters" + }, + "DescribeSubscriptionFilters": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "limit", + "result_key": "subscriptionFilters" + }, + "FilterLogEvents": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "limit", + "result_key": [ + "events", + "searchedLogStreams" + ] + }, + "GetLogEvents": { + "input_token": "nextToken", + "output_token": "nextForwardToken", + "limit_key": "limit", + "result_key": "events" + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/machinelearning/2014-12-12/api-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/machinelearning/2014-12-12/api-2.json new file mode 100644 index 000000000..c8fbcdcda --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/machinelearning/2014-12-12/api-2.json @@ -0,0 +1,1947 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2014-12-12", + "endpointPrefix":"machinelearning", + "jsonVersion":"1.1", + "serviceFullName":"Amazon Machine Learning", + "signatureVersion":"v4", + "targetPrefix":"AmazonML_20141212", + "protocol":"json" + }, + "operations":{ + "AddTags":{ + "name":"AddTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddTagsInput"}, + "output":{"shape":"AddTagsOutput"}, + "errors":[ + { + "shape":"InvalidInputException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidTagException", + "exception":true + }, + { + "shape":"TagLimitExceededException", + "exception":true + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InternalServerException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "CreateBatchPrediction":{ + "name":"CreateBatchPrediction", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateBatchPredictionInput"}, + "output":{"shape":"CreateBatchPredictionOutput"}, + "errors":[ + { + "shape":"InvalidInputException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InternalServerException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + { + "shape":"IdempotentParameterMismatchException", + "error":{"httpStatusCode":400}, + "exception":true + } + ] + }, + "CreateDataSourceFromRDS":{ + "name":"CreateDataSourceFromRDS", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDataSourceFromRDSInput"}, + "output":{"shape":"CreateDataSourceFromRDSOutput"}, + "errors":[ + { + "shape":"InvalidInputException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InternalServerException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + { + "shape":"IdempotentParameterMismatchException", + "error":{"httpStatusCode":400}, + "exception":true + } + ] + }, + "CreateDataSourceFromRedshift":{ + "name":"CreateDataSourceFromRedshift", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDataSourceFromRedshiftInput"}, + "output":{"shape":"CreateDataSourceFromRedshiftOutput"}, + "errors":[ + { + "shape":"InvalidInputException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InternalServerException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + { + "shape":"IdempotentParameterMismatchException", + "error":{"httpStatusCode":400}, + "exception":true + } + ] + }, + "CreateDataSourceFromS3":{ + "name":"CreateDataSourceFromS3", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDataSourceFromS3Input"}, + "output":{"shape":"CreateDataSourceFromS3Output"}, + "errors":[ + { + "shape":"InvalidInputException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InternalServerException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + { + "shape":"IdempotentParameterMismatchException", + "error":{"httpStatusCode":400}, + "exception":true + } + ] + }, + "CreateEvaluation":{ + "name":"CreateEvaluation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateEvaluationInput"}, + "output":{"shape":"CreateEvaluationOutput"}, + "errors":[ + { + "shape":"InvalidInputException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InternalServerException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + { + "shape":"IdempotentParameterMismatchException", + "error":{"httpStatusCode":400}, + "exception":true + } + ] + }, + "CreateMLModel":{ + "name":"CreateMLModel", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateMLModelInput"}, + "output":{"shape":"CreateMLModelOutput"}, + "errors":[ + { + "shape":"InvalidInputException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InternalServerException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + { + "shape":"IdempotentParameterMismatchException", + "error":{"httpStatusCode":400}, + "exception":true + } + ] + }, + "CreateRealtimeEndpoint":{ + "name":"CreateRealtimeEndpoint", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateRealtimeEndpointInput"}, + "output":{"shape":"CreateRealtimeEndpointOutput"}, + "errors":[ + { + "shape":"InvalidInputException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InternalServerException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "DeleteBatchPrediction":{ + "name":"DeleteBatchPrediction", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteBatchPredictionInput"}, + "output":{"shape":"DeleteBatchPredictionOutput"}, + "errors":[ + { + "shape":"InvalidInputException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InternalServerException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "DeleteDataSource":{ + "name":"DeleteDataSource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDataSourceInput"}, + "output":{"shape":"DeleteDataSourceOutput"}, + "errors":[ + { + "shape":"InvalidInputException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InternalServerException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "DeleteEvaluation":{ + "name":"DeleteEvaluation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteEvaluationInput"}, + "output":{"shape":"DeleteEvaluationOutput"}, + "errors":[ + { + "shape":"InvalidInputException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InternalServerException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "DeleteMLModel":{ + "name":"DeleteMLModel", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteMLModelInput"}, + "output":{"shape":"DeleteMLModelOutput"}, + "errors":[ + { + "shape":"InvalidInputException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InternalServerException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "DeleteRealtimeEndpoint":{ + "name":"DeleteRealtimeEndpoint", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteRealtimeEndpointInput"}, + "output":{"shape":"DeleteRealtimeEndpointOutput"}, + "errors":[ + { + "shape":"InvalidInputException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InternalServerException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "DeleteTags":{ + "name":"DeleteTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteTagsInput"}, + "output":{"shape":"DeleteTagsOutput"}, + "errors":[ + { + "shape":"InvalidInputException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidTagException", + "exception":true + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InternalServerException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "DescribeBatchPredictions":{ + "name":"DescribeBatchPredictions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeBatchPredictionsInput"}, + "output":{"shape":"DescribeBatchPredictionsOutput"}, + "errors":[ + { + "shape":"InvalidInputException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InternalServerException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "DescribeDataSources":{ + "name":"DescribeDataSources", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDataSourcesInput"}, + "output":{"shape":"DescribeDataSourcesOutput"}, + "errors":[ + { + "shape":"InvalidInputException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InternalServerException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "DescribeEvaluations":{ + "name":"DescribeEvaluations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEvaluationsInput"}, + "output":{"shape":"DescribeEvaluationsOutput"}, + "errors":[ + { + "shape":"InvalidInputException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InternalServerException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "DescribeMLModels":{ + "name":"DescribeMLModels", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeMLModelsInput"}, + "output":{"shape":"DescribeMLModelsOutput"}, + "errors":[ + { + "shape":"InvalidInputException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InternalServerException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "DescribeTags":{ + "name":"DescribeTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeTagsInput"}, + "output":{"shape":"DescribeTagsOutput"}, + "errors":[ + { + "shape":"InvalidInputException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InternalServerException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "GetBatchPrediction":{ + "name":"GetBatchPrediction", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetBatchPredictionInput"}, + "output":{"shape":"GetBatchPredictionOutput"}, + "errors":[ + { + "shape":"InvalidInputException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InternalServerException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "GetDataSource":{ + "name":"GetDataSource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetDataSourceInput"}, + "output":{"shape":"GetDataSourceOutput"}, + "errors":[ + { + "shape":"InvalidInputException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InternalServerException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "GetEvaluation":{ + "name":"GetEvaluation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetEvaluationInput"}, + "output":{"shape":"GetEvaluationOutput"}, + "errors":[ + { + "shape":"InvalidInputException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InternalServerException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "GetMLModel":{ + "name":"GetMLModel", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetMLModelInput"}, + "output":{"shape":"GetMLModelOutput"}, + "errors":[ + { + "shape":"InvalidInputException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InternalServerException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "Predict":{ + "name":"Predict", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PredictInput"}, + "output":{"shape":"PredictOutput"}, + "errors":[ + { + "shape":"InvalidInputException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"LimitExceededException", + "error":{"httpStatusCode":417}, + "exception":true + }, + { + "shape":"InternalServerException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + { + "shape":"PredictorNotMountedException", + "error":{"httpStatusCode":400}, + "exception":true + } + ] + }, + "UpdateBatchPrediction":{ + "name":"UpdateBatchPrediction", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateBatchPredictionInput"}, + "output":{"shape":"UpdateBatchPredictionOutput"}, + "errors":[ + { + "shape":"InvalidInputException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InternalServerException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "UpdateDataSource":{ + "name":"UpdateDataSource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateDataSourceInput"}, + "output":{"shape":"UpdateDataSourceOutput"}, + "errors":[ + { + "shape":"InvalidInputException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InternalServerException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "UpdateEvaluation":{ + "name":"UpdateEvaluation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateEvaluationInput"}, + "output":{"shape":"UpdateEvaluationOutput"}, + "errors":[ + { + "shape":"InvalidInputException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InternalServerException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + }, + "UpdateMLModel":{ + "name":"UpdateMLModel", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateMLModelInput"}, + "output":{"shape":"UpdateMLModelOutput"}, + "errors":[ + { + "shape":"InvalidInputException", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true + }, + { + "shape":"InternalServerException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + } + ] + } + }, + "shapes":{ + "AddTagsInput":{ + "type":"structure", + "required":[ + "Tags", + "ResourceId", + "ResourceType" + ], + "members":{ + "Tags":{"shape":"TagList"}, + "ResourceId":{"shape":"EntityId"}, + "ResourceType":{"shape":"TaggableResourceType"} + } + }, + "AddTagsOutput":{ + "type":"structure", + "members":{ + "ResourceId":{"shape":"EntityId"}, + "ResourceType":{"shape":"TaggableResourceType"} + } + }, + "Algorithm":{ + "type":"string", + "enum":["sgd"] + }, + "AwsUserArn":{ + "type":"string", + "pattern":"arn:aws:iam::[0-9]+:((user/.+)|(root))" + }, + "BatchPrediction":{ + "type":"structure", + "members":{ + "BatchPredictionId":{"shape":"EntityId"}, + "MLModelId":{"shape":"EntityId"}, + "BatchPredictionDataSourceId":{"shape":"EntityId"}, + "InputDataLocationS3":{"shape":"S3Url"}, + "CreatedByIamUser":{"shape":"AwsUserArn"}, + "CreatedAt":{"shape":"EpochTime"}, + "LastUpdatedAt":{"shape":"EpochTime"}, + "Name":{"shape":"EntityName"}, + "Status":{"shape":"EntityStatus"}, + "OutputUri":{"shape":"S3Url"}, + "Message":{"shape":"Message"} + } + }, + "BatchPredictionFilterVariable":{ + "type":"string", + "enum":[ + "CreatedAt", + "LastUpdatedAt", + "Status", + "Name", + "IAMUser", + "MLModelId", + "DataSourceId", + "DataURI" + ] + }, + "BatchPredictions":{ + "type":"list", + "member":{"shape":"BatchPrediction"} + }, + "ComparatorValue":{ + "type":"string", + "max":1024, + "pattern":".*\\S.*|^$" + }, + "ComputeStatistics":{"type":"boolean"}, + "CreateBatchPredictionInput":{ + "type":"structure", + "required":[ + "BatchPredictionId", + "MLModelId", + "BatchPredictionDataSourceId", + "OutputUri" + ], + "members":{ + "BatchPredictionId":{"shape":"EntityId"}, + "BatchPredictionName":{"shape":"EntityName"}, + "MLModelId":{"shape":"EntityId"}, + "BatchPredictionDataSourceId":{"shape":"EntityId"}, + "OutputUri":{"shape":"S3Url"} + } + }, + "CreateBatchPredictionOutput":{ + "type":"structure", + "members":{ + "BatchPredictionId":{"shape":"EntityId"} + } + }, + "CreateDataSourceFromRDSInput":{ + "type":"structure", + "required":[ + "DataSourceId", + "RDSData", + "RoleARN" + ], + "members":{ + "DataSourceId":{"shape":"EntityId"}, + "DataSourceName":{"shape":"EntityName"}, + "RDSData":{"shape":"RDSDataSpec"}, + "RoleARN":{"shape":"RoleARN"}, + "ComputeStatistics":{"shape":"ComputeStatistics"} + } + }, + "CreateDataSourceFromRDSOutput":{ + "type":"structure", + "members":{ + "DataSourceId":{"shape":"EntityId"} + } + }, + "CreateDataSourceFromRedshiftInput":{ + "type":"structure", + "required":[ + "DataSourceId", + "DataSpec", + "RoleARN" + ], + "members":{ + "DataSourceId":{"shape":"EntityId"}, + "DataSourceName":{"shape":"EntityName"}, + "DataSpec":{"shape":"RedshiftDataSpec"}, + "RoleARN":{"shape":"RoleARN"}, + "ComputeStatistics":{"shape":"ComputeStatistics"} + } + }, + "CreateDataSourceFromRedshiftOutput":{ + "type":"structure", + "members":{ + "DataSourceId":{"shape":"EntityId"} + } + }, + "CreateDataSourceFromS3Input":{ + "type":"structure", + "required":[ + "DataSourceId", + "DataSpec" + ], + "members":{ + "DataSourceId":{"shape":"EntityId"}, + "DataSourceName":{"shape":"EntityName"}, + "DataSpec":{"shape":"S3DataSpec"}, + "ComputeStatistics":{"shape":"ComputeStatistics"} + } + }, + "CreateDataSourceFromS3Output":{ + "type":"structure", + "members":{ + "DataSourceId":{"shape":"EntityId"} + } + }, + "CreateEvaluationInput":{ + "type":"structure", + "required":[ + "EvaluationId", + "MLModelId", + "EvaluationDataSourceId" + ], + "members":{ + "EvaluationId":{"shape":"EntityId"}, + "EvaluationName":{"shape":"EntityName"}, + "MLModelId":{"shape":"EntityId"}, + "EvaluationDataSourceId":{"shape":"EntityId"} + } + }, + "CreateEvaluationOutput":{ + "type":"structure", + "members":{ + "EvaluationId":{"shape":"EntityId"} + } + }, + "CreateMLModelInput":{ + "type":"structure", + "required":[ + "MLModelId", + "MLModelType", + "TrainingDataSourceId" + ], + "members":{ + "MLModelId":{"shape":"EntityId"}, + "MLModelName":{"shape":"EntityName"}, + "MLModelType":{"shape":"MLModelType"}, + "Parameters":{"shape":"TrainingParameters"}, + "TrainingDataSourceId":{"shape":"EntityId"}, + "Recipe":{"shape":"Recipe"}, + "RecipeUri":{"shape":"S3Url"} + } + }, + "CreateMLModelOutput":{ + "type":"structure", + "members":{ + "MLModelId":{"shape":"EntityId"} + } + }, + "CreateRealtimeEndpointInput":{ + "type":"structure", + "required":["MLModelId"], + "members":{ + "MLModelId":{"shape":"EntityId"} + } + }, + "CreateRealtimeEndpointOutput":{ + "type":"structure", + "members":{ + "MLModelId":{"shape":"EntityId"}, + "RealtimeEndpointInfo":{"shape":"RealtimeEndpointInfo"} + } + }, + "DataRearrangement":{"type":"string"}, + "DataSchema":{ + "type":"string", + "max":131071 + }, + "DataSource":{ + "type":"structure", + "members":{ + "DataSourceId":{"shape":"EntityId"}, + "DataLocationS3":{"shape":"S3Url"}, + "DataRearrangement":{"shape":"DataRearrangement"}, + "CreatedByIamUser":{"shape":"AwsUserArn"}, + "CreatedAt":{"shape":"EpochTime"}, + "LastUpdatedAt":{"shape":"EpochTime"}, + "DataSizeInBytes":{"shape":"LongType"}, + "NumberOfFiles":{"shape":"LongType"}, + "Name":{"shape":"EntityName"}, + "Status":{"shape":"EntityStatus"}, + "Message":{"shape":"Message"}, + "RedshiftMetadata":{"shape":"RedshiftMetadata"}, + "RDSMetadata":{"shape":"RDSMetadata"}, + "RoleARN":{"shape":"RoleARN"}, + "ComputeStatistics":{"shape":"ComputeStatistics"} + } + }, + "DataSourceFilterVariable":{ + "type":"string", + "enum":[ + "CreatedAt", + "LastUpdatedAt", + "Status", + "Name", + "DataLocationS3", + "IAMUser" + ] + }, + "DataSources":{ + "type":"list", + "member":{"shape":"DataSource"} + }, + "DeleteBatchPredictionInput":{ + "type":"structure", + "required":["BatchPredictionId"], + "members":{ + "BatchPredictionId":{"shape":"EntityId"} + } + }, + "DeleteBatchPredictionOutput":{ + "type":"structure", + "members":{ + "BatchPredictionId":{"shape":"EntityId"} + } + }, + "DeleteDataSourceInput":{ + "type":"structure", + "required":["DataSourceId"], + "members":{ + "DataSourceId":{"shape":"EntityId"} + } + }, + "DeleteDataSourceOutput":{ + "type":"structure", + "members":{ + "DataSourceId":{"shape":"EntityId"} + } + }, + "DeleteEvaluationInput":{ + "type":"structure", + "required":["EvaluationId"], + "members":{ + "EvaluationId":{"shape":"EntityId"} + } + }, + "DeleteEvaluationOutput":{ + "type":"structure", + "members":{ + "EvaluationId":{"shape":"EntityId"} + } + }, + "DeleteMLModelInput":{ + "type":"structure", + "required":["MLModelId"], + "members":{ + "MLModelId":{"shape":"EntityId"} + } + }, + "DeleteMLModelOutput":{ + "type":"structure", + "members":{ + "MLModelId":{"shape":"EntityId"} + } + }, + "DeleteRealtimeEndpointInput":{ + "type":"structure", + "required":["MLModelId"], + "members":{ + "MLModelId":{"shape":"EntityId"} + } + }, + "DeleteRealtimeEndpointOutput":{ + "type":"structure", + "members":{ + "MLModelId":{"shape":"EntityId"}, + "RealtimeEndpointInfo":{"shape":"RealtimeEndpointInfo"} + } + }, + "DeleteTagsInput":{ + "type":"structure", + "required":[ + "TagKeys", + "ResourceId", + "ResourceType" + ], + "members":{ + "TagKeys":{"shape":"TagKeyList"}, + "ResourceId":{"shape":"EntityId"}, + "ResourceType":{"shape":"TaggableResourceType"} + } + }, + "DeleteTagsOutput":{ + "type":"structure", + "members":{ + "ResourceId":{"shape":"EntityId"}, + "ResourceType":{"shape":"TaggableResourceType"} + } + }, + "DescribeBatchPredictionsInput":{ + "type":"structure", + "members":{ + "FilterVariable":{"shape":"BatchPredictionFilterVariable"}, + "EQ":{"shape":"ComparatorValue"}, + "GT":{"shape":"ComparatorValue"}, + "LT":{"shape":"ComparatorValue"}, + "GE":{"shape":"ComparatorValue"}, + "LE":{"shape":"ComparatorValue"}, + "NE":{"shape":"ComparatorValue"}, + "Prefix":{"shape":"ComparatorValue"}, + "SortOrder":{"shape":"SortOrder"}, + "NextToken":{"shape":"StringType"}, + "Limit":{"shape":"PageLimit"} + } + }, + "DescribeBatchPredictionsOutput":{ + "type":"structure", + "members":{ + "Results":{"shape":"BatchPredictions"}, + "NextToken":{"shape":"StringType"} + } + }, + "DescribeDataSourcesInput":{ + "type":"structure", + "members":{ + "FilterVariable":{"shape":"DataSourceFilterVariable"}, + "EQ":{"shape":"ComparatorValue"}, + "GT":{"shape":"ComparatorValue"}, + "LT":{"shape":"ComparatorValue"}, + "GE":{"shape":"ComparatorValue"}, + "LE":{"shape":"ComparatorValue"}, + "NE":{"shape":"ComparatorValue"}, + "Prefix":{"shape":"ComparatorValue"}, + "SortOrder":{"shape":"SortOrder"}, + "NextToken":{"shape":"StringType"}, + "Limit":{"shape":"PageLimit"} + } + }, + "DescribeDataSourcesOutput":{ + "type":"structure", + "members":{ + "Results":{"shape":"DataSources"}, + "NextToken":{"shape":"StringType"} + } + }, + "DescribeEvaluationsInput":{ + "type":"structure", + "members":{ + "FilterVariable":{"shape":"EvaluationFilterVariable"}, + "EQ":{"shape":"ComparatorValue"}, + "GT":{"shape":"ComparatorValue"}, + "LT":{"shape":"ComparatorValue"}, + "GE":{"shape":"ComparatorValue"}, + "LE":{"shape":"ComparatorValue"}, + "NE":{"shape":"ComparatorValue"}, + "Prefix":{"shape":"ComparatorValue"}, + "SortOrder":{"shape":"SortOrder"}, + "NextToken":{"shape":"StringType"}, + "Limit":{"shape":"PageLimit"} + } + }, + "DescribeEvaluationsOutput":{ + "type":"structure", + "members":{ + "Results":{"shape":"Evaluations"}, + "NextToken":{"shape":"StringType"} + } + }, + "DescribeMLModelsInput":{ + "type":"structure", + "members":{ + "FilterVariable":{"shape":"MLModelFilterVariable"}, + "EQ":{"shape":"ComparatorValue"}, + "GT":{"shape":"ComparatorValue"}, + "LT":{"shape":"ComparatorValue"}, + "GE":{"shape":"ComparatorValue"}, + "LE":{"shape":"ComparatorValue"}, + "NE":{"shape":"ComparatorValue"}, + "Prefix":{"shape":"ComparatorValue"}, + "SortOrder":{"shape":"SortOrder"}, + "NextToken":{"shape":"StringType"}, + "Limit":{"shape":"PageLimit"} + } + }, + "DescribeMLModelsOutput":{ + "type":"structure", + "members":{ + "Results":{"shape":"MLModels"}, + "NextToken":{"shape":"StringType"} + } + }, + "DescribeTagsInput":{ + "type":"structure", + "required":[ + "ResourceId", + "ResourceType" + ], + "members":{ + "ResourceId":{"shape":"EntityId"}, + "ResourceType":{"shape":"TaggableResourceType"} + } + }, + "DescribeTagsOutput":{ + "type":"structure", + "members":{ + "ResourceId":{"shape":"EntityId"}, + "ResourceType":{"shape":"TaggableResourceType"}, + "Tags":{"shape":"TagList"} + } + }, + "DetailsAttributes":{ + "type":"string", + "enum":[ + "PredictiveModelType", + "Algorithm" + ] + }, + "DetailsMap":{ + "type":"map", + "key":{"shape":"DetailsAttributes"}, + "value":{"shape":"DetailsValue"} + }, + "DetailsValue":{ + "type":"string", + "min":1 + }, + "EDPPipelineId":{ + "type":"string", + "min":1, + "max":1024 + }, + "EDPResourceRole":{ + "type":"string", + "min":1, + "max":64 + }, + "EDPSecurityGroupId":{ + "type":"string", + "min":1, + "max":255 + }, + "EDPSecurityGroupIds":{ + "type":"list", + "member":{"shape":"EDPSecurityGroupId"} + }, + "EDPServiceRole":{ + "type":"string", + "min":1, + "max":64 + }, + "EDPSubnetId":{ + "type":"string", + "min":1, + "max":255 + }, + "EntityId":{ + "type":"string", + "min":1, + "max":64, + "pattern":"[a-zA-Z0-9_.-]+" + }, + "EntityName":{ + "type":"string", + "max":1024, + "pattern":".*\\S.*|^$" + }, + "EntityStatus":{ + "type":"string", + "enum":[ + "PENDING", + "INPROGRESS", + "FAILED", + "COMPLETED", + "DELETED" + ] + }, + "EpochTime":{"type":"timestamp"}, + "ErrorCode":{"type":"integer"}, + "ErrorMessage":{ + "type":"string", + "max":2048 + }, + "Evaluation":{ + "type":"structure", + "members":{ + "EvaluationId":{"shape":"EntityId"}, + "MLModelId":{"shape":"EntityId"}, + "EvaluationDataSourceId":{"shape":"EntityId"}, + "InputDataLocationS3":{"shape":"S3Url"}, + "CreatedByIamUser":{"shape":"AwsUserArn"}, + "CreatedAt":{"shape":"EpochTime"}, + "LastUpdatedAt":{"shape":"EpochTime"}, + "Name":{"shape":"EntityName"}, + "Status":{"shape":"EntityStatus"}, + "PerformanceMetrics":{"shape":"PerformanceMetrics"}, + "Message":{"shape":"Message"} + } + }, + "EvaluationFilterVariable":{ + "type":"string", + "enum":[ + "CreatedAt", + "LastUpdatedAt", + "Status", + "Name", + "IAMUser", + "MLModelId", + "DataSourceId", + "DataURI" + ] + }, + "Evaluations":{ + "type":"list", + "member":{"shape":"Evaluation"} + }, + "GetBatchPredictionInput":{ + "type":"structure", + "required":["BatchPredictionId"], + "members":{ + "BatchPredictionId":{"shape":"EntityId"} + } + }, + "GetBatchPredictionOutput":{ + "type":"structure", + "members":{ + "BatchPredictionId":{"shape":"EntityId"}, + "MLModelId":{"shape":"EntityId"}, + "BatchPredictionDataSourceId":{"shape":"EntityId"}, + "InputDataLocationS3":{"shape":"S3Url"}, + "CreatedByIamUser":{"shape":"AwsUserArn"}, + "CreatedAt":{"shape":"EpochTime"}, + "LastUpdatedAt":{"shape":"EpochTime"}, + "Name":{"shape":"EntityName"}, + "Status":{"shape":"EntityStatus"}, + "OutputUri":{"shape":"S3Url"}, + "LogUri":{"shape":"PresignedS3Url"}, + "Message":{"shape":"Message"} + } + }, + "GetDataSourceInput":{ + "type":"structure", + "required":["DataSourceId"], + "members":{ + "DataSourceId":{"shape":"EntityId"}, + "Verbose":{"shape":"Verbose"} + } + }, + "GetDataSourceOutput":{ + "type":"structure", + "members":{ + "DataSourceId":{"shape":"EntityId"}, + "DataLocationS3":{"shape":"S3Url"}, + "DataRearrangement":{"shape":"DataRearrangement"}, + "CreatedByIamUser":{"shape":"AwsUserArn"}, + "CreatedAt":{"shape":"EpochTime"}, + "LastUpdatedAt":{"shape":"EpochTime"}, + "DataSizeInBytes":{"shape":"LongType"}, + "NumberOfFiles":{"shape":"LongType"}, + "Name":{"shape":"EntityName"}, + "Status":{"shape":"EntityStatus"}, + "LogUri":{"shape":"PresignedS3Url"}, + "Message":{"shape":"Message"}, + "RedshiftMetadata":{"shape":"RedshiftMetadata"}, + "RDSMetadata":{"shape":"RDSMetadata"}, + "RoleARN":{"shape":"RoleARN"}, + "ComputeStatistics":{"shape":"ComputeStatistics"}, + "DataSourceSchema":{"shape":"DataSchema"} + } + }, + "GetEvaluationInput":{ + "type":"structure", + "required":["EvaluationId"], + "members":{ + "EvaluationId":{"shape":"EntityId"} + } + }, + "GetEvaluationOutput":{ + "type":"structure", + "members":{ + "EvaluationId":{"shape":"EntityId"}, + "MLModelId":{"shape":"EntityId"}, + "EvaluationDataSourceId":{"shape":"EntityId"}, + "InputDataLocationS3":{"shape":"S3Url"}, + "CreatedByIamUser":{"shape":"AwsUserArn"}, + "CreatedAt":{"shape":"EpochTime"}, + "LastUpdatedAt":{"shape":"EpochTime"}, + "Name":{"shape":"EntityName"}, + "Status":{"shape":"EntityStatus"}, + "PerformanceMetrics":{"shape":"PerformanceMetrics"}, + "LogUri":{"shape":"PresignedS3Url"}, + "Message":{"shape":"Message"} + } + }, + "GetMLModelInput":{ + "type":"structure", + "required":["MLModelId"], + "members":{ + "MLModelId":{"shape":"EntityId"}, + "Verbose":{"shape":"Verbose"} + } + }, + "GetMLModelOutput":{ + "type":"structure", + "members":{ + "MLModelId":{"shape":"EntityId"}, + "TrainingDataSourceId":{"shape":"EntityId"}, + "CreatedByIamUser":{"shape":"AwsUserArn"}, + "CreatedAt":{"shape":"EpochTime"}, + "LastUpdatedAt":{"shape":"EpochTime"}, + "Name":{"shape":"MLModelName"}, + "Status":{"shape":"EntityStatus"}, + "SizeInBytes":{"shape":"LongType"}, + "EndpointInfo":{"shape":"RealtimeEndpointInfo"}, + "TrainingParameters":{"shape":"TrainingParameters"}, + "InputDataLocationS3":{"shape":"S3Url"}, + "MLModelType":{"shape":"MLModelType"}, + "ScoreThreshold":{"shape":"ScoreThreshold"}, + "ScoreThresholdLastUpdatedAt":{"shape":"EpochTime"}, + "LogUri":{"shape":"PresignedS3Url"}, + "Message":{"shape":"Message"}, + "Recipe":{"shape":"Recipe"}, + "Schema":{"shape":"DataSchema"} + } + }, + "IdempotentParameterMismatchException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"}, + "code":{"shape":"ErrorCode"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "IntegerType":{"type":"integer"}, + "InternalServerException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"}, + "code":{"shape":"ErrorCode"} + }, + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + "InvalidInputException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"}, + "code":{"shape":"ErrorCode"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidTagException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true + }, + "Label":{ + "type":"string", + "min":1 + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"}, + "code":{"shape":"ErrorCode"} + }, + "error":{"httpStatusCode":417}, + "exception":true + }, + "LongType":{"type":"long"}, + "MLModel":{ + "type":"structure", + "members":{ + "MLModelId":{"shape":"EntityId"}, + "TrainingDataSourceId":{"shape":"EntityId"}, + "CreatedByIamUser":{"shape":"AwsUserArn"}, + "CreatedAt":{"shape":"EpochTime"}, + "LastUpdatedAt":{"shape":"EpochTime"}, + "Name":{"shape":"MLModelName"}, + "Status":{"shape":"EntityStatus"}, + "SizeInBytes":{"shape":"LongType"}, + "EndpointInfo":{"shape":"RealtimeEndpointInfo"}, + "TrainingParameters":{"shape":"TrainingParameters"}, + "InputDataLocationS3":{"shape":"S3Url"}, + "Algorithm":{"shape":"Algorithm"}, + "MLModelType":{"shape":"MLModelType"}, + "ScoreThreshold":{"shape":"ScoreThreshold"}, + "ScoreThresholdLastUpdatedAt":{"shape":"EpochTime"}, + "Message":{"shape":"Message"} + } + }, + "MLModelFilterVariable":{ + "type":"string", + "enum":[ + "CreatedAt", + "LastUpdatedAt", + "Status", + "Name", + "IAMUser", + "TrainingDataSourceId", + "RealtimeEndpointStatus", + "MLModelType", + "Algorithm", + "TrainingDataURI" + ] + }, + "MLModelName":{ + "type":"string", + "max":1024 + }, + "MLModelType":{ + "type":"string", + "enum":[ + "REGRESSION", + "BINARY", + "MULTICLASS" + ] + }, + "MLModels":{ + "type":"list", + "member":{"shape":"MLModel"} + }, + "Message":{ + "type":"string", + "max":10240 + }, + "PageLimit":{ + "type":"integer", + "min":1, + "max":100 + }, + "PerformanceMetrics":{ + "type":"structure", + "members":{ + "Properties":{"shape":"PerformanceMetricsProperties"} + } + }, + "PerformanceMetricsProperties":{ + "type":"map", + "key":{"shape":"PerformanceMetricsPropertyKey"}, + "value":{"shape":"PerformanceMetricsPropertyValue"} + }, + "PerformanceMetricsPropertyKey":{"type":"string"}, + "PerformanceMetricsPropertyValue":{"type":"string"}, + "PredictInput":{ + "type":"structure", + "required":[ + "MLModelId", + "Record", + "PredictEndpoint" + ], + "members":{ + "MLModelId":{"shape":"EntityId"}, + "Record":{"shape":"Record"}, + "PredictEndpoint":{"shape":"VipURL"} + } + }, + "PredictOutput":{ + "type":"structure", + "members":{ + "Prediction":{"shape":"Prediction"} + } + }, + "Prediction":{ + "type":"structure", + "members":{ + "predictedLabel":{"shape":"Label"}, + "predictedValue":{"shape":"floatLabel"}, + "predictedScores":{"shape":"ScoreValuePerLabelMap"}, + "details":{"shape":"DetailsMap"} + } + }, + "PredictorNotMountedException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "PresignedS3Url":{"type":"string"}, + "RDSDataSpec":{ + "type":"structure", + "required":[ + "DatabaseInformation", + "SelectSqlQuery", + "DatabaseCredentials", + "S3StagingLocation", + "ResourceRole", + "ServiceRole", + "SubnetId", + "SecurityGroupIds" + ], + "members":{ + "DatabaseInformation":{"shape":"RDSDatabase"}, + "SelectSqlQuery":{"shape":"RDSSelectSqlQuery"}, + "DatabaseCredentials":{"shape":"RDSDatabaseCredentials"}, + "S3StagingLocation":{"shape":"S3Url"}, + "DataRearrangement":{"shape":"DataRearrangement"}, + "DataSchema":{"shape":"DataSchema"}, + "DataSchemaUri":{"shape":"S3Url"}, + "ResourceRole":{"shape":"EDPResourceRole"}, + "ServiceRole":{"shape":"EDPServiceRole"}, + "SubnetId":{"shape":"EDPSubnetId"}, + "SecurityGroupIds":{"shape":"EDPSecurityGroupIds"} + } + }, + "RDSDatabase":{ + "type":"structure", + "required":[ + "InstanceIdentifier", + "DatabaseName" + ], + "members":{ + "InstanceIdentifier":{"shape":"RDSInstanceIdentifier"}, + "DatabaseName":{"shape":"RDSDatabaseName"} + } + }, + "RDSDatabaseCredentials":{ + "type":"structure", + "required":[ + "Username", + "Password" + ], + "members":{ + "Username":{"shape":"RDSDatabaseUsername"}, + "Password":{"shape":"RDSDatabasePassword"} + } + }, + "RDSDatabaseName":{ + "type":"string", + "min":1, + "max":64 + }, + "RDSDatabasePassword":{ + "type":"string", + "min":8, + "max":128 + }, + "RDSDatabaseUsername":{ + "type":"string", + "min":1, + "max":128 + }, + "RDSInstanceIdentifier":{ + "type":"string", + "min":1, + "max":63, + "pattern":"[a-z0-9-]+" + }, + "RDSMetadata":{ + "type":"structure", + "members":{ + "Database":{"shape":"RDSDatabase"}, + "DatabaseUserName":{"shape":"RDSDatabaseUsername"}, + "SelectSqlQuery":{"shape":"RDSSelectSqlQuery"}, + "ResourceRole":{"shape":"EDPResourceRole"}, + "ServiceRole":{"shape":"EDPServiceRole"}, + "DataPipelineId":{"shape":"EDPPipelineId"} + } + }, + "RDSSelectSqlQuery":{ + "type":"string", + "min":1, + "max":16777216 + }, + "RealtimeEndpointInfo":{ + "type":"structure", + "members":{ + "PeakRequestsPerSecond":{"shape":"IntegerType"}, + "CreatedAt":{"shape":"EpochTime"}, + "EndpointUrl":{"shape":"VipURL"}, + "EndpointStatus":{"shape":"RealtimeEndpointStatus"} + } + }, + "RealtimeEndpointStatus":{ + "type":"string", + "enum":[ + "NONE", + "READY", + "UPDATING", + "FAILED" + ] + }, + "Recipe":{ + "type":"string", + "max":131071 + }, + "Record":{ + "type":"map", + "key":{"shape":"VariableName"}, + "value":{"shape":"VariableValue"} + }, + "RedshiftClusterIdentifier":{ + "type":"string", + "min":1, + "max":63, + "pattern":"[a-z0-9-]+" + }, + "RedshiftDataSpec":{ + "type":"structure", + "required":[ + "DatabaseInformation", + "SelectSqlQuery", + "DatabaseCredentials", + "S3StagingLocation" + ], + "members":{ + "DatabaseInformation":{"shape":"RedshiftDatabase"}, + "SelectSqlQuery":{"shape":"RedshiftSelectSqlQuery"}, + "DatabaseCredentials":{"shape":"RedshiftDatabaseCredentials"}, + "S3StagingLocation":{"shape":"S3Url"}, + "DataRearrangement":{"shape":"DataRearrangement"}, + "DataSchema":{"shape":"DataSchema"}, + "DataSchemaUri":{"shape":"S3Url"} + } + }, + "RedshiftDatabase":{ + "type":"structure", + "required":[ + "DatabaseName", + "ClusterIdentifier" + ], + "members":{ + "DatabaseName":{"shape":"RedshiftDatabaseName"}, + "ClusterIdentifier":{"shape":"RedshiftClusterIdentifier"} + } + }, + "RedshiftDatabaseCredentials":{ + "type":"structure", + "required":[ + "Username", + "Password" + ], + "members":{ + "Username":{"shape":"RedshiftDatabaseUsername"}, + "Password":{"shape":"RedshiftDatabasePassword"} + } + }, + "RedshiftDatabaseName":{ + "type":"string", + "min":1, + "max":64, + "pattern":"[a-z0-9]+" + }, + "RedshiftDatabasePassword":{ + "type":"string", + "min":8, + "max":64 + }, + "RedshiftDatabaseUsername":{ + "type":"string", + "min":1, + "max":128 + }, + "RedshiftMetadata":{ + "type":"structure", + "members":{ + "RedshiftDatabase":{"shape":"RedshiftDatabase"}, + "DatabaseUserName":{"shape":"RedshiftDatabaseUsername"}, + "SelectSqlQuery":{"shape":"RedshiftSelectSqlQuery"} + } + }, + "RedshiftSelectSqlQuery":{ + "type":"string", + "min":1, + "max":16777216 + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"}, + "code":{"shape":"ErrorCode"} + }, + "error":{"httpStatusCode":404}, + "exception":true + }, + "RoleARN":{ + "type":"string", + "min":1, + "max":110 + }, + "S3DataSpec":{ + "type":"structure", + "required":["DataLocationS3"], + "members":{ + "DataLocationS3":{"shape":"S3Url"}, + "DataRearrangement":{"shape":"DataRearrangement"}, + "DataSchema":{"shape":"DataSchema"}, + "DataSchemaLocationS3":{"shape":"S3Url"} + } + }, + "S3Url":{ + "type":"string", + "max":2048, + "pattern":"s3://([^/]+)(/.*)?" + }, + "ScoreThreshold":{"type":"float"}, + "ScoreValue":{"type":"float"}, + "ScoreValuePerLabelMap":{ + "type":"map", + "key":{"shape":"Label"}, + "value":{"shape":"ScoreValue"} + }, + "SortOrder":{ + "type":"string", + "enum":[ + "asc", + "dsc" + ] + }, + "StringType":{"type":"string"}, + "Tag":{ + "type":"structure", + "members":{ + "Key":{"shape":"TagKey"}, + "Value":{"shape":"TagValue"} + } + }, + "TagKey":{ + "type":"string", + "min":1, + "max":128, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"} + }, + "TagLimitExceededException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"} + }, + "TagValue":{ + "type":"string", + "min":0, + "max":256, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "TaggableResourceType":{ + "type":"string", + "enum":[ + "BatchPrediction", + "DataSource", + "Evaluation", + "MLModel" + ] + }, + "TrainingParameters":{ + "type":"map", + "key":{"shape":"StringType"}, + "value":{"shape":"StringType"} + }, + "UpdateBatchPredictionInput":{ + "type":"structure", + "required":[ + "BatchPredictionId", + "BatchPredictionName" + ], + "members":{ + "BatchPredictionId":{"shape":"EntityId"}, + "BatchPredictionName":{"shape":"EntityName"} + } + }, + "UpdateBatchPredictionOutput":{ + "type":"structure", + "members":{ + "BatchPredictionId":{"shape":"EntityId"} + } + }, + "UpdateDataSourceInput":{ + "type":"structure", + "required":[ + "DataSourceId", + "DataSourceName" + ], + "members":{ + "DataSourceId":{"shape":"EntityId"}, + "DataSourceName":{"shape":"EntityName"} + } + }, + "UpdateDataSourceOutput":{ + "type":"structure", + "members":{ + "DataSourceId":{"shape":"EntityId"} + } + }, + "UpdateEvaluationInput":{ + "type":"structure", + "required":[ + "EvaluationId", + "EvaluationName" + ], + "members":{ + "EvaluationId":{"shape":"EntityId"}, + "EvaluationName":{"shape":"EntityName"} + } + }, + "UpdateEvaluationOutput":{ + "type":"structure", + "members":{ + "EvaluationId":{"shape":"EntityId"} + } + }, + "UpdateMLModelInput":{ + "type":"structure", + "required":["MLModelId"], + "members":{ + "MLModelId":{"shape":"EntityId"}, + "MLModelName":{"shape":"EntityName"}, + "ScoreThreshold":{"shape":"ScoreThreshold"} + } + }, + "UpdateMLModelOutput":{ + "type":"structure", + "members":{ + "MLModelId":{"shape":"EntityId"} + } + }, + "VariableName":{"type":"string"}, + "VariableValue":{"type":"string"}, + "Verbose":{"type":"boolean"}, + "VipURL":{ + "type":"string", + "max":2048, + "pattern":"https://[a-zA-Z0-9-.]*\\.amazon(aws)?\\.com[/]?" + }, + "floatLabel":{"type":"float"} + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/machinelearning/2014-12-12/docs-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/machinelearning/2014-12-12/docs-2.json new file mode 100644 index 000000000..7f7035e7b --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/machinelearning/2014-12-12/docs-2.json @@ -0,0 +1,1128 @@ +{ + "version": "2.0", + "operations": { + "AddTags": "Adds one or more tags to an object, up to a limit of 10. Each tag consists of a key and an optional value. If you add a tag using a key that is already associated with the ML object, AddTags updates the tag's value.
Generates predictions for a group of observations. The observations to process exist in one or more data files referenced by a DataSource. This operation creates a new BatchPrediction, and uses an MLModel and the data files referenced by the DataSource as information sources.
CreateBatchPrediction is an asynchronous operation. In response to CreateBatchPrediction, Amazon Machine Learning (Amazon ML) immediately returns and sets the BatchPrediction status to PENDING. After the BatchPrediction completes, Amazon ML sets the status to COMPLETED.
You can poll for status updates by using the GetBatchPrediction operation and checking the Status parameter of the result. After the COMPLETED status appears, the results are available in the location specified by the OutputUri parameter.
Creates a DataSource object from an Amazon Relational Database Service (Amazon RDS). A DataSource references data that can be used to perform CreateMLModel, CreateEvaluation, or CreateBatchPrediction operations.
CreateDataSourceFromRDS is an asynchronous operation. In response to CreateDataSourceFromRDS, Amazon Machine Learning (Amazon ML) immediately returns and sets the DataSource status to PENDING. After the DataSource is created and ready for use, Amazon ML sets the Status parameter to COMPLETED. DataSource in the COMPLETED or PENDING state can be used only to perform >CreateMLModel>, CreateEvaluation, or CreateBatchPrediction operations.
If Amazon ML cannot accept the input source, it sets the Status parameter to FAILED and includes an error message in the Message attribute of the GetDataSource operation response.
Creates a DataSource from a database hosted on an Amazon Redshift cluster. A DataSource references data that can be used to perform either CreateMLModel, CreateEvaluation, or CreateBatchPrediction operations.
CreateDataSourceFromRedshift is an asynchronous operation. In response to CreateDataSourceFromRedshift, Amazon Machine Learning (Amazon ML) immediately returns and sets the DataSource status to PENDING. After the DataSource is created and ready for use, Amazon ML sets the Status parameter to COMPLETED. DataSource in COMPLETED or PENDING states can be used to perform only CreateMLModel, CreateEvaluation, or CreateBatchPrediction operations.
If Amazon ML can't accept the input source, it sets the Status parameter to FAILED and includes an error message in the Message attribute of the GetDataSource operation response.
The observations should be contained in the database hosted on an Amazon Redshift cluster and should be specified by a SelectSqlQuery query. Amazon ML executes an Unload command in Amazon Redshift to transfer the result set of the SelectSqlQuery query to S3StagingLocation.
After the DataSource has been created, it's ready for use in evaluations and batch predictions. If you plan to use the DataSource to train an MLModel, the DataSource also requires a recipe. A recipe describes how each input variable will be used in training an MLModel. Will the variable be included or excluded from training? Will the variable be manipulated; for example, will it be combined with another variable or will it be split apart into word combinations? The recipe provides answers to these questions.
You can't change an existing datasource, but you can copy and modify the settings from an existing Amazon Redshift datasource to create a new datasource. To do so, call GetDataSource for an existing datasource and copy the values to a CreateDataSource call. Change the settings that you want to change and make sure that all required fields have the appropriate values.
Creates a DataSource object. A DataSource references data that can be used to perform CreateMLModel, CreateEvaluation, or CreateBatchPrediction operations.
CreateDataSourceFromS3 is an asynchronous operation. In response to CreateDataSourceFromS3, Amazon Machine Learning (Amazon ML) immediately returns and sets the DataSource status to PENDING. After the DataSource has been created and is ready for use, Amazon ML sets the Status parameter to COMPLETED. DataSource in the COMPLETED or PENDING state can be used to perform only CreateMLModel, CreateEvaluation or CreateBatchPrediction operations.
If Amazon ML can't accept the input source, it sets the Status parameter to FAILED and includes an error message in the Message attribute of the GetDataSource operation response.
The observation data used in a DataSource should be ready to use; that is, it should have a consistent structure, and missing data values should be kept to a minimum. The observation data must reside in one or more .csv files in an Amazon Simple Storage Service (Amazon S3) location, along with a schema that describes the data items by name and type. The same schema must be used for all of the data files referenced by the DataSource.
After the DataSource has been created, it's ready to use in evaluations and batch predictions. If you plan to use the DataSource to train an MLModel, the DataSource also needs a recipe. A recipe describes how each input variable will be used in training an MLModel. Will the variable be included or excluded from training? Will the variable be manipulated; for example, will it be combined with another variable or will it be split apart into word combinations? The recipe provides answers to these questions.
Creates a new Evaluation of an MLModel. An MLModel is evaluated on a set of observations associated to a DataSource. Like a DataSource for an MLModel, the DataSource for an Evaluation contains values for the Target Variable. The Evaluation compares the predicted result for each observation to the actual outcome and provides a summary so that you know how effective the MLModel functions on the test data. Evaluation generates a relevant performance metric, such as BinaryAUC, RegressionRMSE or MulticlassAvgFScore based on the corresponding MLModelType: BINARY, REGRESSION or MULTICLASS.
CreateEvaluation is an asynchronous operation. In response to CreateEvaluation, Amazon Machine Learning (Amazon ML) immediately returns and sets the evaluation status to PENDING. After the Evaluation is created and ready for use, Amazon ML sets the status to COMPLETED.
You can use the GetEvaluation operation to check progress of the evaluation during the creation operation.
Creates a new MLModel using the DataSource and the recipe as information sources.
An MLModel is nearly immutable. Users can update only the MLModelName and the ScoreThreshold in an MLModel without creating a new MLModel.
CreateMLModel is an asynchronous operation. In response to CreateMLModel, Amazon Machine Learning (Amazon ML) immediately returns and sets the MLModel status to PENDING. After the MLModel has been created and ready is for use, Amazon ML sets the status to COMPLETED.
You can use the GetMLModel operation to check the progress of the MLModel during the creation operation.
CreateMLModel requires a DataSource with computed statistics, which can be created by setting ComputeStatistics to true in CreateDataSourcceFromRDS, CreateDataSourceFromS3, or CreateDataSourceFromRedshift operations.
Creates a real-time endpoint for the MLModel. The endpoint contains the URI of the MLModel; that is, the location to send real-time prediction requests for the specified MLModel.
Assigns the DELETED status to a BatchPrediction, rendering it unusable.
After using the DeleteBatchPrediction operation, you can use the GetBatchPrediction operation to verify that the status of the BatchPrediction changed to DELETED.
Caution: The result of the DeleteBatchPrediction operation is irreversible.
Assigns the DELETED status to a DataSource, rendering it unusable.
After using the DeleteDataSource operation, you can use the GetDataSource operation to verify that the status of the DataSource changed to DELETED.
Caution: The results of the DeleteDataSource operation are irreversible.
Assigns the DELETED status to an Evaluation, rendering it unusable.
After invoking the DeleteEvaluation operation, you can use the GetEvaluation operation to verify that the status of the Evaluation changed to DELETED.
The results of the DeleteEvaluation operation are irreversible.
Assigns the DELETED status to an MLModel, rendering it unusable.
After using the DeleteMLModel operation, you can use the GetMLModel operation to verify that the status of the MLModel changed to DELETED.
Caution: The result of the DeleteMLModel operation is irreversible.
Deletes a real time endpoint of an MLModel.
Deletes the specified tags associated with an ML object. After this operation is complete, you can't recover deleted tags.
If you specify a tag that doesn't exist, Amazon ML ignores it.
", + "DescribeBatchPredictions": "Returns a list of BatchPrediction operations that match the search criteria in the request.
Returns a list of DataSource that match the search criteria in the request.
Returns a list of DescribeEvaluations that match the search criteria in the request.
Returns a list of MLModel that match the search criteria in the request.
Describes one or more of the tags for your Amazon ML object.
", + "GetBatchPrediction": "Returns a BatchPrediction that includes detailed metadata, status, and data file information for a Batch Prediction request.
Returns a DataSource that includes metadata and data file information, as well as the current status of the DataSource.
GetDataSource provides results in normal or verbose format. The verbose format adds the schema description and the list of files pointed to by the DataSource to the normal format.
Returns an Evaluation that includes metadata as well as the current status of the Evaluation.
Returns an MLModel that includes detailed metadata, data source information, and the current status of the MLModel.
GetMLModel provides results in normal or verbose format.
Generates a prediction for the observation using the specified ML Model.
Not all response parameters will be populated. Whether a response parameter is populated depends on the type of model requested.
Updates the BatchPredictionName of a BatchPrediction.
You can use the GetBatchPrediction operation to view the contents of the updated data element.
Updates the DataSourceName of a DataSource.
You can use the GetDataSource operation to view the contents of the updated data element.
Updates the EvaluationName of an Evaluation.
You can use the GetEvaluation operation to view the contents of the updated data element.
Updates the MLModelName and the ScoreThreshold of an MLModel.
You can use the GetMLModel operation to view the contents of the updated data element.
Amazon ML returns the following elements.
", + "refs": { + } + }, + "Algorithm": { + "base": "The function used to train an MLModel. Training choices supported by Amazon ML include the following:
SGD - Stochastic Gradient Descent.RandomForest - Random forest of decision trees.The algorithm used to train the MLModel. The following algorithm is supported:
SGD -- Stochastic gradient descent. The goal of SGD is to minimize the gradient of the loss function. An Amazon Web Service (AWS) user account identifier. The account identifier can be an AWS root account or an AWS Identity and Access Management (IAM) user.
", + "refs": { + "BatchPrediction$CreatedByIamUser": "The AWS user account that invoked the BatchPrediction. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.
The AWS user account from which the DataSource was created. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.
The AWS user account that invoked the evaluation. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.
", + "GetBatchPredictionOutput$CreatedByIamUser": "The AWS user account that invoked the BatchPrediction. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.
The AWS user account from which the DataSource was created. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.
The AWS user account that invoked the evaluation. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.
", + "GetMLModelOutput$CreatedByIamUser": "The AWS user account from which the MLModel was created. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.
The AWS user account from which the MLModel was created. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.
Represents the output of a GetBatchPrediction operation.
The content consists of the detailed metadata, the status, and the data file information of a Batch Prediction.
A list of the variables to use in searching or filtering BatchPrediction.
CreatedAt - Sets the search criteria to BatchPrediction creation date.Status - Sets the search criteria to BatchPrediction status.Name - Sets the search criteria to the contents of BatchPrediction Name.IAMUser - Sets the search criteria to the user account that invoked the BatchPrediction creation.MLModelId - Sets the search criteria to the MLModel used in the BatchPrediction.DataSourceId - Sets the search criteria to the DataSource used in the BatchPrediction.DataURI - Sets the search criteria to the data file(s) used in the BatchPrediction. The URL can identify either a file or an Amazon Simple Storage Service (Amazon S3) bucket or directory.Use one of the following variables to filter a list of BatchPrediction:
CreatedAt - Sets the search criteria to the BatchPrediction creation date.Status - Sets the search criteria to the BatchPrediction status.Name - Sets the search criteria to the contents of the BatchPrediction Name.IAMUser - Sets the search criteria to the user account that invoked the BatchPrediction creation.MLModelId - Sets the search criteria to the MLModel used in the BatchPrediction.DataSourceId - Sets the search criteria to the DataSource used in the BatchPrediction.DataURI - Sets the search criteria to the data file(s) used in the BatchPrediction. The URL can identify either a file or an Amazon Simple Storage Solution (Amazon S3) bucket or directory.A list of BatchPrediction objects that meet the search criteria.
The value specified in a filtering condition. The ComparatorValue becomes the reference value when matching or evaluating data values in filtering and searching functions.
The equal to operator. The BatchPrediction results will have FilterVariable values that exactly match the value specified with EQ.
The greater than operator. The BatchPrediction results will have FilterVariable values that are greater than the value specified with GT.
The less than operator. The BatchPrediction results will have FilterVariable values that are less than the value specified with LT.
The greater than or equal to operator. The BatchPrediction results will have FilterVariable values that are greater than or equal to the value specified with GE.
The less than or equal to operator. The BatchPrediction results will have FilterVariable values that are less than or equal to the value specified with LE.
The not equal to operator. The BatchPrediction results will have FilterVariable values not equal to the value specified with NE.
A string that is found at the beginning of a variable, such as Name or Id.
For example, a Batch Prediction operation could have the Name 2014-09-09-HolidayGiftMailer. To search for this BatchPrediction, select Name for the FilterVariable and any of the following strings for the Prefix:
2014-09
2014-09-09
2014-09-09-Holiday
The equal to operator. The DataSource results will have FilterVariable values that exactly match the value specified with EQ.
The greater than operator. The DataSource results will have FilterVariable values that are greater than the value specified with GT.
The less than operator. The DataSource results will have FilterVariable values that are less than the value specified with LT.
The greater than or equal to operator. The DataSource results will have FilterVariable values that are greater than or equal to the value specified with GE.
The less than or equal to operator. The DataSource results will have FilterVariable values that are less than or equal to the value specified with LE.
The not equal to operator. The DataSource results will have FilterVariable values not equal to the value specified with NE.
A string that is found at the beginning of a variable, such as Name or Id.
For example, a DataSource could have the Name 2014-09-09-HolidayGiftMailer. To search for this DataSource, select Name for the FilterVariable and any of the following strings for the Prefix:
2014-09
2014-09-09
2014-09-09-Holiday
The equal to operator. The Evaluation results will have FilterVariable values that exactly match the value specified with EQ.
The greater than operator. The Evaluation results will have FilterVariable values that are greater than the value specified with GT.
The less than operator. The Evaluation results will have FilterVariable values that are less than the value specified with LT.
The greater than or equal to operator. The Evaluation results will have FilterVariable values that are greater than or equal to the value specified with GE.
The less than or equal to operator. The Evaluation results will have FilterVariable values that are less than or equal to the value specified with LE.
The not equal to operator. The Evaluation results will have FilterVariable values not equal to the value specified with NE.
A string that is found at the beginning of a variable, such as Name or Id.
For example, an Evaluation could have the Name 2014-09-09-HolidayGiftMailer. To search for this Evaluation, select Name for the FilterVariable and any of the following strings for the Prefix:
2014-09
2014-09-09
2014-09-09-Holiday
The equal to operator. The MLModel results will have FilterVariable values that exactly match the value specified with EQ.
The greater than operator. The MLModel results will have FilterVariable values that are greater than the value specified with GT.
The less than operator. The MLModel results will have FilterVariable values that are less than the value specified with LT.
The greater than or equal to operator. The MLModel results will have FilterVariable values that are greater than or equal to the value specified with GE.
The less than or equal to operator. The MLModel results will have FilterVariable values that are less than or equal to the value specified with LE.
The not equal to operator. The MLModel results will have FilterVariable values not equal to the value specified with NE.
A string that is found at the beginning of a variable, such as Name or Id.
For example, an MLModel could have the Name 2014-09-09-HolidayGiftMailer. To search for this MLModel, select Name for the FilterVariable and any of the following strings for the Prefix:
2014-09
2014-09-09
2014-09-09-Holiday
The compute statistics for a DataSource. The statistics are generated from the observation data referenced by a DataSource. Amazon ML uses the statistics internally during MLModel training. This parameter must be set to true if the DataSource needs to be used for MLModel training.
The compute statistics for a DataSource. The statistics are generated from the observation data referenced by a DataSource. Amazon ML uses the statistics internally during MLModel training. This parameter must be set to true if the DataSource needs to be used for MLModel training.
The compute statistics for a DataSource. The statistics are generated from the observation data referenced by a DataSource. Amazon ML uses the statistics internally during MLModel training. This parameter must be set to true if the DataSource needs to be used for MLModel training.
The parameter is true if statistics need to be generated from the observation data.
The parameter is true if statistics need to be generated from the observation data.
Represents the output of a CreateBatchPrediction operation, and is an acknowledgement that Amazon ML received the request.
The CreateBatchPrediction operation is asynchronous. You can poll for status updates by using the >GetBatchPrediction operation and checking the Status parameter of the result.
Represents the output of a CreateDataSourceFromRDS operation, and is an acknowledgement that Amazon ML received the request.
The CreateDataSourceFromRDS> operation is asynchronous. You can poll for updates by using the GetBatchPrediction operation and checking the Status parameter. You can inspect the Message when Status shows up as FAILED. You can also check the progress of the copy operation by going to the DataPipeline console and looking up the pipeline using the pipelineId from the describe call.
Represents the output of a CreateDataSourceFromRedshift operation, and is an acknowledgement that Amazon ML received the request.
The CreateDataSourceFromRedshift operation is asynchronous. You can poll for updates by using the GetBatchPrediction operation and checking the Status parameter.
Represents the output of a CreateDataSourceFromS3 operation, and is an acknowledgement that Amazon ML received the request.
The CreateDataSourceFromS3 operation is asynchronous. You can poll for updates by using the GetBatchPrediction operation and checking the Status parameter.
Represents the output of a CreateEvaluation operation, and is an acknowledgement that Amazon ML received the request.
CreateEvaluation operation is asynchronous. You can poll for status updates by using the GetEvcaluation operation and checking the Status parameter.
Represents the output of a CreateMLModel operation, and is an acknowledgement that Amazon ML received the request.
The CreateMLModel operation is asynchronous. You can poll for status updates by using the GetMLModel operation and checking the Status parameter.
Represents the output of an CreateRealtimeEndpoint operation.
The result contains the MLModelId and the endpoint information for the MLModel.
The endpoint information includes the URI of the MLModel; that is, the location to send online prediction requests for the specified MLModel.
A JSON string that represents the splitting and rearrangement requirement used when this DataSource was created.
A JSON string that represents the splitting and rearrangement requirement used when this DataSource was created.
A JSON string that represents the splitting and rearrangement processing to be applied to a DataSource. If the DataRearrangement parameter is not provided, all of the input data is used to create the Datasource.
There are multiple parameters that control what data is used to create a datasource:
percentBegin
Use percentBegin to indicate the beginning of the range of the data used to create the Datasource. If you do not include percentBegin and percentEnd, Amazon ML includes all of the data when creating the datasource.
percentEnd
Use percentEnd to indicate the end of the range of the data used to create the Datasource. If you do not include percentBegin and percentEnd, Amazon ML includes all of the data when creating the datasource.
complement
The complement parameter instructs Amazon ML to use the data that is not included in the range of percentBegin to percentEnd to create a datasource. The complement parameter is useful if you need to create complementary datasources for training and evaluation. To create a complementary datasource, use the same values for percentBegin and percentEnd, along with the complement parameter.
For example, the following two datasources do not share any data, and can be used to train and evaluate a model. The first datasource has 25 percent of the data, and the second one has 75 percent of the data.
Datasource for evaluation: {\"splitting\":{\"percentBegin\":0, \"percentEnd\":25}}
Datasource for training: {\"splitting\":{\"percentBegin\":0, \"percentEnd\":25, \"complement\":\"true\"}}
strategy
To change how Amazon ML splits the data for a datasource, use the strategy parameter.
The default value for the strategy parameter is sequential, meaning that Amazon ML takes all of the data records between the percentBegin and percentEnd parameters for the datasource, in the order that the records appear in the input data.
The following two DataRearrangement lines are examples of sequentially ordered training and evaluation datasources:
Datasource for evaluation: {\"splitting\":{\"percentBegin\":70, \"percentEnd\":100, \"strategy\":\"sequential\"}}
Datasource for training: {\"splitting\":{\"percentBegin\":70, \"percentEnd\":100, \"strategy\":\"sequential\", \"complement\":\"true\"}}
To randomly split the input data into the proportions indicated by the percentBegin and percentEnd parameters, set the strategy parameter to random and provide a string that is used as the seed value for the random data splitting (for example, you can use the S3 path to your data as the random seed string). If you choose the random split strategy, Amazon ML assigns each row of data a pseudo-random number between 0 and 100, and then selects the rows that have an assigned number between percentBegin and percentEnd. Pseudo-random numbers are assigned using both the input seed string value and the byte offset as a seed, so changing the data results in a different split. Any existing ordering is preserved. The random splitting strategy ensures that variables in the training and evaluation data are distributed similarly. It is useful in the cases where the input data may have an implicit sort order, which would otherwise result in training and evaluation datasources containing non-similar data records.
The following two DataRearrangement lines are examples of non-sequentially ordered training and evaluation datasources:
Datasource for evaluation: {\"splitting\":{\"percentBegin\":70, \"percentEnd\":100, \"strategy\":\"random\", \"randomSeed\"=\"s3://my_s3_path/bucket/file.csv\"}}
Datasource for training: {\"splitting\":{\"percentBegin\":70, \"percentEnd\":100, \"strategy\":\"random\", \"randomSeed\"=\"s3://my_s3_path/bucket/file.csv\", \"complement\":\"true\"}}
A JSON string that represents the splitting and rearrangement processing to be applied to a DataSource. If the DataRearrangement parameter is not provided, all of the input data is used to create the Datasource.
There are multiple parameters that control what data is used to create a datasource:
percentBegin
Use percentBegin to indicate the beginning of the range of the data used to create the Datasource. If you do not include percentBegin and percentEnd, Amazon ML includes all of the data when creating the datasource.
percentEnd
Use percentEnd to indicate the end of the range of the data used to create the Datasource. If you do not include percentBegin and percentEnd, Amazon ML includes all of the data when creating the datasource.
complement
The complement parameter instructs Amazon ML to use the data that is not included in the range of percentBegin to percentEnd to create a datasource. The complement parameter is useful if you need to create complementary datasources for training and evaluation. To create a complementary datasource, use the same values for percentBegin and percentEnd, along with the complement parameter.
For example, the following two datasources do not share any data, and can be used to train and evaluate a model. The first datasource has 25 percent of the data, and the second one has 75 percent of the data.
Datasource for evaluation: {\"splitting\":{\"percentBegin\":0, \"percentEnd\":25}}
Datasource for training: {\"splitting\":{\"percentBegin\":0, \"percentEnd\":25, \"complement\":\"true\"}}
strategy
To change how Amazon ML splits the data for a datasource, use the strategy parameter.
The default value for the strategy parameter is sequential, meaning that Amazon ML takes all of the data records between the percentBegin and percentEnd parameters for the datasource, in the order that the records appear in the input data.
The following two DataRearrangement lines are examples of sequentially ordered training and evaluation datasources:
Datasource for evaluation: {\"splitting\":{\"percentBegin\":70, \"percentEnd\":100, \"strategy\":\"sequential\"}}
Datasource for training: {\"splitting\":{\"percentBegin\":70, \"percentEnd\":100, \"strategy\":\"sequential\", \"complement\":\"true\"}}
To randomly split the input data into the proportions indicated by the percentBegin and percentEnd parameters, set the strategy parameter to random and provide a string that is used as the seed value for the random data splitting (for example, you can use the S3 path to your data as the random seed string). If you choose the random split strategy, Amazon ML assigns each row of data a pseudo-random number between 0 and 100, and then selects the rows that have an assigned number between percentBegin and percentEnd. Pseudo-random numbers are assigned using both the input seed string value and the byte offset as a seed, so changing the data results in a different split. Any existing ordering is preserved. The random splitting strategy ensures that variables in the training and evaluation data are distributed similarly. It is useful in the cases where the input data may have an implicit sort order, which would otherwise result in training and evaluation datasources containing non-similar data records.
The following two DataRearrangement lines are examples of non-sequentially ordered training and evaluation datasources:
Datasource for evaluation: {\"splitting\":{\"percentBegin\":70, \"percentEnd\":100, \"strategy\":\"random\", \"randomSeed\"=\"s3://my_s3_path/bucket/file.csv\"}}
Datasource for training: {\"splitting\":{\"percentBegin\":70, \"percentEnd\":100, \"strategy\":\"random\", \"randomSeed\"=\"s3://my_s3_path/bucket/file.csv\", \"complement\":\"true\"}}
A JSON string that represents the splitting and rearrangement processing to be applied to a DataSource. If the DataRearrangement parameter is not provided, all of the input data is used to create the Datasource.
There are multiple parameters that control what data is used to create a datasource:
percentBegin
Use percentBegin to indicate the beginning of the range of the data used to create the Datasource. If you do not include percentBegin and percentEnd, Amazon ML includes all of the data when creating the datasource.
percentEnd
Use percentEnd to indicate the end of the range of the data used to create the Datasource. If you do not include percentBegin and percentEnd, Amazon ML includes all of the data when creating the datasource.
complement
The complement parameter instructs Amazon ML to use the data that is not included in the range of percentBegin to percentEnd to create a datasource. The complement parameter is useful if you need to create complementary datasources for training and evaluation. To create a complementary datasource, use the same values for percentBegin and percentEnd, along with the complement parameter.
For example, the following two datasources do not share any data, and can be used to train and evaluate a model. The first datasource has 25 percent of the data, and the second one has 75 percent of the data.
Datasource for evaluation: {\"splitting\":{\"percentBegin\":0, \"percentEnd\":25}}
Datasource for training: {\"splitting\":{\"percentBegin\":0, \"percentEnd\":25, \"complement\":\"true\"}}
strategy
To change how Amazon ML splits the data for a datasource, use the strategy parameter.
The default value for the strategy parameter is sequential, meaning that Amazon ML takes all of the data records between the percentBegin and percentEnd parameters for the datasource, in the order that the records appear in the input data.
The following two DataRearrangement lines are examples of sequentially ordered training and evaluation datasources:
Datasource for evaluation: {\"splitting\":{\"percentBegin\":70, \"percentEnd\":100, \"strategy\":\"sequential\"}}
Datasource for training: {\"splitting\":{\"percentBegin\":70, \"percentEnd\":100, \"strategy\":\"sequential\", \"complement\":\"true\"}}
To randomly split the input data into the proportions indicated by the percentBegin and percentEnd parameters, set the strategy parameter to random and provide a string that is used as the seed value for the random data splitting (for example, you can use the S3 path to your data as the random seed string). If you choose the random split strategy, Amazon ML assigns each row of data a pseudo-random number between 0 and 100, and then selects the rows that have an assigned number between percentBegin and percentEnd. Pseudo-random numbers are assigned using both the input seed string value and the byte offset as a seed, so changing the data results in a different split. Any existing ordering is preserved. The random splitting strategy ensures that variables in the training and evaluation data are distributed similarly. It is useful in the cases where the input data may have an implicit sort order, which would otherwise result in training and evaluation datasources containing non-similar data records.
The following two DataRearrangement lines are examples of non-sequentially ordered training and evaluation datasources:
Datasource for evaluation: {\"splitting\":{\"percentBegin\":70, \"percentEnd\":100, \"strategy\":\"random\", \"randomSeed\"=\"s3://my_s3_path/bucket/file.csv\"}}
Datasource for training: {\"splitting\":{\"percentBegin\":70, \"percentEnd\":100, \"strategy\":\"random\", \"randomSeed\"=\"s3://my_s3_path/bucket/file.csv\", \"complement\":\"true\"}}
The schema of a DataSource. The DataSchema defines the structure of the observation data in the data file(s) referenced in the DataSource. The DataSource schema is expressed in JSON format.
DataSchema is not required if you specify a DataSchemaUri
{ \"version\": \"1.0\", \"recordAnnotationFieldName\": \"F1\", \"recordWeightFieldName\": \"F2\", \"targetFieldName\": \"F3\", \"dataFormat\": \"CSV\", \"dataFileContainsHeader\": true, \"variables\": [ { \"fieldName\": \"F1\", \"fieldType\": \"TEXT\" }, { \"fieldName\": \"F2\", \"fieldType\": \"NUMERIC\" }, { \"fieldName\": \"F3\", \"fieldType\": \"CATEGORICAL\" }, { \"fieldName\": \"F4\", \"fieldType\": \"NUMERIC\" }, { \"fieldName\": \"F5\", \"fieldType\": \"CATEGORICAL\" }, { \"fieldName\": \"F6\", \"fieldType\": \"TEXT\" }, { \"fieldName\": \"F7\", \"fieldType\": \"WEIGHTED_INT_SEQUENCE\" }, { \"fieldName\": \"F8\", \"fieldType\": \"WEIGHTED_STRING_SEQUENCE\" } ], \"excludedVariableNames\": [ \"F6\" ] }
", + "refs": { + "GetDataSourceOutput$DataSourceSchema": "The schema used by all of the data files of this DataSource.
This parameter is provided as part of the verbose format.
The schema used by all of the data files referenced by the DataSource.
This parameter is provided as part of the verbose format.
A JSON string that represents the schema for an Amazon RDS DataSource. The DataSchema defines the structure of the observation data in the data file(s) referenced in the DataSource.
A DataSchema is not required if you specify a DataSchemaUri
Define your DataSchema as a series of key-value pairs. attributes and excludedVariableNames have an array of key-value pairs for their value. Use the following format to define your DataSchema.
{ \"version\": \"1.0\",
\"recordAnnotationFieldName\": \"F1\",
\"recordWeightFieldName\": \"F2\",
\"targetFieldName\": \"F3\",
\"dataFormat\": \"CSV\",
\"dataFileContainsHeader\": true,
\"attributes\": [
{ \"fieldName\": \"F1\", \"fieldType\": \"TEXT\" }, { \"fieldName\": \"F2\", \"fieldType\": \"NUMERIC\" }, { \"fieldName\": \"F3\", \"fieldType\": \"CATEGORICAL\" }, { \"fieldName\": \"F4\", \"fieldType\": \"NUMERIC\" }, { \"fieldName\": \"F5\", \"fieldType\": \"CATEGORICAL\" }, { \"fieldName\": \"F6\", \"fieldType\": \"TEXT\" }, { \"fieldName\": \"F7\", \"fieldType\": \"WEIGHTED_INT_SEQUENCE\" }, { \"fieldName\": \"F8\", \"fieldType\": \"WEIGHTED_STRING_SEQUENCE\" } ],
\"excludedVariableNames\": [ \"F6\" ] }
", + "RedshiftDataSpec$DataSchema": "A JSON string that represents the schema for an Amazon Redshift DataSource. The DataSchema defines the structure of the observation data in the data file(s) referenced in the DataSource.
A DataSchema is not required if you specify a DataSchemaUri.
Define your DataSchema as a series of key-value pairs. attributes and excludedVariableNames have an array of key-value pairs for their value. Use the following format to define your DataSchema.
{ \"version\": \"1.0\",
\"recordAnnotationFieldName\": \"F1\",
\"recordWeightFieldName\": \"F2\",
\"targetFieldName\": \"F3\",
\"dataFormat\": \"CSV\",
\"dataFileContainsHeader\": true,
\"attributes\": [
{ \"fieldName\": \"F1\", \"fieldType\": \"TEXT\" }, { \"fieldName\": \"F2\", \"fieldType\": \"NUMERIC\" }, { \"fieldName\": \"F3\", \"fieldType\": \"CATEGORICAL\" }, { \"fieldName\": \"F4\", \"fieldType\": \"NUMERIC\" }, { \"fieldName\": \"F5\", \"fieldType\": \"CATEGORICAL\" }, { \"fieldName\": \"F6\", \"fieldType\": \"TEXT\" }, { \"fieldName\": \"F7\", \"fieldType\": \"WEIGHTED_INT_SEQUENCE\" }, { \"fieldName\": \"F8\", \"fieldType\": \"WEIGHTED_STRING_SEQUENCE\" } ],
\"excludedVariableNames\": [ \"F6\" ] }
", + "S3DataSpec$DataSchema": " A JSON string that represents the schema for an Amazon S3 DataSource. The DataSchema defines the structure of the observation data in the data file(s) referenced in the DataSource.
You must provide either the DataSchema or the DataSchemaLocationS3.
Define your DataSchema as a series of key-value pairs. attributes and excludedVariableNames have an array of key-value pairs for their value. Use the following format to define your DataSchema.
{ \"version\": \"1.0\",
\"recordAnnotationFieldName\": \"F1\",
\"recordWeightFieldName\": \"F2\",
\"targetFieldName\": \"F3\",
\"dataFormat\": \"CSV\",
\"dataFileContainsHeader\": true,
\"attributes\": [
{ \"fieldName\": \"F1\", \"fieldType\": \"TEXT\" }, { \"fieldName\": \"F2\", \"fieldType\": \"NUMERIC\" }, { \"fieldName\": \"F3\", \"fieldType\": \"CATEGORICAL\" }, { \"fieldName\": \"F4\", \"fieldType\": \"NUMERIC\" }, { \"fieldName\": \"F5\", \"fieldType\": \"CATEGORICAL\" }, { \"fieldName\": \"F6\", \"fieldType\": \"TEXT\" }, { \"fieldName\": \"F7\", \"fieldType\": \"WEIGHTED_INT_SEQUENCE\" }, { \"fieldName\": \"F8\", \"fieldType\": \"WEIGHTED_STRING_SEQUENCE\" } ],
\"excludedVariableNames\": [ \"F6\" ] }
" + } + }, + "DataSource": { + "base": " Represents the output of the GetDataSource operation.
The content consists of the detailed metadata and data file information and the current status of the DataSource.
A list of the variables to use in searching or filtering DataSource.
CreatedAt - Sets the search criteria to DataSource creation date.Status - Sets the search criteria to DataSource status.Name - Sets the search criteria to the contents of DataSource Name.DataUri - Sets the search criteria to the URI of data files used to create the DataSource. The URI can identify either a file or an Amazon Simple Storage Service (Amazon S3) bucket or directory.IAMUser - Sets the search criteria to the user account that invoked the DataSource creation.The variable names should match the variable names in the DataSource.
Use one of the following variables to filter a list of DataSource:
CreatedAt - Sets the search criteria to DataSource creation dates.Status - Sets the search criteria to DataSource statuses.Name - Sets the search criteria to the contents of DataSource Name.DataUri - Sets the search criteria to the URI of data files used to create the DataSource. The URI can identify either a file or an Amazon Simple Storage Service (Amazon S3) bucket or directory.IAMUser - Sets the search criteria to the user account that invoked the DataSource creation.A list of DataSource that meet the search criteria.
Represents the output of a DeleteBatchPrediction operation.
You can use the GetBatchPrediction operation and check the value of the Status parameter to see whether a BatchPrediction is marked as DELETED.
Represents the output of a DeleteDataSource operation.
Represents the output of a DeleteEvaluation operation. The output indicates that Amazon Machine Learning (Amazon ML) received the request.
You can use the GetEvaluation operation and check the value of the Status parameter to see whether an Evaluation is marked as DELETED.
Represents the output of a DeleteMLModel operation.
You can use the GetMLModel operation and check the value of the Status parameter to see whether an MLModel is marked as DELETED.
Represents the output of an DeleteRealtimeEndpoint operation.
The result contains the MLModelId and the endpoint information for the MLModel.
Amazon ML returns the following elements.
", + "refs": { + } + }, + "DescribeBatchPredictionsInput": { + "base": null, + "refs": { + } + }, + "DescribeBatchPredictionsOutput": { + "base": "Represents the output of a DescribeBatchPredictions operation. The content is essentially a list of BatchPredictions.
Represents the query results from a DescribeDataSources operation. The content is essentially a list of DataSource.
Represents the query results from a DescribeEvaluations operation. The content is essentially a list of Evaluation.
Represents the output of a DescribeMLModels operation. The content is essentially a list of MLModel.
Amazon ML returns the following elements.
", + "refs": { + } + }, + "DetailsAttributes": { + "base": "Contains the key values ofDetailsMap: PredictiveModelType - Indicates the type of the MLModel. Algorithm - Indicates the algorithm that was used for the MLModel.",
+ "refs": {
+ "DetailsMap$key": null
+ }
+ },
+ "DetailsMap": {
+ "base": "Provides any additional details regarding the prediction.",
+ "refs": {
+ "Prediction$details": null
+ }
+ },
+ "DetailsValue": {
+ "base": null,
+ "refs": {
+ "DetailsMap$value": null
+ }
+ },
+ "EDPPipelineId": {
+ "base": null,
+ "refs": {
+ "RDSMetadata$DataPipelineId": "The ID of the Data Pipeline instance that is used to carry to copy data from Amazon RDS to Amazon S3. You can use the ID to find details about the instance in the Data Pipeline console.
" + } + }, + "EDPResourceRole": { + "base": null, + "refs": { + "RDSDataSpec$ResourceRole": "The role (DataPipelineDefaultResourceRole) assumed by an Amazon Elastic Compute Cloud (Amazon EC2) instance to carry out the copy operation from Amazon RDS to an Amazon S3 task. For more information, see Role templates for data pipelines.
", + "RDSMetadata$ResourceRole": "The role (DataPipelineDefaultResourceRole) assumed by an Amazon EC2 instance to carry out the copy task from Amazon RDS to Amazon S3. For more information, see Role templates for data pipelines.
" + } + }, + "EDPSecurityGroupId": { + "base": null, + "refs": { + "EDPSecurityGroupIds$member": null + } + }, + "EDPSecurityGroupIds": { + "base": null, + "refs": { + "RDSDataSpec$SecurityGroupIds": "The security group IDs to be used to access a VPC-based RDS DB instance. Ensure that there are appropriate ingress rules set up to allow access to the RDS DB instance. This attribute is used by Data Pipeline to carry out the copy operation from Amazon RDS to an Amazon S3 task.
" + } + }, + "EDPServiceRole": { + "base": null, + "refs": { + "RDSDataSpec$ServiceRole": "The role (DataPipelineDefaultRole) assumed by AWS Data Pipeline service to monitor the progress of the copy task from Amazon RDS to Amazon S3. For more information, see Role templates for data pipelines.
", + "RDSMetadata$ServiceRole": "The role (DataPipelineDefaultRole) assumed by the Data Pipeline service to monitor the progress of the copy task from Amazon RDS to Amazon S3. For more information, see Role templates for data pipelines.
" + } + }, + "EDPSubnetId": { + "base": null, + "refs": { + "RDSDataSpec$SubnetId": "The subnet ID to be used to access a VPC-based RDS DB instance. This attribute is used by Data Pipeline to carry out the copy task from Amazon RDS to Amazon S3.
" + } + }, + "EntityId": { + "base": null, + "refs": { + "AddTagsInput$ResourceId": "The ID of the ML object to tag. For example, exampleModelId.
The ID of the ML object that was tagged.
", + "BatchPrediction$BatchPredictionId": "The ID assigned to the BatchPrediction at creation. This value should be identical to the value of the BatchPredictionID in the request.
The ID of the MLModel that generated predictions for the BatchPrediction request.
The ID of the DataSource that points to the group of observations to predict.
A user-supplied ID that uniquely identifies the BatchPrediction.
The ID of the MLModel that will generate predictions for the group of observations.
The ID of the DataSource that points to the group of observations to predict.
A user-supplied ID that uniquely identifies the BatchPrediction. This value is identical to the value of the BatchPredictionId in the request.
A user-supplied ID that uniquely identifies the DataSource. Typically, an Amazon Resource Number (ARN) becomes the ID for a DataSource.
A user-supplied ID that uniquely identifies the datasource. This value should be identical to the value of the DataSourceID in the request.
A user-supplied ID that uniquely identifies the DataSource.
A user-supplied ID that uniquely identifies the datasource. This value should be identical to the value of the DataSourceID in the request.
A user-supplied identifier that uniquely identifies the DataSource.
A user-supplied ID that uniquely identifies the DataSource. This value should be identical to the value of the DataSourceID in the request.
A user-supplied ID that uniquely identifies the Evaluation.
The ID of the MLModel to evaluate.
The schema used in creating the MLModel must match the schema of the DataSource used in the Evaluation.
The ID of the DataSource for the evaluation. The schema of the DataSource must match the schema used to create the MLModel.
The user-supplied ID that uniquely identifies the Evaluation. This value should be identical to the value of the EvaluationId in the request.
A user-supplied ID that uniquely identifies the MLModel.
The DataSource that points to the training data.
A user-supplied ID that uniquely identifies the MLModel. This value should be identical to the value of the MLModelId in the request.
The ID assigned to the MLModel during creation.
A user-supplied ID that uniquely identifies the MLModel. This value should be identical to the value of the MLModelId in the request.
The ID that is assigned to the DataSource during creation.
A user-supplied ID that uniquely identifies the BatchPrediction.
A user-supplied ID that uniquely identifies the BatchPrediction. This value should be identical to the value of the BatchPredictionID in the request.
A user-supplied ID that uniquely identifies the DataSource.
A user-supplied ID that uniquely identifies the DataSource. This value should be identical to the value of the DataSourceID in the request.
A user-supplied ID that uniquely identifies the Evaluation to delete.
A user-supplied ID that uniquely identifies the Evaluation. This value should be identical to the value of the EvaluationId in the request.
A user-supplied ID that uniquely identifies the MLModel.
A user-supplied ID that uniquely identifies the MLModel. This value should be identical to the value of the MLModelID in the request.
The ID assigned to the MLModel during creation.
A user-supplied ID that uniquely identifies the MLModel. This value should be identical to the value of the MLModelId in the request.
The ID of the tagged ML object. For example, exampleModelId.
The ID of the ML object from which tags were deleted.
", + "DescribeTagsInput$ResourceId": "The ID of the ML object. For example, exampleModelId.
The ID of the tagged ML object.
", + "Evaluation$EvaluationId": "The ID that is assigned to the Evaluation at creation.
The ID of the MLModel that is the focus of the evaluation.
The ID of the DataSource that is used to evaluate the MLModel.
An ID assigned to the BatchPrediction at creation.
An ID assigned to the BatchPrediction at creation. This value should be identical to the value of the BatchPredictionID in the request.
The ID of the MLModel that generated predictions for the BatchPrediction request.
The ID of the DataSource that was used to create the BatchPrediction.
The ID assigned to the DataSource at creation.
The ID assigned to the DataSource at creation. This value should be identical to the value of the DataSourceId in the request.
The ID of the Evaluation to retrieve. The evaluation of each MLModel is recorded and cataloged. The ID provides the means to access the information.
The evaluation ID which is same as the EvaluationId in the request.
The ID of the MLModel that was the focus of the evaluation.
The DataSource used for this evaluation.
The ID assigned to the MLModel at creation.
The MLModel ID, which is same as the MLModelId in the request.
The ID of the training DataSource.
The ID assigned to the MLModel at creation.
The ID of the training DataSource. The CreateMLModel operation uses the TrainingDataSourceId.
A unique identifier of the MLModel.
The ID assigned to the BatchPrediction during creation.
The ID assigned to the BatchPrediction during creation. This value should be identical to the value of the BatchPredictionId in the request.
The ID assigned to the DataSource during creation.
The ID assigned to the DataSource during creation. This value should be identical to the value of the DataSourceID in the request.
The ID assigned to the Evaluation during creation.
The ID assigned to the Evaluation during creation. This value should be identical to the value of the Evaluation in the request.
The ID assigned to the MLModel during creation.
The ID assigned to the MLModel during creation. This value should be identical to the value of the MLModelID in the request.
A user-supplied name or description of the Amazon ML resource.
", + "refs": { + "BatchPrediction$Name": "A user-supplied name or description of the BatchPrediction.
A user-supplied name or description of the BatchPrediction. BatchPredictionName can only use the UTF-8 character set.
A user-supplied name or description of the DataSource.
A user-supplied name or description of the DataSource.
A user-supplied name or description of the DataSource.
A user-supplied name or description of the Evaluation.
A user-supplied name or description of the MLModel.
A user-supplied name or description of the DataSource.
A user-supplied name or description of the Evaluation.
A user-supplied name or description of the BatchPrediction.
A user-supplied name or description of the DataSource.
A user-supplied name or description of the Evaluation.
A new user-supplied name or description of the BatchPrediction.
A new user-supplied name or description of the DataSource that will replace the current description.
A new user-supplied name or description of the Evaluation that will replace the current content.
A user-supplied name or description of the MLModel.
Object status with the following possible values:
PENDINGINPROGRESSFAILEDCOMPLETEDDELETEDThe status of the BatchPrediction. This element can have one of the following values:
PENDING - Amazon Machine Learning (Amazon ML) submitted a request to generate predictions for a batch of observations.INPROGRESS - The process is underway.FAILED - The request to perform a batch prediction did not run to completion. It is not usable.COMPLETED - The batch prediction process completed successfully.DELETED - The BatchPrediction is marked as deleted. It is not usable.The current status of the DataSource. This element can have one of the following values:
DataSource.DataSource did not run to completion. It is not usable.DataSource is marked as deleted. It is not usable.The status of the evaluation. This element can have one of the following values:
PENDING - Amazon Machine Learning (Amazon ML) submitted a request to evaluate an MLModel.INPROGRESS - The evaluation is underway.FAILED - The request to evaluate an MLModel did not run to completion. It is not usable.COMPLETED - The evaluation process completed successfully.DELETED - The Evaluation is marked as deleted. It is not usable.The status of the BatchPrediction, which can be one of the following values:
PENDING - Amazon Machine Learning (Amazon ML) submitted a request to generate batch predictions.INPROGRESS - The batch predictions are in progress.FAILED - The request to perform a batch prediction did not run to completion. It is not usable.COMPLETED - The batch prediction process completed successfully.DELETED - The BatchPrediction is marked as deleted. It is not usable.The current status of the DataSource. This element can have one of the following values:
PENDING - Amazon ML submitted a request to create a DataSource.INPROGRESS - The creation process is underway.FAILED - The request to create a DataSource did not run to completion. It is not usable.COMPLETED - The creation process completed successfully.DELETED - The DataSource is marked as deleted. It is not usable.The status of the evaluation. This element can have one of the following values:
PENDING - Amazon Machine Language (Amazon ML) submitted a request to evaluate an MLModel.INPROGRESS - The evaluation is underway.FAILED - The request to evaluate an MLModel did not run to completion. It is not usable.COMPLETED - The evaluation process completed successfully.DELETED - The Evaluation is marked as deleted. It is not usable.The current status of the MLModel. This element can have one of the following values:
PENDING - Amazon Machine Learning (Amazon ML) submitted a request to describe a MLModel.INPROGRESS - The request is processing.FAILED - The request did not run to completion. The ML model isn't usable.COMPLETED - The request completed successfully.DELETED - The MLModel is marked as deleted. It isn't usable.The current status of an MLModel. This element can have one of the following values:
PENDING - Amazon Machine Learning (Amazon ML) submitted a request to create an MLModel.INPROGRESS - The creation process is underway.FAILED - The request to create an MLModel didn't run to completion. The model isn't usable.COMPLETED - The creation process completed successfully.DELETED - The MLModel is marked as deleted. It isn't usable.A timestamp represented in epoch time.
", + "refs": { + "BatchPrediction$CreatedAt": "The time that the BatchPrediction was created. The time is expressed in epoch time.
The time of the most recent edit to the BatchPrediction. The time is expressed in epoch time.
The time that the DataSource was created. The time is expressed in epoch time.
The time of the most recent edit to the BatchPrediction. The time is expressed in epoch time.
The time that the Evaluation was created. The time is expressed in epoch time.
The time of the most recent edit to the Evaluation. The time is expressed in epoch time.
The time when the BatchPrediction was created. The time is expressed in epoch time.
The time of the most recent edit to BatchPrediction. The time is expressed in epoch time.
The time that the DataSource was created. The time is expressed in epoch time.
The time of the most recent edit to the DataSource. The time is expressed in epoch time.
The time that the Evaluation was created. The time is expressed in epoch time.
The time of the most recent edit to the BatchPrediction. The time is expressed in epoch time.
The time that the MLModel was created. The time is expressed in epoch time.
The time of the most recent edit to the MLModel. The time is expressed in epoch time.
The time of the most recent edit to the ScoreThreshold. The time is expressed in epoch time.
The time that the MLModel was created. The time is expressed in epoch time.
The time of the most recent edit to the MLModel. The time is expressed in epoch time.
The time of the most recent edit to the ScoreThreshold. The time is expressed in epoch time.
The time that the request to create the real-time endpoint for the MLModel was received. The time is expressed in epoch time.
Represents the output of GetEvaluation operation.
The content consists of the detailed metadata and data file information and the current status of the Evaluation.
A list of the variables to use in searching or filtering Evaluation.
CreatedAt - Sets the search criteria to Evaluation creation date.Status - Sets the search criteria to Evaluation status.Name - Sets the search criteria to the contents of Evaluation Name.IAMUser - Sets the search criteria to the user account that invoked an evaluation.MLModelId - Sets the search criteria to the Predictor that was evaluated.DataSourceId - Sets the search criteria to the DataSource used in evaluation.DataUri - Sets the search criteria to the data file(s) used in evaluation. The URL can identify either a file or an Amazon Simple Storage Service (Amazon S3) bucket or directory.Use one of the following variable to filter a list of Evaluation objects:
CreatedAt - Sets the search criteria to the Evaluation creation date.Status - Sets the search criteria to the Evaluation status.Name - Sets the search criteria to the contents of Evaluation Name.IAMUser - Sets the search criteria to the user account that invoked an Evaluation.MLModelId - Sets the search criteria to the MLModel that was evaluated.DataSourceId - Sets the search criteria to the DataSource used in Evaluation.DataUri - Sets the search criteria to the data file(s) used in Evaluation. The URL can identify either a file or an Amazon Simple Storage Solution (Amazon S3) bucket or directory.A list of Evaluation that meet the search criteria.
Represents the output of a GetBatchPrediction operation and describes a BatchPrediction.
Represents the output of a GetDataSource operation and describes a DataSource.
Represents the output of a GetEvaluation operation and describes an Evaluation.
Represents the output of a GetMLModel operation, and provides detailed information about a MLModel.
A second request to use or change an object was not allowed. This can result from retrying a request using a parameter that was not present in the original request.
", + "refs": { + } + }, + "IntegerType": { + "base": "Integer type that is a 32-bit signed number.
", + "refs": { + "RealtimeEndpointInfo$PeakRequestsPerSecond": " The maximum processing rate for the real-time endpoint for MLModel, measured in incoming requests per second.
An error on the server occurred when trying to process a request.
", + "refs": { + } + }, + "InvalidInputException": { + "base": "An error on the client occurred. Typically, the cause is an invalid input value.
", + "refs": { + } + }, + "InvalidTagException": { + "base": null, + "refs": { + } + }, + "Label": { + "base": null, + "refs": { + "Prediction$predictedLabel": "The prediction label for either a BINARY or MULTICLASS MLModel.
The subscriber exceeded the maximum number of operations. This exception can occur when listing objects such as DataSource.
Long integer type that is a 64-bit signed number.
", + "refs": { + "DataSource$DataSizeInBytes": "The total number of observations contained in the data files that the DataSource references.
The number of data files referenced by the DataSource.
The total size of observations in the data files.
", + "GetDataSourceOutput$NumberOfFiles": "The number of data files referenced by the DataSource.
Represents the output of a GetMLModel operation.
The content consists of the detailed metadata and the current status of the MLModel.
Use one of the following variables to filter a list of MLModel:
CreatedAt - Sets the search criteria to MLModel creation date.Status - Sets the search criteria to MLModel status.Name - Sets the search criteria to the contents of MLModel Name.IAMUser - Sets the search criteria to the user account that invoked the MLModel creation.TrainingDataSourceId - Sets the search criteria to the DataSource used to train one or more MLModel.RealtimeEndpointStatus - Sets the search criteria to the MLModel real-time endpoint status.MLModelType - Sets the search criteria to MLModel type: binary, regression, or multi-class.Algorithm - Sets the search criteria to the algorithm that the MLModel uses.TrainingDataURI - Sets the search criteria to the data file(s) used in training a MLModel. The URL can identify either a file or an Amazon Simple Storage Service (Amazon S3) bucket or directory.A user-supplied name or description of the MLModel.
A user-supplied name or description of the MLModel.
The category of supervised learning that this MLModel will address. Choose from the following types:
REGRESSION if the MLModel will be used to predict a numeric value.BINARY if the MLModel result has two possible values.MULTICLASS if the MLModel result has a limited number of values. For more information, see the Amazon Machine Learning Developer Guide.
", + "GetMLModelOutput$MLModelType": "Identifies the MLModel category. The following are the available types:
Identifies the MLModel category. The following are the available types:
REGRESSION - Produces a numeric result. For example, \"What price should a house be listed at?\"BINARY - Produces one of two possible results. For example, \"Is this a child-friendly web site?\".MULTICLASS - Produces one of several possible results. For example, \"Is this a HIGH-, LOW-, or MEDIUM-risk trade?\".A list of MLModel that meet the search criteria.
Description of the most recent details about an object.
", + "refs": { + "BatchPrediction$Message": "A description of the most recent details about processing the batch prediction request.
", + "DataSource$Message": "A description of the most recent details about creating the DataSource.
A description of the most recent details about evaluating the MLModel.
A description of the most recent details about processing the batch prediction request.
", + "GetDataSourceOutput$Message": "The user-supplied description of the most recent details about creating the DataSource.
A description of the most recent details about evaluating the MLModel.
A description of the most recent details about accessing the MLModel.
A description of the most recent details about accessing the MLModel.
The number of pages of information to include in the result. The range of acceptable values is 1 through 100. The default value is 100.
The maximum number of DataSource to include in the result.
The maximum number of Evaluation to include in the result.
The number of pages of information to include in the result. The range of acceptable values is 1 through 100. The default value is 100.
Measurements of how well the MLModel performed on known observations. One of the following metrics is returned, based on the type of the MLModel:
BinaryAUC: The binary MLModel uses the Area Under the Curve (AUC) technique to measure performance.
RegressionRMSE: The regression MLModel uses the Root Mean Square Error (RMSE) technique to measure performance. RMSE measures the difference between predicted and actual values for a single variable.
MulticlassAvgFScore: The multiclass MLModel uses the F1 score technique to measure performance.
For more information about performance metrics, please see the Amazon Machine Learning Developer Guide.
", + "refs": { + "Evaluation$PerformanceMetrics": "Measurements of how well the MLModel performed, using observations referenced by the DataSource. One of the following metrics is returned, based on the type of the MLModel:
BinaryAUC: A binary MLModel uses the Area Under the Curve (AUC) technique to measure performance.
RegressionRMSE: A regression MLModel uses the Root Mean Square Error (RMSE) technique to measure performance. RMSE measures the difference between predicted and actual values for a single variable.
MulticlassAvgFScore: A multiclass MLModel uses the F1 score technique to measure performance.
For more information about performance metrics, please see the Amazon Machine Learning Developer Guide.
", + "GetEvaluationOutput$PerformanceMetrics": "Measurements of how well the MLModel performed using observations referenced by the DataSource. One of the following metric is returned based on the type of the MLModel:
BinaryAUC: A binary MLModel uses the Area Under the Curve (AUC) technique to measure performance.
RegressionRMSE: A regression MLModel uses the Root Mean Square Error (RMSE) technique to measure performance. RMSE measures the difference between predicted and actual values for a single variable.
MulticlassAvgFScore: A multiclass MLModel uses the F1 score technique to measure performance.
For more information about performance metrics, please see the Amazon Machine Learning Developer Guide.
" + } + }, + "PerformanceMetricsProperties": { + "base": null, + "refs": { + "PerformanceMetrics$Properties": null + } + }, + "PerformanceMetricsPropertyKey": { + "base": null, + "refs": { + "PerformanceMetricsProperties$key": null + } + }, + "PerformanceMetricsPropertyValue": { + "base": null, + "refs": { + "PerformanceMetricsProperties$value": null + } + }, + "PredictInput": { + "base": null, + "refs": { + } + }, + "PredictOutput": { + "base": null, + "refs": { + } + }, + "Prediction": { + "base": "The output from a Predict operation:
Details - Contains the following attributes: DetailsAttributes.PREDICTIVE_MODEL_TYPE - REGRESSION | BINARY | MULTICLASS DetailsAttributes.ALGORITHM - SGD
PredictedLabel - Present for either a BINARY or MULTICLASS MLModel request.
PredictedScores - Contains the raw classification score corresponding to each label.
PredictedValue - Present for a REGRESSION MLModel request.
The exception is thrown when a predict request is made to an unmounted MLModel.
A link to the file that contains logs of the CreateBatchPrediction operation.
A link to the file containing logs of CreateDataSourceFrom* operations.
A link to the file that contains logs of the CreateEvaluation operation.
A link to the file that contains logs of the CreateMLModel operation.
The data specification of an Amazon Relational Database Service (Amazon RDS) DataSource.
The data specification of an Amazon RDS DataSource:
DatabaseInformation -
DatabaseName - The name of the Amazon RDS database.InstanceIdentifier - A unique identifier for the Amazon RDS database instance.DatabaseCredentials - AWS Identity and Access Management (IAM) credentials that are used to connect to the Amazon RDS database.
ResourceRole - A role (DataPipelineDefaultResourceRole) assumed by an EC2 instance to carry out the copy task from Amazon RDS to Amazon Simple Storage Service (Amazon S3). For more information, see Role templates for data pipelines.
ServiceRole - A role (DataPipelineDefaultRole) assumed by the AWS Data Pipeline service to monitor the progress of the copy task from Amazon RDS to Amazon S3. For more information, see Role templates for data pipelines.
SecurityInfo - The security information to use to access an RDS DB instance. You need to set up appropriate ingress rules for the security entity IDs provided to allow access to the Amazon RDS instance. Specify a [SubnetId, SecurityGroupIds] pair for a VPC-based RDS DB instance.
SelectSqlQuery - A query that is used to retrieve the observation data for the Datasource.
S3StagingLocation - The Amazon S3 location for staging Amazon RDS data. The data retrieved from Amazon RDS using SelectSqlQuery is stored in this location.
DataSchemaUri - The Amazon S3 location of the DataSchema.
DataSchema - A JSON string representing the schema. This is not required if DataSchemaUri is specified.
DataRearrangement - A JSON string that represents the splitting and rearrangement requirements for the Datasource.
Sample - \"{\\\"splitting\\\":{\\\"percentBegin\\\":10,\\\"percentEnd\\\":60}}\"
The database details of an Amazon RDS database.
", + "refs": { + "RDSDataSpec$DatabaseInformation": "Describes the DatabaseName and InstanceIdentifier of an an Amazon RDS database.
The database details required to connect to an Amazon RDS.
" + } + }, + "RDSDatabaseCredentials": { + "base": "The database credentials to connect to a database on an RDS DB instance.
", + "refs": { + "RDSDataSpec$DatabaseCredentials": "The AWS Identity and Access Management (IAM) credentials that are used connect to the Amazon RDS database.
" + } + }, + "RDSDatabaseName": { + "base": "The name of a database hosted on an RDS DB instance.
", + "refs": { + "RDSDatabase$DatabaseName": null + } + }, + "RDSDatabasePassword": { + "base": "The password to be used by Amazon ML to connect to a database on an RDS DB instance. The password should have sufficient permissions to execute the RDSSelectQuery query.
The username to be used by Amazon ML to connect to database on an Amazon RDS instance. The username should have sufficient permissions to execute an RDSSelectSqlQuery query.
The ID of an RDS DB instance.
" + } + }, + "RDSMetadata": { + "base": "The datasource details that are specific to Amazon RDS.
", + "refs": { + "DataSource$RDSMetadata": null, + "GetDataSourceOutput$RDSMetadata": null + } + }, + "RDSSelectSqlQuery": { + "base": "The SQL query to be executed against the Amazon RDS database. The SQL query should be valid for the Amazon RDS type being used.
", + "refs": { + "RDSDataSpec$SelectSqlQuery": "The query that is used to retrieve the observation data for the DataSource.
The SQL query that is supplied during CreateDataSourceFromRDS. Returns only if Verbose is true in GetDataSourceInput.
Describes the real-time endpoint information for an MLModel.
The endpoint information of the MLModel
The endpoint information of the MLModel
The current endpoint of the MLModel
The current endpoint of the MLModel.
The current status of the real-time endpoint for the MLModel. This element can have one of the following values:
NONE - Endpoint does not exist or was previously deleted.READY - Endpoint is ready to be used for real-time predictions.UPDATING - Updating/creating the endpoint. The data recipe for creating the MLModel. You must specify either the recipe or its URI. If you don't specify a recipe or its URI, Amazon ML creates a default.
The recipe to use when training the MLModel. The Recipe provides detailed information about the observation data to use during training, and manipulations to perform on the observation data during training.
This parameter is provided as part of the verbose format.
A map of variable name-value pairs that represent an observation.
", + "refs": { + "PredictInput$Record": null + } + }, + "RedshiftClusterIdentifier": { + "base": "The ID of an Amazon Redshift cluster.
", + "refs": { + "RedshiftDatabase$ClusterIdentifier": null + } + }, + "RedshiftDataSpec": { + "base": "Describes the data specification of an Amazon Redshift DataSource.
The data specification of an Amazon Redshift DataSource:
DatabaseInformation -
DatabaseName - The name of the Amazon Redshift database. ClusterIdentifier - The unique ID for the Amazon Redshift cluster.DatabaseCredentials - The AWS Identity and Access Management (IAM) credentials that are used to connect to the Amazon Redshift database.
SelectSqlQuery - The query that is used to retrieve the observation data for the Datasource.
S3StagingLocation - The Amazon Simple Storage Service (Amazon S3) location for staging Amazon Redshift data. The data retrieved from Amazon Redshift using the SelectSqlQuery query is stored in this location.
DataSchemaUri - The Amazon S3 location of the DataSchema.
DataSchema - A JSON string representing the schema. This is not required if DataSchemaUri is specified.
DataRearrangement - A JSON string that represents the splitting and rearrangement requirements for the DataSource.
Sample - \"{\\\"splitting\\\":{\\\"percentBegin\\\":10,\\\"percentEnd\\\":60}}\"
Describes the database details required to connect to an Amazon Redshift database.
", + "refs": { + "RedshiftDataSpec$DatabaseInformation": "Describes the DatabaseName and ClusterIdentifier for an Amazon Redshift DataSource.
Describes the database credentials for connecting to a database on an Amazon Redshift cluster.
", + "refs": { + "RedshiftDataSpec$DatabaseCredentials": "Describes AWS Identity and Access Management (IAM) credentials that are used connect to the Amazon Redshift database.
" + } + }, + "RedshiftDatabaseName": { + "base": "The name of a database hosted on an Amazon Redshift cluster.
", + "refs": { + "RedshiftDatabase$DatabaseName": null + } + }, + "RedshiftDatabasePassword": { + "base": "A password to be used by Amazon ML to connect to a database on an Amazon Redshift cluster. The password should have sufficient permissions to execute a RedshiftSelectSqlQuery query. The password should be valid for an Amazon Redshift USER.
A username to be used by Amazon Machine Learning (Amazon ML)to connect to a database on an Amazon Redshift cluster. The username should have sufficient permissions to execute the RedshiftSelectSqlQuery query. The username should be valid for an Amazon Redshift USER.
Describes the DataSource details specific to Amazon Redshift.
Describes the SQL query to execute on the Amazon Redshift database. The SQL query should be valid for an Amazon Redshift SELECT.
", + "refs": { + "RedshiftDataSpec$SelectSqlQuery": "Describes the SQL Query to execute on an Amazon Redshift database for an Amazon Redshift DataSource.
The SQL query that is specified during CreateDataSourceFromRedshift. Returns only if Verbose is true in GetDataSourceInput.
A specified resource cannot be located.
", + "refs": { + } + }, + "RoleARN": { + "base": "The Amazon Resource Name (ARN) of an AWS IAM Role, such as the following: arn:aws:iam::account:role/rolename.
", + "refs": { + "CreateDataSourceFromRDSInput$RoleARN": "The role that Amazon ML assumes on behalf of the user to create and activate a data pipeline in the user's account and copy data using the SelectSqlQuery query from Amazon RDS to Amazon S3.
", + "CreateDataSourceFromRedshiftInput$RoleARN": "
A fully specified role Amazon Resource Name (ARN). Amazon ML assumes the role on behalf of the user to create the following:
A security group to allow Amazon ML to execute the SelectSqlQuery query on an Amazon Redshift cluster
An Amazon S3 bucket policy to grant Amazon ML read/write permissions on the S3StagingLocation
Describes the data specification of a DataSource.
The data specification of a DataSource:
DataLocationS3 - The Amazon S3 location of the observation data.
DataSchemaLocationS3 - The Amazon S3 location of the DataSchema.
DataSchema - A JSON string representing the schema. This is not required if DataSchemaUri is specified.
DataRearrangement - A JSON string that represents the splitting and rearrangement requirements for the Datasource.
Sample - \"{\\\"splitting\\\":{\\\"percentBegin\\\":10,\\\"percentEnd\\\":60}}\"
A reference to a file or bucket on Amazon Simple Storage Service (Amazon S3).
", + "refs": { + "BatchPrediction$InputDataLocationS3": "The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).
", + "BatchPrediction$OutputUri": "The location of an Amazon S3 bucket or directory to receive the operation results. The following substrings are not allowed in the s3 key portion of the outputURI field: ':', '//', '/./', '/../'.
The location of an Amazon Simple Storage Service (Amazon S3) bucket or directory to store the batch prediction results. The following substrings are not allowed in the s3 key portion of the outputURI field: ':', '//', '/./', '/../'.
Amazon ML needs permissions to store and retrieve the logs on your behalf. For information about how to set permissions, see the Amazon Machine Learning Developer Guide.
", + "CreateMLModelInput$RecipeUri": "The Amazon Simple Storage Service (Amazon S3) location and file name that contains the MLModel recipe. You must specify either the recipe or its URI. If you don't specify a recipe or its URI, Amazon ML creates a default.
The location and name of the data in Amazon Simple Storage Service (Amazon S3) that is used by a DataSource.
The location and name of the data in Amazon Simple Storage Server (Amazon S3) that is used in the evaluation.
", + "GetBatchPredictionOutput$InputDataLocationS3": "The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).
", + "GetBatchPredictionOutput$OutputUri": "The location of an Amazon S3 bucket or directory to receive the operation results.
", + "GetDataSourceOutput$DataLocationS3": "The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).
", + "GetEvaluationOutput$InputDataLocationS3": "The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).
", + "GetMLModelOutput$InputDataLocationS3": "The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).
", + "MLModel$InputDataLocationS3": "The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).
", + "RDSDataSpec$S3StagingLocation": "The Amazon S3 location for staging Amazon RDS data. The data retrieved from Amazon RDS using SelectSqlQuery is stored in this location.
The Amazon S3 location of the DataSchema.
Describes an Amazon S3 location to store the result set of the SelectSqlQuery query.
Describes the schema location for an Amazon Redshift DataSource.
The location of the data file(s) used by a DataSource. The URI specifies a data file or an Amazon Simple Storage Service (Amazon S3) directory or bucket containing data files.
Describes the schema location in Amazon S3. You must provide either the DataSchema or the DataSchemaLocationS3.
The scoring threshold is used in binary classification MLModel models. It marks the boundary between a positive prediction and a negative prediction.
Output values greater than or equal to the threshold receive a positive result from the MLModel, such as true. Output values less than the threshold receive a negative response from the MLModel, such as false.
The ScoreThreshold used in binary classification MLModel that marks the boundary between a positive prediction and a negative prediction.
Output values greater than or equal to the ScoreThreshold receive a positive result from the MLModel, such as true. Output values less than the ScoreThreshold receive a negative response from the MLModel, such as false.
The sort order specified in a listing condition. Possible values include the following:
asc - Present the information in ascending order (from A-Z).dsc - Present the information in descending order (from Z-A).A two-value parameter that determines the sequence of the resulting list of MLModels.
asc - Arranges the list in ascending order (A-Z, 0-9).dsc - Arranges the list in descending order (Z-A, 9-0).Results are sorted by FilterVariable.
A two-value parameter that determines the sequence of the resulting list of DataSource.
asc - Arranges the list in ascending order (A-Z, 0-9).dsc - Arranges the list in descending order (Z-A, 9-0).Results are sorted by FilterVariable.
A two-value parameter that determines the sequence of the resulting list of Evaluation.
asc - Arranges the list in ascending order (A-Z, 0-9).dsc - Arranges the list in descending order (Z-A, 9-0).Results are sorted by FilterVariable.
A two-value parameter that determines the sequence of the resulting list of MLModel.
asc - Arranges the list in ascending order (A-Z, 0-9).dsc - Arranges the list in descending order (Z-A, 9-0).Results are sorted by FilterVariable.
String type.
", + "refs": { + "DescribeBatchPredictionsInput$NextToken": "An ID of the page in the paginated results.
", + "DescribeBatchPredictionsOutput$NextToken": "The ID of the next page in the paginated results that indicates at least one more page follows.
", + "DescribeDataSourcesInput$NextToken": "The ID of the page in the paginated results.
", + "DescribeDataSourcesOutput$NextToken": "An ID of the next page in the paginated results that indicates at least one more page follows.
", + "DescribeEvaluationsInput$NextToken": "The ID of the page in the paginated results.
", + "DescribeEvaluationsOutput$NextToken": "The ID of the next page in the paginated results that indicates at least one more page follows.
", + "DescribeMLModelsInput$NextToken": "The ID of the page in the paginated results.
", + "DescribeMLModelsOutput$NextToken": "The ID of the next page in the paginated results that indicates at least one more page follows.
", + "TrainingParameters$key": null, + "TrainingParameters$value": null + } + }, + "Tag": { + "base": "A custom key-value pair associated with an ML object, such as an ML model.
", + "refs": { + "TagList$member": null + } + }, + "TagKey": { + "base": null, + "refs": { + "Tag$Key": "A unique identifier for the tag. Valid characters include Unicode letters, digits, white space, _, ., /, =, +, -, %, and @.
", + "TagKeyList$member": null + } + }, + "TagKeyList": { + "base": null, + "refs": { + "DeleteTagsInput$TagKeys": "One or more tags to delete.
" + } + }, + "TagLimitExceededException": { + "base": null, + "refs": { + } + }, + "TagList": { + "base": null, + "refs": { + "AddTagsInput$Tags": "The key-value pairs to use to create tags. If you specify a key without specifying a value, Amazon ML creates a tag with the specified key and a value of null.
", + "DescribeTagsOutput$Tags": "A list of tags associated with the ML object.
" + } + }, + "TagValue": { + "base": null, + "refs": { + "Tag$Value": "An optional string, typically used to describe or define the tag. Valid characters include Unicode letters, digits, white space, _, ., /, =, +, -, %, and @.
" + } + }, + "TaggableResourceType": { + "base": null, + "refs": { + "AddTagsInput$ResourceType": "The type of the ML object to tag.
", + "AddTagsOutput$ResourceType": "The type of the ML object that was tagged.
", + "DeleteTagsInput$ResourceType": "The type of the tagged ML object.
", + "DeleteTagsOutput$ResourceType": "The type of the ML object from which tags were deleted.
", + "DescribeTagsInput$ResourceType": "The type of the ML object.
", + "DescribeTagsOutput$ResourceType": "The type of the tagged ML object.
" + } + }, + "TrainingParameters": { + "base": null, + "refs": { + "CreateMLModelInput$Parameters": "A list of the training parameters in the MLModel. The list is implemented as a map of key-value pairs.
The following is the current set of training parameters:
sgd.maxMLModelSizeInBytes - The maximum allowed size of the model. Depending on the input data, the size of the model might affect its performance.
The value is an integer that ranges from 100000 to 2147483648. The default value is 33554432.
sgd.maxPasses - The number of times that the training process traverses the observations to build the MLModel. The value is an integer that ranges from 1 to 10000. The default value is 10.
sgd.shuffleType - Whether Amazon ML shuffles the training data. Shuffling the data improves a model's ability to find the optimal solution for a variety of data types. The valid values are auto and none. The default value is none. We strongly recommend that you shuffle your data.
sgd.l1RegularizationAmount - The coefficient regularization L1 norm. It controls overfitting the data by penalizing large coefficients. This tends to drive coefficients to zero, resulting in a sparse feature set. If you use this parameter, start by specifying a small value, such as 1.0E-08.
The value is a double that ranges from 0 to MAX_DOUBLE. The default is to not use L1 normalization. This parameter can't be used when L2 is specified. Use this parameter sparingly.
sgd.l2RegularizationAmount - The coefficient regularization L2 norm. It controls overfitting the data by penalizing large coefficients. This tends to drive coefficients to small, nonzero values. If you use this parameter, start by specifying a small value, such as 1.0E-08.
The value is a double that ranges from 0 to MAX_DOUBLE. The default is to not use L2 normalization. This parameter can't be used when L1 is specified. Use this parameter sparingly.
A list of the training parameters in the MLModel. The list is implemented as a map of key-value pairs.
The following is the current set of training parameters:
sgd.maxMLModelSizeInBytes - The maximum allowed size of the model. Depending on the input data, the size of the model might affect its performance.
The value is an integer that ranges from 100000 to 2147483648. The default value is 33554432.
sgd.maxPasses - The number of times that the training process traverses the observations to build the MLModel. The value is an integer that ranges from 1 to 10000. The default value is 10.
sgd.shuffleType - Whether Amazon ML shuffles the training data. Shuffling data improves a model's ability to find the optimal solution for a variety of data types. The valid values are auto and none. The default value is none. We strongly recommend that you shuffle your data.
sgd.l1RegularizationAmount - The coefficient regularization L1 norm. It controls overfitting the data by penalizing large coefficients. This tends to drive coefficients to zero, resulting in a sparse feature set. If you use this parameter, start by specifying a small value, such as 1.0E-08.
The value is a double that ranges from 0 to MAX_DOUBLE. The default is to not use L1 normalization. This parameter can't be used when L2 is specified. Use this parameter sparingly.
sgd.l2RegularizationAmount - The coefficient regularization L2 norm. It controls overfitting the data by penalizing large coefficients. This tends to drive coefficients to small, nonzero values. If you use this parameter, start by specifying a small value, such as 1.0E-08.
The value is a double that ranges from 0 to MAX_DOUBLE. The default is to not use L2 normalization. This parameter can't be used when L1 is specified. Use this parameter sparingly.
A list of the training parameters in the MLModel. The list is implemented as a map of key-value pairs.
The following is the current set of training parameters:
sgd.maxMLModelSizeInBytes - The maximum allowed size of the model. Depending on the input data, the size of the model might affect its performance.
The value is an integer that ranges from 100000 to 2147483648. The default value is 33554432.
sgd.maxPasses - The number of times that the training process traverses the observations to build the MLModel. The value is an integer that ranges from 1 to 10000. The default value is 10.
sgd.shuffleType - Whether Amazon ML shuffles the training data. Shuffling the data improves a model's ability to find the optimal solution for a variety of data types. The valid values are auto and none. The default value is none.
sgd.l1RegularizationAmount - The coefficient regularization L1 norm, which controls overfitting the data by penalizing large coefficients. This parameter tends to drive coefficients to zero, resulting in sparse feature set. If you use this parameter, start by specifying a small value, such as 1.0E-08.
The value is a double that ranges from 0 to MAX_DOUBLE. The default is to not use L1 normalization. This parameter can't be used when L2 is specified. Use this parameter sparingly.
sgd.l2RegularizationAmount - The coefficient regularization L2 norm, which controls overfitting the data by penalizing large coefficients. This tends to drive coefficients to small, nonzero values. If you use this parameter, start by specifying a small value, such as 1.0E-08.
The value is a double that ranges from 0 to MAX_DOUBLE. The default is to not use L2 normalization. This parameter can't be used when L1 is specified. Use this parameter sparingly.
Represents the output of an UpdateBatchPrediction operation.
You can see the updated content by using the GetBatchPrediction operation.
Represents the output of an UpdateDataSource operation.
You can see the updated content by using the GetBatchPrediction operation.
Represents the output of an UpdateEvaluation operation.
You can see the updated content by using the GetEvaluation operation.
Represents the output of an UpdateMLModel operation.
You can see the updated content by using the GetMLModel operation.
The name of a variable. Currently it's used to specify the name of the target value, label, weight, and tags.
", + "refs": { + "Record$key": null + } + }, + "VariableValue": { + "base": "The value of a variable. Currently it's used to specify values of the target value, weights, and tag variables and for filtering variable values.
", + "refs": { + "Record$value": null + } + }, + "Verbose": { + "base": "Specifies whether a describe operation should return exhaustive or abbreviated information.
", + "refs": { + "GetDataSourceInput$Verbose": "Specifies whether the GetDataSource operation should return DataSourceSchema.
If true, DataSourceSchema is returned.
If false, DataSourceSchema is not returned.
Specifies whether the GetMLModel operation should return Recipe.
If true, Recipe is returned.
If false, Recipe is not returned.
The URI that specifies where to send real-time prediction requests for the MLModel.
The application must wait until the real-time endpoint is ready before using this URI.
REGRESSION MLModel."
+ }
+ }
+ }
+}
diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/machinelearning/2014-12-12/paginators-1.json b/vendor/github.com/aws/aws-sdk-go/models/apis/machinelearning/2014-12-12/paginators-1.json
new file mode 100644
index 000000000..c13ce65af
--- /dev/null
+++ b/vendor/github.com/aws/aws-sdk-go/models/apis/machinelearning/2014-12-12/paginators-1.json
@@ -0,0 +1,28 @@
+{
+ "pagination": {
+ "DescribeBatchPredictions": {
+ "limit_key": "Limit",
+ "output_token": "NextToken",
+ "input_token": "NextToken",
+ "result_key": "Results"
+ },
+ "DescribeDataSources": {
+ "limit_key": "Limit",
+ "output_token": "NextToken",
+ "input_token": "NextToken",
+ "result_key": "Results"
+ },
+ "DescribeEvaluations": {
+ "limit_key": "Limit",
+ "output_token": "NextToken",
+ "input_token": "NextToken",
+ "result_key": "Results"
+ },
+ "DescribeMLModels": {
+ "limit_key": "Limit",
+ "output_token": "NextToken",
+ "input_token": "NextToken",
+ "result_key": "Results"
+ }
+ }
+}
diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/machinelearning/2014-12-12/waiters-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/machinelearning/2014-12-12/waiters-2.json
new file mode 100644
index 000000000..da6b1c951
--- /dev/null
+++ b/vendor/github.com/aws/aws-sdk-go/models/apis/machinelearning/2014-12-12/waiters-2.json
@@ -0,0 +1,81 @@
+{
+ "version": 2,
+ "waiters": {
+ "DataSourceAvailable": {
+ "delay": 30,
+ "operation": "DescribeDataSources",
+ "maxAttempts": 60,
+ "acceptors": [
+ {
+ "expected": "COMPLETED",
+ "matcher": "pathAll",
+ "state": "success",
+ "argument": "Results[].Status"
+ },
+ {
+ "expected": "FAILED",
+ "matcher": "pathAny",
+ "state": "failure",
+ "argument": "Results[].Status"
+ }
+ ]
+ },
+ "MLModelAvailable": {
+ "delay": 30,
+ "operation": "DescribeMLModels",
+ "maxAttempts": 60,
+ "acceptors": [
+ {
+ "expected": "COMPLETED",
+ "matcher": "pathAll",
+ "state": "success",
+ "argument": "Results[].Status"
+ },
+ {
+ "expected": "FAILED",
+ "matcher": "pathAny",
+ "state": "failure",
+ "argument": "Results[].Status"
+ }
+ ]
+ },
+ "EvaluationAvailable": {
+ "delay": 30,
+ "operation": "DescribeEvaluations",
+ "maxAttempts": 60,
+ "acceptors": [
+ {
+ "expected": "COMPLETED",
+ "matcher": "pathAll",
+ "state": "success",
+ "argument": "Results[].Status"
+ },
+ {
+ "expected": "FAILED",
+ "matcher": "pathAny",
+ "state": "failure",
+ "argument": "Results[].Status"
+ }
+ ]
+ },
+ "BatchPredictionAvailable": {
+ "delay": 30,
+ "operation": "DescribeBatchPredictions",
+ "maxAttempts": 60,
+ "acceptors": [
+ {
+ "expected": "COMPLETED",
+ "matcher": "pathAll",
+ "state": "success",
+ "argument": "Results[].Status"
+ },
+ {
+ "expected": "FAILED",
+ "matcher": "pathAny",
+ "state": "failure",
+ "argument": "Results[].Status"
+ }
+ ]
+ }
+ }
+}
diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/marketplacecommerceanalytics/2015-07-01/api-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/marketplacecommerceanalytics/2015-07-01/api-2.json
new file mode 100644
index 000000000..fa343e101
--- /dev/null
+++ b/vendor/github.com/aws/aws-sdk-go/models/apis/marketplacecommerceanalytics/2015-07-01/api-2.json
@@ -0,0 +1,120 @@
+{
+ "version":"2.0",
+ "metadata":{
+ "apiVersion":"2015-07-01",
+ "endpointPrefix":"marketplacecommerceanalytics",
+ "jsonVersion":"1.1",
+ "protocol":"json",
+ "serviceFullName":"AWS Marketplace Commerce Analytics",
+ "signatureVersion":"v4",
+ "signingName":"marketplacecommerceanalytics",
+ "targetPrefix":"MarketplaceCommerceAnalytics20150701"
+ },
+ "operations":{
+ "GenerateDataSet":{
+ "name":"GenerateDataSet",
+ "http":{
+ "method":"POST",
+ "requestUri":"/"
+ },
+ "input":{"shape":"GenerateDataSetRequest"},
+ "output":{"shape":"GenerateDataSetResult"},
+ "errors":[
+ {"shape":"MarketplaceCommerceAnalyticsException"}
+ ]
+ }
+ },
+ "shapes":{
+ "CustomerDefinedValues":{
+ "type":"map",
+ "key":{"shape":"OptionalKey"},
+ "value":{"shape":"OptionalValue"},
+ "max":5,
+ "min":1
+ },
+ "DataSetPublicationDate":{"type":"timestamp"},
+ "DataSetRequestId":{"type":"string"},
+ "DataSetType":{
+ "type":"string",
+ "enum":[
+ "customer_subscriber_hourly_monthly_subscriptions",
+ "customer_subscriber_annual_subscriptions",
+ "daily_business_usage_by_instance_type",
+ "daily_business_fees",
+ "daily_business_free_trial_conversions",
+ "daily_business_new_instances",
+ "daily_business_new_product_subscribers",
+ "daily_business_canceled_product_subscribers",
+ "monthly_revenue_billing_and_revenue_data",
+ "monthly_revenue_annual_subscriptions",
+ "disbursed_amount_by_product",
+ "disbursed_amount_by_product_with_uncollected_funds",
+ "disbursed_amount_by_customer_geo",
+ "disbursed_amount_by_age_of_uncollected_funds",
+ "disbursed_amount_by_age_of_disbursed_funds",
+ "customer_profile_by_industry",
+ "customer_profile_by_revenue",
+ "customer_profile_by_geography"
+ ],
+ "max":255,
+ "min":1
+ },
+ "DestinationS3BucketName":{
+ "type":"string",
+ "min":1
+ },
+ "DestinationS3Prefix":{"type":"string"},
+ "ExceptionMessage":{"type":"string"},
+ "GenerateDataSetRequest":{
+ "type":"structure",
+ "required":[
+ "dataSetType",
+ "dataSetPublicationDate",
+ "roleNameArn",
+ "destinationS3BucketName",
+ "snsTopicArn"
+ ],
+ "members":{
+ "dataSetType":{"shape":"DataSetType"},
+ "dataSetPublicationDate":{"shape":"DataSetPublicationDate"},
+ "roleNameArn":{"shape":"RoleNameArn"},
+ "destinationS3BucketName":{"shape":"DestinationS3BucketName"},
+ "destinationS3Prefix":{"shape":"DestinationS3Prefix"},
+ "snsTopicArn":{"shape":"SnsTopicArn"},
+ "customerDefinedValues":{"shape":"CustomerDefinedValues"}
+ }
+ },
+ "GenerateDataSetResult":{
+ "type":"structure",
+ "members":{
+ "dataSetRequestId":{"shape":"DataSetRequestId"}
+ }
+ },
+ "MarketplaceCommerceAnalyticsException":{
+ "type":"structure",
+ "members":{
+ "message":{"shape":"ExceptionMessage"}
+ },
+ "exception":true,
+ "fault":true
+ },
+ "OptionalKey":{
+ "type":"string",
+ "max":255,
+ "min":1
+ },
+ "OptionalValue":{
+ "type":"string",
+ "max":255,
+ "min":1
+ },
+ "RoleNameArn":{
+ "type":"string",
+ "min":1
+ },
+ "SnsTopicArn":{
+ "type":"string",
+ "min":1
+ }
+ }
+}
diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/marketplacecommerceanalytics/2015-07-01/docs-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/marketplacecommerceanalytics/2015-07-01/docs-2.json
new file mode 100644
index 000000000..8d17a391f
--- /dev/null
+++ b/vendor/github.com/aws/aws-sdk-go/models/apis/marketplacecommerceanalytics/2015-07-01/docs-2.json
@@ -0,0 +1,90 @@
+{
+ "version": "2.0",
+ "service": "Provides AWS Marketplace business intelligence data on-demand.",
+ "operations": {
+ "GenerateDataSet": "Given a data set type and data set publication date, asynchronously publishes the requested data set to the specified S3 bucket and notifies the specified SNS topic once the data is available. Returns a unique request identifier that can be used to correlate requests with notifications from the SNS topic. Data sets will be published in comma-separated values (CSV) format with the file name {data_set_type}_YYYY-MM-DD.csv. If a file with the same name already exists (e.g. if the same data set is requested twice), the original file will be overwritten by the new file. Requires a Role with an attached permissions policy providing Allow permissions for the following actions: s3:PutObject, s3:GetBucketLocation, sns:GetTopicAttributes, sns:Publish, iam:GetRolePolicy."
+ },
+ "shapes": {
+ "CustomerDefinedValues": {
+ "base": null,
+ "refs": {
+ "GenerateDataSetRequest$customerDefinedValues": "(Optional) Key-value pairs which will be returned, unmodified, in the Amazon SNS notification message and the data set metadata file. These key-value pairs can be used to correlated responses with tracking information from other systems."
+ }
+ },
+ "DataSetPublicationDate": {
+ "base": null,
+ "refs": {
+ "GenerateDataSetRequest$dataSetPublicationDate": "The date a data set was published. For daily data sets, provide a date with day-level granularity for the desired day. For weekly data sets, provide a date with day-level granularity within the desired week (the day value will be ignored). For monthly data sets, provide a date with month-level granularity for the desired month (the day value will be ignored)."
+ }
+ },
+ "DataSetRequestId": {
+ "base": null,
+ "refs": {
+ "GenerateDataSetResult$dataSetRequestId": "A unique identifier representing a specific request to the GenerateDataSet operation. This identifier can be used to correlate a request with notifications from the SNS topic."
+ }
+ },
+ "DataSetType": {
+ "base": null,
+ "refs": {
+ "GenerateDataSetRequest$dataSetType": "The desired data set type.
This reference provides descriptions of the low-level AWS Marketplace Metering Service API.
AWS Marketplace sellers can use this API to submit usage data for custom usage dimensions.
Submitting Metering Records
MeterUsage- Submits the metering record for a Marketplace product.
API to emit metering records. For identical requests, the API is idempotent. It simply returns the metering record ID.
" + }, + "shapes": { + "Boolean": { + "base": null, + "refs": { + "MeterUsageRequest$DryRun": "Checks whether you have the permissions required for the action, but does not make the request. If you have the permissions, the request returns DryRunOperation; otherwise, it returns UnauthorizedException.
" + } + }, + "DuplicateRequestException": { + "base": "A metering record has already been emitted by the same EC2 instance for the given {usageDimension, timestamp} with a different usageQuantity.
", + "refs": { + } + }, + "InternalServiceErrorException": { + "base": "An internal error has occurred. Retry your request. If the problem persists, post a message with details on the AWS forums.
", + "refs": { + } + }, + "InvalidEndpointRegionException": { + "base": "The endpoint being called is in a region different from your EC2 instance. The region of the Metering service endpoint and the region of the EC2 instance must match.
", + "refs": { + } + }, + "InvalidProductCodeException": { + "base": "The product code passed does not match the product code used for publishing the product.
", + "refs": { + } + }, + "InvalidUsageDimensionException": { + "base": "The usage dimension does not match one of the UsageDimensions associated with products.
", + "refs": { + } + }, + "MeterUsageRequest": { + "base": null, + "refs": { + } + }, + "MeterUsageResult": { + "base": null, + "refs": { + } + }, + "ProductCode": { + "base": null, + "refs": { + "MeterUsageRequest$ProductCode": "Product code is used to uniquely identify a product in AWS Marketplace. The product code should be the same as the one used during the publishing of a new product.
" + } + }, + "String": { + "base": null, + "refs": { + "MeterUsageResult$MeteringRecordId": null + } + }, + "ThrottlingException": { + "base": "The calls to the MeterUsage API are throttled.
", + "refs": { + } + }, + "Timestamp": { + "base": null, + "refs": { + "MeterUsageRequest$Timestamp": "Timestamp of the hour, recorded in UTC. The seconds and milliseconds portions of the timestamp will be ignored.
" + } + }, + "TimestampOutOfBoundsException": { + "base": "The timestamp value passed in the meterUsage() is out of allowed range.
", + "refs": { + } + }, + "UsageDimension": { + "base": null, + "refs": { + "MeterUsageRequest$UsageDimension": "It will be one of the 'fcp dimension name' provided during the publishing of the product.
" + } + }, + "UsageQuantity": { + "base": null, + "refs": { + "MeterUsageRequest$UsageQuantity": "Consumption value for the hour.
" + } + }, + "errorMessage": { + "base": null, + "refs": { + "DuplicateRequestException$message": null, + "InternalServiceErrorException$message": null, + "InvalidEndpointRegionException$message": null, + "InvalidProductCodeException$message": null, + "InvalidUsageDimensionException$message": null, + "ThrottlingException$message": null, + "TimestampOutOfBoundsException$message": null + } + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/meteringmarketplace/2016-01-14/examples-1.json b/vendor/github.com/aws/aws-sdk-go/models/apis/meteringmarketplace/2016-01-14/examples-1.json new file mode 100644 index 000000000..0ea7e3b0b --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/meteringmarketplace/2016-01-14/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/mobileanalytics/2014-06-05/api-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/mobileanalytics/2014-06-05/api-2.json new file mode 100644 index 000000000..c593da2a9 --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/mobileanalytics/2014-06-05/api-2.json @@ -0,0 +1,119 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2014-06-05", + "endpointPrefix":"mobileanalytics", + "serviceFullName":"Amazon Mobile Analytics", + "signatureVersion":"v4", + "protocol":"rest-json" + }, + "operations":{ + "PutEvents":{ + "name":"PutEvents", + "http":{ + "method":"POST", + "requestUri":"/2014-06-05/events", + "responseCode":202 + }, + "input":{"shape":"PutEventsInput"}, + "errors":[ + { + "shape":"BadRequestException", + "error":{"httpStatusCode":400}, + "exception":true + } + ] + } + }, + "shapes":{ + "BadRequestException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "Double":{"type":"double"}, + "Event":{ + "type":"structure", + "required":[ + "eventType", + "timestamp" + ], + "members":{ + "eventType":{"shape":"String50Chars"}, + "timestamp":{"shape":"ISO8601Timestamp"}, + "session":{"shape":"Session"}, + "version":{"shape":"String10Chars"}, + "attributes":{"shape":"MapOfStringToString"}, + "metrics":{"shape":"MapOfStringToNumber"} + } + }, + "EventListDefinition":{ + "type":"list", + "member":{"shape":"Event"} + }, + "ISO8601Timestamp":{"type":"string"}, + "Long":{"type":"long"}, + "MapOfStringToNumber":{ + "type":"map", + "key":{"shape":"String50Chars"}, + "value":{"shape":"Double"}, + "min":0, + "max":50 + }, + "MapOfStringToString":{ + "type":"map", + "key":{"shape":"String50Chars"}, + "value":{"shape":"String0to1000Chars"}, + "min":0, + "max":50 + }, + "PutEventsInput":{ + "type":"structure", + "required":[ + "events", + "clientContext" + ], + "members":{ + "events":{"shape":"EventListDefinition"}, + "clientContext":{ + "shape":"String", + "location":"header", + "locationName":"x-amz-Client-Context" + }, + "clientContextEncoding":{ + "shape":"String", + "location":"header", + "locationName":"x-amz-Client-Context-Encoding" + } + } + }, + "Session":{ + "type":"structure", + "members":{ + "id":{"shape":"String50Chars"}, + "duration":{"shape":"Long"}, + "startTimestamp":{"shape":"ISO8601Timestamp"}, + "stopTimestamp":{"shape":"ISO8601Timestamp"} + } + }, + "String":{"type":"string"}, + "String0to1000Chars":{ + "type":"string", + "min":0, + "max":1000 + }, + "String10Chars":{ + "type":"string", + "min":1, + "max":10 + }, + "String50Chars":{ + "type":"string", + "min":1, + "max":50 + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/mobileanalytics/2014-06-05/docs-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/mobileanalytics/2014-06-05/docs-2.json new file mode 100644 index 000000000..838e32f7e --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/mobileanalytics/2014-06-05/docs-2.json @@ -0,0 +1,98 @@ +{ + "version": "2.0", + "operations": { + "PutEvents": "The PutEvents operation records one or more events. You can have up to 1,500 unique custom events per app, any combination of up to 40 attributes and metrics per custom event, and any number of attribute or metric values.
" + }, + "service": "Amazon Mobile Analytics is a service for collecting, visualizing, and understanding app usage data at scale.
", + "shapes": { + "BadRequestException": { + "base": "An exception object returned when a request fails.
", + "refs": { + } + }, + "Double": { + "base": null, + "refs": { + "MapOfStringToNumber$value": null + } + }, + "Event": { + "base": "A JSON object representing a batch of unique event occurrences in your app.
", + "refs": { + "EventListDefinition$member": null + } + }, + "EventListDefinition": { + "base": null, + "refs": { + "PutEventsInput$events": "An array of Event JSON objects
" + } + }, + "ISO8601Timestamp": { + "base": null, + "refs": { + "Event$timestamp": "The time the event occurred in ISO 8601 standard date time format. For example, 2014-06-30T19:07:47.885Z
", + "Session$startTimestamp": "The time the event started in ISO 8601 standard date time format. For example, 2014-06-30T19:07:47.885Z
", + "Session$stopTimestamp": "The time the event terminated in ISO 8601 standard date time format. For example, 2014-06-30T19:07:47.885Z
" + } + }, + "Long": { + "base": null, + "refs": { + "Session$duration": "The duration of the session.
" + } + }, + "MapOfStringToNumber": { + "base": null, + "refs": { + "Event$metrics": "A collection of key-value pairs that gives additional, measurable context to the event. The key-value pairs are specified by the developer.
This collection can be empty or the attribute object can be omitted.
" + } + }, + "MapOfStringToString": { + "base": null, + "refs": { + "Event$attributes": "A collection of key-value pairs that give additional context to the event. The key-value pairs are specified by the developer.
This collection can be empty or the attribute object can be omitted.
" + } + }, + "PutEventsInput": { + "base": "A container for the data needed for a PutEvent operation
", + "refs": { + } + }, + "Session": { + "base": "Describes the session. Session information is required on ALL events.
", + "refs": { + "Event$session": "The session the event occured within.
" + } + }, + "String": { + "base": null, + "refs": { + "BadRequestException$message": "A text description associated with the BadRequestException object.
", + "PutEventsInput$clientContext": "The client context including the client ID, app title, app version and package name.
", + "PutEventsInput$clientContextEncoding": "The encoding used for the client context.
" + } + }, + "String0to1000Chars": { + "base": null, + "refs": { + "MapOfStringToString$value": null + } + }, + "String10Chars": { + "base": null, + "refs": { + "Event$version": "The version of the event.
" + } + }, + "String50Chars": { + "base": null, + "refs": { + "Event$eventType": "A name signifying an event that occurred in your app. This is used for grouping and aggregating like events together for reporting purposes.
", + "MapOfStringToNumber$key": null, + "MapOfStringToString$key": null, + "Session$id": "A unique identifier for the session
" + } + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/monitoring/2010-08-01/api-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/monitoring/2010-08-01/api-2.json new file mode 100644 index 000000000..cbc0f069e --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/monitoring/2010-08-01/api-2.json @@ -0,0 +1,790 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2010-08-01", + "endpointPrefix":"monitoring", + "protocol":"query", + "serviceAbbreviation":"CloudWatch", + "serviceFullName":"Amazon CloudWatch", + "signatureVersion":"v4", + "xmlNamespace":"http://monitoring.amazonaws.com/doc/2010-08-01/" + }, + "operations":{ + "DeleteAlarms":{ + "name":"DeleteAlarms", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteAlarmsInput"}, + "errors":[ + {"shape":"ResourceNotFound"} + ] + }, + "DescribeAlarmHistory":{ + "name":"DescribeAlarmHistory", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAlarmHistoryInput"}, + "output":{ + "shape":"DescribeAlarmHistoryOutput", + "resultWrapper":"DescribeAlarmHistoryResult" + }, + "errors":[ + {"shape":"InvalidNextToken"} + ] + }, + "DescribeAlarms":{ + "name":"DescribeAlarms", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAlarmsInput"}, + "output":{ + "shape":"DescribeAlarmsOutput", + "resultWrapper":"DescribeAlarmsResult" + }, + "errors":[ + {"shape":"InvalidNextToken"} + ] + }, + "DescribeAlarmsForMetric":{ + "name":"DescribeAlarmsForMetric", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAlarmsForMetricInput"}, + "output":{ + "shape":"DescribeAlarmsForMetricOutput", + "resultWrapper":"DescribeAlarmsForMetricResult" + } + }, + "DisableAlarmActions":{ + "name":"DisableAlarmActions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisableAlarmActionsInput"} + }, + "EnableAlarmActions":{ + "name":"EnableAlarmActions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"EnableAlarmActionsInput"} + }, + "GetMetricStatistics":{ + "name":"GetMetricStatistics", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetMetricStatisticsInput"}, + "output":{ + "shape":"GetMetricStatisticsOutput", + "resultWrapper":"GetMetricStatisticsResult" + }, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingRequiredParameterException"}, + {"shape":"InvalidParameterCombinationException"}, + {"shape":"InternalServiceFault"} + ] + }, + "ListMetrics":{ + "name":"ListMetrics", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListMetricsInput"}, + "output":{ + "shape":"ListMetricsOutput", + "resultWrapper":"ListMetricsResult" + }, + "errors":[ + {"shape":"InternalServiceFault"}, + {"shape":"InvalidParameterValueException"} + ] + }, + "PutMetricAlarm":{ + "name":"PutMetricAlarm", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutMetricAlarmInput"}, + "errors":[ + {"shape":"LimitExceededFault"} + ] + }, + "PutMetricData":{ + "name":"PutMetricData", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutMetricDataInput"}, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingRequiredParameterException"}, + {"shape":"InvalidParameterCombinationException"}, + {"shape":"InternalServiceFault"} + ] + }, + "SetAlarmState":{ + "name":"SetAlarmState", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SetAlarmStateInput"}, + "errors":[ + {"shape":"ResourceNotFound"}, + {"shape":"InvalidFormatFault"} + ] + } + }, + "shapes":{ + "ActionPrefix":{ + "type":"string", + "max":1024, + "min":1 + }, + "ActionsEnabled":{"type":"boolean"}, + "AlarmArn":{ + "type":"string", + "max":1600, + "min":1 + }, + "AlarmDescription":{ + "type":"string", + "max":1024, + "min":0 + }, + "AlarmHistoryItem":{ + "type":"structure", + "members":{ + "AlarmName":{"shape":"AlarmName"}, + "Timestamp":{"shape":"Timestamp"}, + "HistoryItemType":{"shape":"HistoryItemType"}, + "HistorySummary":{"shape":"HistorySummary"}, + "HistoryData":{"shape":"HistoryData"} + } + }, + "AlarmHistoryItems":{ + "type":"list", + "member":{"shape":"AlarmHistoryItem"} + }, + "AlarmName":{ + "type":"string", + "max":255, + "min":1 + }, + "AlarmNamePrefix":{ + "type":"string", + "max":255, + "min":1 + }, + "AlarmNames":{ + "type":"list", + "member":{"shape":"AlarmName"}, + "max":100 + }, + "AwsQueryErrorMessage":{"type":"string"}, + "ComparisonOperator":{ + "type":"string", + "enum":[ + "GreaterThanOrEqualToThreshold", + "GreaterThanThreshold", + "LessThanThreshold", + "LessThanOrEqualToThreshold" + ] + }, + "Datapoint":{ + "type":"structure", + "members":{ + "Timestamp":{"shape":"Timestamp"}, + "SampleCount":{"shape":"DatapointValue"}, + "Average":{"shape":"DatapointValue"}, + "Sum":{"shape":"DatapointValue"}, + "Minimum":{"shape":"DatapointValue"}, + "Maximum":{"shape":"DatapointValue"}, + "Unit":{"shape":"StandardUnit"} + }, + "xmlOrder":[ + "Timestamp", + "SampleCount", + "Average", + "Sum", + "Minimum", + "Maximum", + "Unit" + ] + }, + "DatapointValue":{"type":"double"}, + "Datapoints":{ + "type":"list", + "member":{"shape":"Datapoint"} + }, + "DeleteAlarmsInput":{ + "type":"structure", + "required":["AlarmNames"], + "members":{ + "AlarmNames":{"shape":"AlarmNames"} + } + }, + "DescribeAlarmHistoryInput":{ + "type":"structure", + "members":{ + "AlarmName":{"shape":"AlarmName"}, + "HistoryItemType":{"shape":"HistoryItemType"}, + "StartDate":{"shape":"Timestamp"}, + "EndDate":{"shape":"Timestamp"}, + "MaxRecords":{"shape":"MaxRecords"}, + "NextToken":{"shape":"NextToken"} + } + }, + "DescribeAlarmHistoryOutput":{ + "type":"structure", + "members":{ + "AlarmHistoryItems":{"shape":"AlarmHistoryItems"}, + "NextToken":{"shape":"NextToken"} + } + }, + "DescribeAlarmsForMetricInput":{ + "type":"structure", + "required":[ + "MetricName", + "Namespace" + ], + "members":{ + "MetricName":{"shape":"MetricName"}, + "Namespace":{"shape":"Namespace"}, + "Statistic":{"shape":"Statistic"}, + "Dimensions":{"shape":"Dimensions"}, + "Period":{"shape":"Period"}, + "Unit":{"shape":"StandardUnit"} + } + }, + "DescribeAlarmsForMetricOutput":{ + "type":"structure", + "members":{ + "MetricAlarms":{"shape":"MetricAlarms"} + } + }, + "DescribeAlarmsInput":{ + "type":"structure", + "members":{ + "AlarmNames":{"shape":"AlarmNames"}, + "AlarmNamePrefix":{"shape":"AlarmNamePrefix"}, + "StateValue":{"shape":"StateValue"}, + "ActionPrefix":{"shape":"ActionPrefix"}, + "MaxRecords":{"shape":"MaxRecords"}, + "NextToken":{"shape":"NextToken"} + } + }, + "DescribeAlarmsOutput":{ + "type":"structure", + "members":{ + "MetricAlarms":{"shape":"MetricAlarms"}, + "NextToken":{"shape":"NextToken"} + } + }, + "Dimension":{ + "type":"structure", + "required":[ + "Name", + "Value" + ], + "members":{ + "Name":{"shape":"DimensionName"}, + "Value":{"shape":"DimensionValue"} + }, + "xmlOrder":[ + "Name", + "Value" + ] + }, + "DimensionFilter":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{"shape":"DimensionName"}, + "Value":{"shape":"DimensionValue"} + } + }, + "DimensionFilters":{ + "type":"list", + "member":{"shape":"DimensionFilter"}, + "max":10 + }, + "DimensionName":{ + "type":"string", + "max":255, + "min":1 + }, + "DimensionValue":{ + "type":"string", + "max":255, + "min":1 + }, + "Dimensions":{ + "type":"list", + "member":{"shape":"Dimension"}, + "max":10 + }, + "DisableAlarmActionsInput":{ + "type":"structure", + "required":["AlarmNames"], + "members":{ + "AlarmNames":{"shape":"AlarmNames"} + } + }, + "EnableAlarmActionsInput":{ + "type":"structure", + "required":["AlarmNames"], + "members":{ + "AlarmNames":{"shape":"AlarmNames"} + } + }, + "ErrorMessage":{ + "type":"string", + "max":255, + "min":1 + }, + "EvaluationPeriods":{ + "type":"integer", + "min":1 + }, + "FaultDescription":{"type":"string"}, + "GetMetricStatisticsInput":{ + "type":"structure", + "required":[ + "Namespace", + "MetricName", + "StartTime", + "EndTime", + "Period", + "Statistics" + ], + "members":{ + "Namespace":{"shape":"Namespace"}, + "MetricName":{"shape":"MetricName"}, + "Dimensions":{"shape":"Dimensions"}, + "StartTime":{"shape":"Timestamp"}, + "EndTime":{"shape":"Timestamp"}, + "Period":{"shape":"Period"}, + "Statistics":{"shape":"Statistics"}, + "Unit":{"shape":"StandardUnit"} + } + }, + "GetMetricStatisticsOutput":{ + "type":"structure", + "members":{ + "Label":{"shape":"MetricLabel"}, + "Datapoints":{"shape":"Datapoints"} + } + }, + "HistoryData":{ + "type":"string", + "max":4095, + "min":1 + }, + "HistoryItemType":{ + "type":"string", + "enum":[ + "ConfigurationUpdate", + "StateUpdate", + "Action" + ] + }, + "HistorySummary":{ + "type":"string", + "max":255, + "min":1 + }, + "InternalServiceFault":{ + "type":"structure", + "members":{ + "Message":{"shape":"FaultDescription"} + }, + "error":{ + "code":"InternalServiceError", + "httpStatusCode":500 + }, + "exception":true, + "xmlOrder":["Message"] + }, + "InvalidFormatFault":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "error":{ + "code":"InvalidFormat", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidNextToken":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "error":{ + "code":"InvalidNextToken", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidParameterCombinationException":{ + "type":"structure", + "members":{ + "message":{"shape":"AwsQueryErrorMessage"} + }, + "error":{ + "code":"InvalidParameterCombination", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidParameterValueException":{ + "type":"structure", + "members":{ + "message":{"shape":"AwsQueryErrorMessage"} + }, + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "LimitExceededFault":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "error":{ + "code":"LimitExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ListMetricsInput":{ + "type":"structure", + "members":{ + "Namespace":{"shape":"Namespace"}, + "MetricName":{"shape":"MetricName"}, + "Dimensions":{"shape":"DimensionFilters"}, + "NextToken":{"shape":"NextToken"} + } + }, + "ListMetricsOutput":{ + "type":"structure", + "members":{ + "Metrics":{"shape":"Metrics"}, + "NextToken":{"shape":"NextToken"} + }, + "xmlOrder":[ + "Metrics", + "NextToken" + ] + }, + "MaxRecords":{ + "type":"integer", + "max":100, + "min":1 + }, + "Metric":{ + "type":"structure", + "members":{ + "Namespace":{"shape":"Namespace"}, + "MetricName":{"shape":"MetricName"}, + "Dimensions":{"shape":"Dimensions"} + }, + "xmlOrder":[ + "Namespace", + "MetricName", + "Dimensions" + ] + }, + "MetricAlarm":{ + "type":"structure", + "members":{ + "AlarmName":{"shape":"AlarmName"}, + "AlarmArn":{"shape":"AlarmArn"}, + "AlarmDescription":{"shape":"AlarmDescription"}, + "AlarmConfigurationUpdatedTimestamp":{"shape":"Timestamp"}, + "ActionsEnabled":{"shape":"ActionsEnabled"}, + "OKActions":{"shape":"ResourceList"}, + "AlarmActions":{"shape":"ResourceList"}, + "InsufficientDataActions":{"shape":"ResourceList"}, + "StateValue":{"shape":"StateValue"}, + "StateReason":{"shape":"StateReason"}, + "StateReasonData":{"shape":"StateReasonData"}, + "StateUpdatedTimestamp":{"shape":"Timestamp"}, + "MetricName":{"shape":"MetricName"}, + "Namespace":{"shape":"Namespace"}, + "Statistic":{"shape":"Statistic"}, + "Dimensions":{"shape":"Dimensions"}, + "Period":{"shape":"Period"}, + "Unit":{"shape":"StandardUnit"}, + "EvaluationPeriods":{"shape":"EvaluationPeriods"}, + "Threshold":{"shape":"Threshold"}, + "ComparisonOperator":{"shape":"ComparisonOperator"} + }, + "xmlOrder":[ + "AlarmName", + "AlarmArn", + "AlarmDescription", + "AlarmConfigurationUpdatedTimestamp", + "ActionsEnabled", + "OKActions", + "AlarmActions", + "InsufficientDataActions", + "StateValue", + "StateReason", + "StateReasonData", + "StateUpdatedTimestamp", + "MetricName", + "Namespace", + "Statistic", + "Dimensions", + "Period", + "Unit", + "EvaluationPeriods", + "Threshold", + "ComparisonOperator" + ] + }, + "MetricAlarms":{ + "type":"list", + "member":{"shape":"MetricAlarm"} + }, + "MetricData":{ + "type":"list", + "member":{"shape":"MetricDatum"} + }, + "MetricDatum":{ + "type":"structure", + "required":["MetricName"], + "members":{ + "MetricName":{"shape":"MetricName"}, + "Dimensions":{"shape":"Dimensions"}, + "Timestamp":{"shape":"Timestamp"}, + "Value":{"shape":"DatapointValue"}, + "StatisticValues":{"shape":"StatisticSet"}, + "Unit":{"shape":"StandardUnit"} + } + }, + "MetricLabel":{"type":"string"}, + "MetricName":{ + "type":"string", + "max":255, + "min":1 + }, + "Metrics":{ + "type":"list", + "member":{"shape":"Metric"} + }, + "MissingRequiredParameterException":{ + "type":"structure", + "members":{ + "message":{"shape":"AwsQueryErrorMessage"} + }, + "error":{ + "code":"MissingParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "Namespace":{ + "type":"string", + "max":255, + "min":1, + "pattern":"[^:].*" + }, + "NextToken":{ + "type":"string", + "max":1024, + "min":0 + }, + "Period":{ + "type":"integer", + "min":60 + }, + "PutMetricAlarmInput":{ + "type":"structure", + "required":[ + "AlarmName", + "MetricName", + "Namespace", + "Statistic", + "Period", + "EvaluationPeriods", + "Threshold", + "ComparisonOperator" + ], + "members":{ + "AlarmName":{"shape":"AlarmName"}, + "AlarmDescription":{"shape":"AlarmDescription"}, + "ActionsEnabled":{"shape":"ActionsEnabled"}, + "OKActions":{"shape":"ResourceList"}, + "AlarmActions":{"shape":"ResourceList"}, + "InsufficientDataActions":{"shape":"ResourceList"}, + "MetricName":{"shape":"MetricName"}, + "Namespace":{"shape":"Namespace"}, + "Statistic":{"shape":"Statistic"}, + "Dimensions":{"shape":"Dimensions"}, + "Period":{"shape":"Period"}, + "Unit":{"shape":"StandardUnit"}, + "EvaluationPeriods":{"shape":"EvaluationPeriods"}, + "Threshold":{"shape":"Threshold"}, + "ComparisonOperator":{"shape":"ComparisonOperator"} + } + }, + "PutMetricDataInput":{ + "type":"structure", + "required":[ + "Namespace", + "MetricData" + ], + "members":{ + "Namespace":{"shape":"Namespace"}, + "MetricData":{"shape":"MetricData"} + } + }, + "ResourceList":{ + "type":"list", + "member":{"shape":"ResourceName"}, + "max":5 + }, + "ResourceName":{ + "type":"string", + "max":1024, + "min":1 + }, + "ResourceNotFound":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "SetAlarmStateInput":{ + "type":"structure", + "required":[ + "AlarmName", + "StateValue", + "StateReason" + ], + "members":{ + "AlarmName":{"shape":"AlarmName"}, + "StateValue":{"shape":"StateValue"}, + "StateReason":{"shape":"StateReason"}, + "StateReasonData":{"shape":"StateReasonData"} + } + }, + "StandardUnit":{ + "type":"string", + "enum":[ + "Seconds", + "Microseconds", + "Milliseconds", + "Bytes", + "Kilobytes", + "Megabytes", + "Gigabytes", + "Terabytes", + "Bits", + "Kilobits", + "Megabits", + "Gigabits", + "Terabits", + "Percent", + "Count", + "Bytes/Second", + "Kilobytes/Second", + "Megabytes/Second", + "Gigabytes/Second", + "Terabytes/Second", + "Bits/Second", + "Kilobits/Second", + "Megabits/Second", + "Gigabits/Second", + "Terabits/Second", + "Count/Second", + "None" + ] + }, + "StateReason":{ + "type":"string", + "max":1023, + "min":0 + }, + "StateReasonData":{ + "type":"string", + "max":4000, + "min":0 + }, + "StateValue":{ + "type":"string", + "enum":[ + "OK", + "ALARM", + "INSUFFICIENT_DATA" + ] + }, + "Statistic":{ + "type":"string", + "enum":[ + "SampleCount", + "Average", + "Sum", + "Minimum", + "Maximum" + ] + }, + "StatisticSet":{ + "type":"structure", + "required":[ + "SampleCount", + "Sum", + "Minimum", + "Maximum" + ], + "members":{ + "SampleCount":{"shape":"DatapointValue"}, + "Sum":{"shape":"DatapointValue"}, + "Minimum":{"shape":"DatapointValue"}, + "Maximum":{"shape":"DatapointValue"} + } + }, + "Statistics":{ + "type":"list", + "member":{"shape":"Statistic"}, + "max":5, + "min":1 + }, + "Threshold":{"type":"double"}, + "Timestamp":{"type":"timestamp"} + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/monitoring/2010-08-01/docs-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/monitoring/2010-08-01/docs-2.json new file mode 100644 index 000000000..5f8d03b84 --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/monitoring/2010-08-01/docs-2.json @@ -0,0 +1,515 @@ +{ + "version": "2.0", + "service": "Amazon CloudWatch monitors your Amazon Web Services (AWS) resources and the applications you run on AWS in real-time. You can use CloudWatch to collect and track metrics, which are the variables you want to measure for your resources and applications.
CloudWatch alarms send notifications or automatically make changes to the resources you are monitoring based on rules that you define. For example, you can monitor the CPU usage and disk reads and writes of your Amazon Elastic Compute Cloud (Amazon EC2) instances and then use this data to determine whether you should launch additional instances to handle increased load. You can also use this data to stop under-used instances to save money.
In addition to monitoring the built-in metrics that come with AWS, you can monitor your own custom metrics. With CloudWatch, you gain system-wide visibility into resource utilization, application performance, and operational health.
", + "operations": { + "DeleteAlarms": "Deletes all specified alarms. In the event of an error, no alarms are deleted.
", + "DescribeAlarmHistory": "Retrieves history for the specified alarm. Filter alarms by date range or item type. If an alarm name is not specified, Amazon CloudWatch returns histories for all of the owner's alarms.
Retrieves alarms with the specified names. If no name is specified, all alarms for the user are returned. Alarms can be retrieved by using only a prefix for the alarm name, the alarm state, or a prefix for any action.
", + "DescribeAlarmsForMetric": "Retrieves all alarms for a single metric. Specify a statistic, period, or unit to filter the set of alarms further.
", + "DisableAlarmActions": "Disables actions for the specified alarms. When an alarm's actions are disabled the alarm's state may change, but none of the alarm's actions will execute.
", + "EnableAlarmActions": "Enables actions for the specified alarms.
", + "GetMetricStatistics": "Gets statistics for the specified metric.
The maximum number of data points that can be queried is 50,850, whereas the maximum number of data points returned from a single GetMetricStatistics request is 1,440. If you make a request that generates more than 1,440 data points, Amazon CloudWatch returns an error. In such a case, you can alter the request by narrowing the specified time range or increasing the specified period. Alternatively, you can make multiple requests across adjacent time ranges. GetMetricStatistics does not return the data in chronological order.
Amazon CloudWatch aggregates data points based on the length of the period that you specify. For example, if you request statistics with a one-minute granularity, Amazon CloudWatch aggregates data points with time stamps that fall within the same one-minute period. In such a case, the data points queried can greatly outnumber the data points returned.
The following examples show various statistics allowed by the data point query maximum of 50,850 when you call GetMetricStatistics on Amazon EC2 instances with detailed (one-minute) monitoring enabled:
For information about the namespace, metric names, and dimensions that other Amazon Web Services products use to send metrics to CloudWatch, go to Amazon CloudWatch Metrics, Namespaces, and Dimensions Reference in the Amazon CloudWatch Developer Guide.
", + "ListMetrics": "Returns a list of valid metrics stored for the AWS account owner. Returned metrics can be used with GetMetricStatistics to obtain statistical data for a given metric.
NextToken values with subsequent ListMetrics operations. ListMetrics action. Statistics about the metric, however, are available sooner using GetMetricStatistics. Creates or updates an alarm and associates it with the specified Amazon CloudWatch metric. Optionally, this operation can associate one or more Amazon Simple Notification Service resources with the alarm.
When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is evaluated and its StateValue is set appropriately. Any actions associated with the StateValue is then executed.
StateValue is left unchanged. ec2:DescribeInstanceStatus and ec2:DescribeInstances for all alarms on Amazon EC2 instance status metrics.ec2:StopInstances for alarms with stop actions.ec2:TerminateInstances for alarms with terminate actions.ec2:DescribeInstanceRecoveryAttribute, and ec2:RecoverInstances for alarms with recover actions.If you have read/write permissions for Amazon CloudWatch but not for Amazon EC2, you can still create an alarm but the stop or terminate actions won't be performed on the Amazon EC2 instance. However, if you are later granted permission to use the associated Amazon EC2 APIs, the alarm actions you created earlier will be performed. For more information about IAM permissions, see Permissions and Policies in Using IAM.
If you are using an IAM role (e.g., an Amazon EC2 instance profile), you cannot stop or terminate the instance using alarm actions. However, you can still see the alarm state and perform any other actions such as Amazon SNS notifications or Auto Scaling policies.
If you are using temporary security credentials granted using the AWS Security Token Service (AWS STS), you cannot stop or terminate an Amazon EC2 instance using alarm actions.
Publishes metric data points to Amazon CloudWatch. Amazon CloudWatch associates the data points with the specified metric. If the specified metric does not exist, Amazon CloudWatch creates the metric. When Amazon CloudWatch creates a metric, it can take up to fifteen minutes for the metric to appear in calls to the ListMetrics action.
Each PutMetricData request is limited to 8 KB in size for HTTP GET requests and is limited to 40 KB in size for HTTP POST requests.
Value parameter accepts numbers of type Double, Amazon CloudWatch rejects values that are either too small or too large. Values must be in the range of 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2). In addition, special values (e.g., NaN, +Infinity, -Infinity) are not supported. Data that is timestamped 24 hours or more in the past may take in excess of 48 hours to become available from submission time using GetMetricStatistics.
Temporarily sets the state of an alarm. When the updated StateValue differs from the previous value, the action configured for the appropriate state is invoked. For example, if your alarm is configured to send an Amazon SNS message when an alarm is triggered, temporarily changing the alarm's state to ALARM will send an Amazon SNS message. This is not a permanent change. The next periodic alarm check (in about a minute) will set the alarm to its actual state. Because the alarm state change happens very quickly, it is typically only visibile in the alarm's History tab in the Amazon CloudWatch console or through DescribeAlarmHistory.
The action name prefix.
" + } + }, + "ActionsEnabled": { + "base": null, + "refs": { + "MetricAlarm$ActionsEnabled": "Indicates whether actions should be executed during any changes to the alarm's state.
", + "PutMetricAlarmInput$ActionsEnabled": "Indicates whether or not actions should be executed during any changes to the alarm's state.
" + } + }, + "AlarmArn": { + "base": null, + "refs": { + "MetricAlarm$AlarmArn": "The Amazon Resource Name (ARN) of the alarm.
" + } + }, + "AlarmDescription": { + "base": null, + "refs": { + "MetricAlarm$AlarmDescription": "The description for the alarm.
", + "PutMetricAlarmInput$AlarmDescription": "The description for the alarm.
" + } + }, + "AlarmHistoryItem": { + "base": " The AlarmHistoryItem data type contains descriptive information about the history of a specific alarm. If you call DescribeAlarmHistory, Amazon CloudWatch returns this data type as part of the DescribeAlarmHistoryResult data type.
A list of alarm histories in JSON format.
" + } + }, + "AlarmName": { + "base": null, + "refs": { + "AlarmHistoryItem$AlarmName": "The descriptive name for the alarm.
", + "AlarmNames$member": null, + "DescribeAlarmHistoryInput$AlarmName": "The name of the alarm.
", + "MetricAlarm$AlarmName": "The name of the alarm.
", + "PutMetricAlarmInput$AlarmName": "The descriptive name for the alarm. This name must be unique within the user's AWS account
", + "SetAlarmStateInput$AlarmName": "The descriptive name for the alarm. This name must be unique within the user's AWS account. The maximum length is 255 characters.
" + } + }, + "AlarmNamePrefix": { + "base": null, + "refs": { + "DescribeAlarmsInput$AlarmNamePrefix": " The alarm name prefix. AlarmNames cannot be specified if this parameter is specified.
A list of alarms to be deleted.
", + "DescribeAlarmsInput$AlarmNames": "A list of alarm names to retrieve information for.
", + "DisableAlarmActionsInput$AlarmNames": "The names of the alarms to disable actions for.
", + "EnableAlarmActionsInput$AlarmNames": "The names of the alarms to enable actions for.
" + } + }, + "AwsQueryErrorMessage": { + "base": null, + "refs": { + "InvalidParameterCombinationException$message": "", + "InvalidParameterValueException$message": "", + "MissingRequiredParameterException$message": "" + } + }, + "ComparisonOperator": { + "base": null, + "refs": { + "MetricAlarm$ComparisonOperator": " The arithmetic operation to use when comparing the specified Statistic and Threshold. The specified Statistic value is used as the first operand.
The arithmetic operation to use when comparing the specified Statistic and Threshold. The specified Statistic value is used as the first operand.
The Datapoint data type encapsulates the statistical data that Amazon CloudWatch computes from metric data.
The number of metric values that contributed to the aggregate value of this datapoint.
", + "Datapoint$Average": "The average of metric values that correspond to the datapoint.
", + "Datapoint$Sum": "The sum of metric values used for the datapoint.
", + "Datapoint$Minimum": "The minimum metric value used for the datapoint.
", + "Datapoint$Maximum": "The maximum of the metric value used for the datapoint.
", + "MetricDatum$Value": "The value for the metric.
Value parameter accepts numbers of type Double, Amazon CloudWatch rejects values that are either too small or too large. Values must be in the range of 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2). In addition, special values (e.g., NaN, +Infinity, -Infinity) are not supported. The number of samples used for the statistic set.
", + "StatisticSet$Sum": "The sum of values for the sample set.
", + "StatisticSet$Minimum": "The minimum value of the sample set.
", + "StatisticSet$Maximum": "The maximum value of the sample set.
" + } + }, + "Datapoints": { + "base": null, + "refs": { + "GetMetricStatisticsOutput$Datapoints": "The datapoints for the specified metric.
" + } + }, + "DeleteAlarmsInput": { + "base": null, + "refs": { + } + }, + "DescribeAlarmHistoryInput": { + "base": null, + "refs": { + } + }, + "DescribeAlarmHistoryOutput": { + "base": "The output for the DescribeAlarmHistory action.
", + "refs": { + } + }, + "DescribeAlarmsForMetricInput": { + "base": null, + "refs": { + } + }, + "DescribeAlarmsForMetricOutput": { + "base": "The output for the DescribeAlarmsForMetric action.
", + "refs": { + } + }, + "DescribeAlarmsInput": { + "base": null, + "refs": { + } + }, + "DescribeAlarmsOutput": { + "base": "The output for the DescribeAlarms action.
", + "refs": { + } + }, + "Dimension": { + "base": " The Dimension data type further expands on the identity of a metric using a Name, Value pair.
For examples that use one or more dimensions, see PutMetricData.
", + "refs": { + "Dimensions$member": null + } + }, + "DimensionFilter": { + "base": " The DimensionFilter data type is used to filter ListMetrics results.
A list of dimensions to filter against.
" + } + }, + "DimensionName": { + "base": null, + "refs": { + "Dimension$Name": "The name of the dimension.
", + "DimensionFilter$Name": "The dimension name to be matched.
" + } + }, + "DimensionValue": { + "base": null, + "refs": { + "Dimension$Value": "The value representing the dimension measurement
", + "DimensionFilter$Value": "The value of the dimension to be matched.
Name without specifying a Value returns all values associated with that Name. The list of dimensions associated with the metric. If the metric has any associated dimensions, you must specify them in order for the DescribeAlarmsForMetric to succeed.
", + "GetMetricStatisticsInput$Dimensions": "A list of dimensions describing qualities of the metric.
", + "Metric$Dimensions": "A list of dimensions associated with the metric.
", + "MetricAlarm$Dimensions": "The list of dimensions associated with the alarm's associated metric.
", + "MetricDatum$Dimensions": "A list of dimensions associated with the metric. Note, when using the Dimensions value in a query, you need to append .member.N to it (e.g., Dimensions.member.N).
", + "PutMetricAlarmInput$Dimensions": "The dimensions for the alarm's associated metric.
" + } + }, + "DisableAlarmActionsInput": { + "base": "", + "refs": { + } + }, + "EnableAlarmActionsInput": { + "base": null, + "refs": { + } + }, + "ErrorMessage": { + "base": null, + "refs": { + "InvalidFormatFault$message": "", + "InvalidNextToken$message": "", + "LimitExceededFault$message": "", + "ResourceNotFound$message": "" + } + }, + "EvaluationPeriods": { + "base": null, + "refs": { + "MetricAlarm$EvaluationPeriods": "
The number of periods over which data is compared to the specified threshold.
", + "PutMetricAlarmInput$EvaluationPeriods": "The number of periods over which data is compared to the specified threshold.
" + } + }, + "FaultDescription": { + "base": null, + "refs": { + "InternalServiceFault$Message": "" + } + }, + "GetMetricStatisticsInput": { + "base": null, + "refs": { + } + }, + "GetMetricStatisticsOutput": { + "base": "The output for the GetMetricStatistics action.
", + "refs": { + } + }, + "HistoryData": { + "base": null, + "refs": { + "AlarmHistoryItem$HistoryData": "Machine-readable data about the alarm in JSON format.
" + } + }, + "HistoryItemType": { + "base": null, + "refs": { + "AlarmHistoryItem$HistoryItemType": "The type of alarm history item.
", + "DescribeAlarmHistoryInput$HistoryItemType": "The type of alarm histories to retrieve.
" + } + }, + "HistorySummary": { + "base": null, + "refs": { + "AlarmHistoryItem$HistorySummary": "A human-readable summary of the alarm history.
" + } + }, + "InternalServiceFault": { + "base": "Indicates that the request processing has failed due to some unknown error, exception, or failure.
", + "refs": { + } + }, + "InvalidFormatFault": { + "base": "Data was not syntactically valid JSON.
", + "refs": { + } + }, + "InvalidNextToken": { + "base": "The next token specified is invalid.
", + "refs": { + } + }, + "InvalidParameterCombinationException": { + "base": "Parameters that must not be used together were used together.
", + "refs": { + } + }, + "InvalidParameterValueException": { + "base": "Bad or out-of-range value was supplied for the input parameter.
", + "refs": { + } + }, + "LimitExceededFault": { + "base": "The quota for alarms for this customer has already been reached.
", + "refs": { + } + }, + "ListMetricsInput": { + "base": null, + "refs": { + } + }, + "ListMetricsOutput": { + "base": "The output for the ListMetrics action.
", + "refs": { + } + }, + "MaxRecords": { + "base": null, + "refs": { + "DescribeAlarmHistoryInput$MaxRecords": "The maximum number of alarm history records to retrieve.
", + "DescribeAlarmsInput$MaxRecords": "The maximum number of alarm descriptions to retrieve.
" + } + }, + "Metric": { + "base": " The Metric data type contains information about a specific metric. If you call ListMetrics, Amazon CloudWatch returns information contained by this data type.
The example in the Examples section publishes two metrics named buffers and latency. Both metrics are in the examples namespace. Both metrics have two dimensions, InstanceID and InstanceType.
", + "refs": { + "Metrics$member": null + } + }, + "MetricAlarm": { + "base": "The MetricAlarm data type represents an alarm. You can use PutMetricAlarm to create or update an alarm.
", + "refs": { + "MetricAlarms$member": null + } + }, + "MetricAlarms": { + "base": null, + "refs": { + "DescribeAlarmsForMetricOutput$MetricAlarms": "A list of information for each alarm with the specified metric.
", + "DescribeAlarmsOutput$MetricAlarms": "A list of information for the specified alarms.
" + } + }, + "MetricData": { + "base": null, + "refs": { + "PutMetricDataInput$MetricData": "A list of data describing the metric.
" + } + }, + "MetricDatum": { + "base": " The MetricDatum data type encapsulates the information sent with PutMetricData to either create a new metric or add new values to be aggregated into an existing metric.
A label describing the specified metric.
" + } + }, + "MetricName": { + "base": null, + "refs": { + "DescribeAlarmsForMetricInput$MetricName": "The name of the metric.
", + "GetMetricStatisticsInput$MetricName": "The name of the metric, with or without spaces.
", + "ListMetricsInput$MetricName": "The name of the metric to filter against.
", + "Metric$MetricName": "The name of the metric.
", + "MetricAlarm$MetricName": "The name of the alarm's metric.
", + "MetricDatum$MetricName": "The name of the metric.
", + "PutMetricAlarmInput$MetricName": "The name for the alarm's associated metric.
" + } + }, + "Metrics": { + "base": null, + "refs": { + "ListMetricsOutput$Metrics": "A list of metrics used to generate statistics for an AWS account.
" + } + }, + "MissingRequiredParameterException": { + "base": "An input parameter that is mandatory for processing the request is not supplied.
", + "refs": { + } + }, + "Namespace": { + "base": null, + "refs": { + "DescribeAlarmsForMetricInput$Namespace": "The namespace of the metric.
", + "GetMetricStatisticsInput$Namespace": "The namespace of the metric, with or without spaces.
", + "ListMetricsInput$Namespace": "The namespace to filter against.
", + "Metric$Namespace": "The namespace of the metric.
", + "MetricAlarm$Namespace": "The namespace of alarm's associated metric.
", + "PutMetricAlarmInput$Namespace": "The namespace for the alarm's associated metric.
", + "PutMetricDataInput$Namespace": "The namespace for the metric data.
The token returned by a previous call to indicate that there is more data available.
", + "DescribeAlarmHistoryOutput$NextToken": "A string that marks the start of the next batch of returned results.
", + "DescribeAlarmsInput$NextToken": "The token returned by a previous call to indicate that there is more data available.
", + "DescribeAlarmsOutput$NextToken": "A string that marks the start of the next batch of returned results.
", + "ListMetricsInput$NextToken": "The token returned by a previous call to indicate that there is more data available.
", + "ListMetricsOutput$NextToken": "A string that marks the start of the next batch of returned results.
" + } + }, + "Period": { + "base": null, + "refs": { + "DescribeAlarmsForMetricInput$Period": "The period in seconds over which the statistic is applied.
", + "GetMetricStatisticsInput$Period": " The granularity, in seconds, of the returned datapoints. Period must be at least 60 seconds and must be a multiple of 60. The default value is 60.
The period in seconds over which the statistic is applied.
", + "PutMetricAlarmInput$Period": "The period in seconds over which the specified statistic is applied.
" + } + }, + "PutMetricAlarmInput": { + "base": null, + "refs": { + } + }, + "PutMetricDataInput": { + "base": null, + "refs": { + } + }, + "ResourceList": { + "base": null, + "refs": { + "MetricAlarm$OKActions": " The list of actions to execute when this alarm transitions into an OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).
The list of actions to execute when this alarm transitions into an ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).
The list of actions to execute when this alarm transitions into an INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).
UnknownActions. The list of actions to execute when this alarm transitions into an OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).
Valid Values: arn:aws:automate:region (e.g., us-east-1):ec2:stop | arn:aws:automate:region (e.g., us-east-1):ec2:terminate | arn:aws:automate:region (e.g., us-east-1):ec2:recover
Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Reboot/1.0
Note: You must create at least one stop, terminate, or reboot alarm using the Amazon EC2 or CloudWatch console to create the EC2ActionsAccess IAM role for the first time. After this IAM role is created, you can create stop, terminate, or reboot alarms using the CLI.
", + "PutMetricAlarmInput$AlarmActions": " The list of actions to execute when this alarm transitions into an ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).
Valid Values: arn:aws:automate:region (e.g., us-east-1):ec2:stop | arn:aws:automate:region (e.g., us-east-1):ec2:terminate | arn:aws:automate:region (e.g., us-east-1):ec2:recover
Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Reboot/1.0
Note: You must create at least one stop, terminate, or reboot alarm using the Amazon EC2 or CloudWatch console to create the EC2ActionsAccess IAM role for the first time. After this IAM role is created, you can create stop, terminate, or reboot alarms using the CLI.
", + "PutMetricAlarmInput$InsufficientDataActions": " The list of actions to execute when this alarm transitions into an INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).
Valid Values: arn:aws:automate:region (e.g., us-east-1):ec2:stop | arn:aws:automate:region (e.g., us-east-1):ec2:terminate | arn:aws:automate:region (e.g., us-east-1):ec2:recover
Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Reboot/1.0
Note: You must create at least one stop, terminate, or reboot alarm using the Amazon EC2 or CloudWatch console to create the EC2ActionsAccess IAM role for the first time. After this IAM role is created, you can create stop, terminate, or reboot alarms using the CLI.
" + } + }, + "ResourceName": { + "base": null, + "refs": { + "ResourceList$member": null + } + }, + "ResourceNotFound": { + "base": "The named resource does not exist.
", + "refs": { + } + }, + "SetAlarmStateInput": { + "base": null, + "refs": { + } + }, + "StandardUnit": { + "base": null, + "refs": { + "Datapoint$Unit": "The standard unit used for the datapoint.
", + "DescribeAlarmsForMetricInput$Unit": "The unit for the metric.
", + "GetMetricStatisticsInput$Unit": "The unit for the metric.
", + "MetricAlarm$Unit": "The unit of the alarm's associated metric.
", + "MetricDatum$Unit": "The unit of the metric.
", + "PutMetricAlarmInput$Unit": "The statistic's unit of measure. For example, the units for the Amazon EC2 NetworkIn metric are Bytes because NetworkIn tracks the number of bytes that an instance receives on all network interfaces. You can also specify a unit when you create a custom metric. Units help provide conceptual meaning to your data. Metric data points that specify a unit of measure, such as Percent, are aggregated separately.
Note: If you specify a unit, you must use a unit that is appropriate for the metric. Otherwise, this can cause an Amazon CloudWatch alarm to get stuck in the INSUFFICIENT DATA state.
" + } + }, + "StateReason": { + "base": null, + "refs": { + "MetricAlarm$StateReason": "A human-readable explanation for the alarm's state.
", + "SetAlarmStateInput$StateReason": "The reason that this alarm is set to this specific state (in human-readable text format)
" + } + }, + "StateReasonData": { + "base": null, + "refs": { + "MetricAlarm$StateReasonData": "An explanation for the alarm's state in machine-readable JSON format
", + "SetAlarmStateInput$StateReasonData": "The reason that this alarm is set to this specific state (in machine-readable JSON format)
" + } + }, + "StateValue": { + "base": null, + "refs": { + "DescribeAlarmsInput$StateValue": "The state value to be used in matching alarms.
", + "MetricAlarm$StateValue": "The state value for the alarm.
", + "SetAlarmStateInput$StateValue": "The value of the state.
" + } + }, + "Statistic": { + "base": null, + "refs": { + "DescribeAlarmsForMetricInput$Statistic": "The statistic for the metric.
", + "MetricAlarm$Statistic": "The statistic to apply to the alarm's associated metric.
", + "PutMetricAlarmInput$Statistic": "The statistic to apply to the alarm's associated metric.
", + "Statistics$member": null + } + }, + "StatisticSet": { + "base": " The StatisticSet data type describes the StatisticValues component of MetricDatum, and represents a set of statistics that describes a specific metric.
A set of statistical values describing the metric.
" + } + }, + "Statistics": { + "base": null, + "refs": { + "GetMetricStatisticsInput$Statistics": "The metric statistics to return. For information about specific statistics returned by GetMetricStatistics, see Statistics in the Amazon CloudWatch Developer Guide.
" + } + }, + "Threshold": { + "base": null, + "refs": { + "MetricAlarm$Threshold": "The value against which the specified statistic is compared.
", + "PutMetricAlarmInput$Threshold": "The value against which the specified statistic is compared.
" + } + }, + "Timestamp": { + "base": null, + "refs": { + "AlarmHistoryItem$Timestamp": "The time stamp for the alarm history item.
", + "Datapoint$Timestamp": "The time stamp used for the datapoint.
", + "DescribeAlarmHistoryInput$StartDate": "The starting date to retrieve alarm history.
", + "DescribeAlarmHistoryInput$EndDate": "The ending date to retrieve alarm history.
", + "GetMetricStatisticsInput$StartTime": "The time stamp to use for determining the first datapoint to return. The value specified is inclusive; results include datapoints with the time stamp specified. The time stamp must be in ISO 8601 UTC format (e.g., 2014-09-03T23:00:00Z).
Data that is timestamped 24 hours or more in the past may take in excess of 48 hours to become available from submission time using GetMetricStatistics.
The time stamp to use for determining the last datapoint to return. The value specified is exclusive; results will include datapoints up to the time stamp specified. The time stamp must be in ISO 8601 UTC format (e.g., 2014-09-03T23:00:00Z).
", + "MetricAlarm$AlarmConfigurationUpdatedTimestamp": "The time stamp of the last update to the alarm configuration.
", + "MetricAlarm$StateUpdatedTimestamp": "The time stamp of the last update to the alarm's state.
", + "MetricDatum$Timestamp": "The time stamp used for the metric in ISO 8601 Universal Coordinated Time (UTC) format. If not specified, the default value is set to the time the metric data was received.
" + } + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/monitoring/2010-08-01/examples-1.json b/vendor/github.com/aws/aws-sdk-go/models/apis/monitoring/2010-08-01/examples-1.json new file mode 100644 index 000000000..0ea7e3b0b --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/monitoring/2010-08-01/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/monitoring/2010-08-01/paginators-1.json b/vendor/github.com/aws/aws-sdk-go/models/apis/monitoring/2010-08-01/paginators-1.json new file mode 100644 index 000000000..7bee28c28 --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/monitoring/2010-08-01/paginators-1.json @@ -0,0 +1,24 @@ +{ + "pagination": { + "DescribeAlarmHistory": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxRecords", + "result_key": "AlarmHistoryItems" + }, + "DescribeAlarms": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxRecords", + "result_key": "MetricAlarms" + }, + "DescribeAlarmsForMetric": { + "result_key": "MetricAlarms" + }, + "ListMetrics": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "Metrics" + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/monitoring/2010-08-01/waiters-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/monitoring/2010-08-01/waiters-2.json new file mode 100644 index 000000000..cb0cf0bfe --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/monitoring/2010-08-01/waiters-2.json @@ -0,0 +1,18 @@ +{ + "version": 2, + "waiters": { + "AlarmExists": { + "delay": 5, + "maxAttempts": 40, + "operation": "DescribeAlarms", + "acceptors": [ + { + "matcher": "path", + "expected": true, + "argument": "length(MetricAlarms[]) > `0`", + "state": "success" + } + ] + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/opsworks/2013-02-18/api-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/opsworks/2013-02-18/api-2.json new file mode 100644 index 000000000..931d1680e --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/opsworks/2013-02-18/api-2.json @@ -0,0 +1,2606 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2013-02-18", + "endpointPrefix":"opsworks", + "jsonVersion":"1.1", + "protocol":"json", + "serviceFullName":"AWS OpsWorks", + "signatureVersion":"v4", + "targetPrefix":"OpsWorks_20130218" + }, + "operations":{ + "AssignInstance":{ + "name":"AssignInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssignInstanceRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "AssignVolume":{ + "name":"AssignVolume", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssignVolumeRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "AssociateElasticIp":{ + "name":"AssociateElasticIp", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateElasticIpRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "AttachElasticLoadBalancer":{ + "name":"AttachElasticLoadBalancer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AttachElasticLoadBalancerRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "CloneStack":{ + "name":"CloneStack", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CloneStackRequest"}, + "output":{"shape":"CloneStackResult"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "CreateApp":{ + "name":"CreateApp", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateAppRequest"}, + "output":{"shape":"CreateAppResult"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "CreateDeployment":{ + "name":"CreateDeployment", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDeploymentRequest"}, + "output":{"shape":"CreateDeploymentResult"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "CreateInstance":{ + "name":"CreateInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateInstanceRequest"}, + "output":{"shape":"CreateInstanceResult"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "CreateLayer":{ + "name":"CreateLayer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateLayerRequest"}, + "output":{"shape":"CreateLayerResult"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "CreateStack":{ + "name":"CreateStack", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateStackRequest"}, + "output":{"shape":"CreateStackResult"}, + "errors":[ + {"shape":"ValidationException"} + ] + }, + "CreateUserProfile":{ + "name":"CreateUserProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateUserProfileRequest"}, + "output":{"shape":"CreateUserProfileResult"}, + "errors":[ + {"shape":"ValidationException"} + ] + }, + "DeleteApp":{ + "name":"DeleteApp", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteAppRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "DeleteInstance":{ + "name":"DeleteInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteInstanceRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "DeleteLayer":{ + "name":"DeleteLayer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteLayerRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "DeleteStack":{ + "name":"DeleteStack", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteStackRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "DeleteUserProfile":{ + "name":"DeleteUserProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteUserProfileRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "DeregisterEcsCluster":{ + "name":"DeregisterEcsCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeregisterEcsClusterRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "DeregisterElasticIp":{ + "name":"DeregisterElasticIp", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeregisterElasticIpRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "DeregisterInstance":{ + "name":"DeregisterInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeregisterInstanceRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "DeregisterRdsDbInstance":{ + "name":"DeregisterRdsDbInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeregisterRdsDbInstanceRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "DeregisterVolume":{ + "name":"DeregisterVolume", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeregisterVolumeRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "DescribeAgentVersions":{ + "name":"DescribeAgentVersions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAgentVersionsRequest"}, + "output":{"shape":"DescribeAgentVersionsResult"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "DescribeApps":{ + "name":"DescribeApps", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAppsRequest"}, + "output":{"shape":"DescribeAppsResult"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "DescribeCommands":{ + "name":"DescribeCommands", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeCommandsRequest"}, + "output":{"shape":"DescribeCommandsResult"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "DescribeDeployments":{ + "name":"DescribeDeployments", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDeploymentsRequest"}, + "output":{"shape":"DescribeDeploymentsResult"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "DescribeEcsClusters":{ + "name":"DescribeEcsClusters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEcsClustersRequest"}, + "output":{"shape":"DescribeEcsClustersResult"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "DescribeElasticIps":{ + "name":"DescribeElasticIps", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeElasticIpsRequest"}, + "output":{"shape":"DescribeElasticIpsResult"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "DescribeElasticLoadBalancers":{ + "name":"DescribeElasticLoadBalancers", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeElasticLoadBalancersRequest"}, + "output":{"shape":"DescribeElasticLoadBalancersResult"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "DescribeInstances":{ + "name":"DescribeInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeInstancesRequest"}, + "output":{"shape":"DescribeInstancesResult"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "DescribeLayers":{ + "name":"DescribeLayers", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeLayersRequest"}, + "output":{"shape":"DescribeLayersResult"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "DescribeLoadBasedAutoScaling":{ + "name":"DescribeLoadBasedAutoScaling", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeLoadBasedAutoScalingRequest"}, + "output":{"shape":"DescribeLoadBasedAutoScalingResult"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "DescribeMyUserProfile":{ + "name":"DescribeMyUserProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "output":{"shape":"DescribeMyUserProfileResult"} + }, + "DescribePermissions":{ + "name":"DescribePermissions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribePermissionsRequest"}, + "output":{"shape":"DescribePermissionsResult"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "DescribeRaidArrays":{ + "name":"DescribeRaidArrays", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeRaidArraysRequest"}, + "output":{"shape":"DescribeRaidArraysResult"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "DescribeRdsDbInstances":{ + "name":"DescribeRdsDbInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeRdsDbInstancesRequest"}, + "output":{"shape":"DescribeRdsDbInstancesResult"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "DescribeServiceErrors":{ + "name":"DescribeServiceErrors", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeServiceErrorsRequest"}, + "output":{"shape":"DescribeServiceErrorsResult"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "DescribeStackProvisioningParameters":{ + "name":"DescribeStackProvisioningParameters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeStackProvisioningParametersRequest"}, + "output":{"shape":"DescribeStackProvisioningParametersResult"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "DescribeStackSummary":{ + "name":"DescribeStackSummary", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeStackSummaryRequest"}, + "output":{"shape":"DescribeStackSummaryResult"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "DescribeStacks":{ + "name":"DescribeStacks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeStacksRequest"}, + "output":{"shape":"DescribeStacksResult"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "DescribeTimeBasedAutoScaling":{ + "name":"DescribeTimeBasedAutoScaling", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeTimeBasedAutoScalingRequest"}, + "output":{"shape":"DescribeTimeBasedAutoScalingResult"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "DescribeUserProfiles":{ + "name":"DescribeUserProfiles", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeUserProfilesRequest"}, + "output":{"shape":"DescribeUserProfilesResult"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "DescribeVolumes":{ + "name":"DescribeVolumes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVolumesRequest"}, + "output":{"shape":"DescribeVolumesResult"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "DetachElasticLoadBalancer":{ + "name":"DetachElasticLoadBalancer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetachElasticLoadBalancerRequest"}, + "errors":[ + {"shape":"ResourceNotFoundException"} + ] + }, + "DisassociateElasticIp":{ + "name":"DisassociateElasticIp", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateElasticIpRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "GetHostnameSuggestion":{ + "name":"GetHostnameSuggestion", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetHostnameSuggestionRequest"}, + "output":{"shape":"GetHostnameSuggestionResult"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "GrantAccess":{ + "name":"GrantAccess", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GrantAccessRequest"}, + "output":{"shape":"GrantAccessResult"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "RebootInstance":{ + "name":"RebootInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RebootInstanceRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "RegisterEcsCluster":{ + "name":"RegisterEcsCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RegisterEcsClusterRequest"}, + "output":{"shape":"RegisterEcsClusterResult"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "RegisterElasticIp":{ + "name":"RegisterElasticIp", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RegisterElasticIpRequest"}, + "output":{"shape":"RegisterElasticIpResult"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "RegisterInstance":{ + "name":"RegisterInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RegisterInstanceRequest"}, + "output":{"shape":"RegisterInstanceResult"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "RegisterRdsDbInstance":{ + "name":"RegisterRdsDbInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RegisterRdsDbInstanceRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "RegisterVolume":{ + "name":"RegisterVolume", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RegisterVolumeRequest"}, + "output":{"shape":"RegisterVolumeResult"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "SetLoadBasedAutoScaling":{ + "name":"SetLoadBasedAutoScaling", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SetLoadBasedAutoScalingRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "SetPermission":{ + "name":"SetPermission", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SetPermissionRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "SetTimeBasedAutoScaling":{ + "name":"SetTimeBasedAutoScaling", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SetTimeBasedAutoScalingRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "StartInstance":{ + "name":"StartInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartInstanceRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "StartStack":{ + "name":"StartStack", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartStackRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "StopInstance":{ + "name":"StopInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopInstanceRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "StopStack":{ + "name":"StopStack", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopStackRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "UnassignInstance":{ + "name":"UnassignInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UnassignInstanceRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "UnassignVolume":{ + "name":"UnassignVolume", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UnassignVolumeRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "UpdateApp":{ + "name":"UpdateApp", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateAppRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "UpdateElasticIp":{ + "name":"UpdateElasticIp", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateElasticIpRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "UpdateInstance":{ + "name":"UpdateInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateInstanceRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "UpdateLayer":{ + "name":"UpdateLayer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateLayerRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "UpdateMyUserProfile":{ + "name":"UpdateMyUserProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateMyUserProfileRequest"}, + "errors":[ + {"shape":"ValidationException"} + ] + }, + "UpdateRdsDbInstance":{ + "name":"UpdateRdsDbInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateRdsDbInstanceRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "UpdateStack":{ + "name":"UpdateStack", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateStackRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "UpdateUserProfile":{ + "name":"UpdateUserProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateUserProfileRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "UpdateVolume":{ + "name":"UpdateVolume", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateVolumeRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + } + }, + "shapes":{ + "AgentVersion":{ + "type":"structure", + "members":{ + "Version":{"shape":"String"}, + "ConfigurationManager":{"shape":"StackConfigurationManager"} + } + }, + "AgentVersions":{ + "type":"list", + "member":{"shape":"AgentVersion"} + }, + "App":{ + "type":"structure", + "members":{ + "AppId":{"shape":"String"}, + "StackId":{"shape":"String"}, + "Shortname":{"shape":"String"}, + "Name":{"shape":"String"}, + "Description":{"shape":"String"}, + "DataSources":{"shape":"DataSources"}, + "Type":{"shape":"AppType"}, + "AppSource":{"shape":"Source"}, + "Domains":{"shape":"Strings"}, + "EnableSsl":{"shape":"Boolean"}, + "SslConfiguration":{"shape":"SslConfiguration"}, + "Attributes":{"shape":"AppAttributes"}, + "CreatedAt":{"shape":"String"}, + "Environment":{"shape":"EnvironmentVariables"} + } + }, + "AppAttributes":{ + "type":"map", + "key":{"shape":"AppAttributesKeys"}, + "value":{"shape":"String"} + }, + "AppAttributesKeys":{ + "type":"string", + "enum":[ + "DocumentRoot", + "RailsEnv", + "AutoBundleOnDeploy", + "AwsFlowRubySettings" + ] + }, + "AppType":{ + "type":"string", + "enum":[ + "aws-flow-ruby", + "java", + "rails", + "php", + "nodejs", + "static", + "other" + ] + }, + "Apps":{ + "type":"list", + "member":{"shape":"App"} + }, + "Architecture":{ + "type":"string", + "enum":[ + "x86_64", + "i386" + ] + }, + "AssignInstanceRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "LayerIds" + ], + "members":{ + "InstanceId":{"shape":"String"}, + "LayerIds":{"shape":"Strings"} + } + }, + "AssignVolumeRequest":{ + "type":"structure", + "required":["VolumeId"], + "members":{ + "VolumeId":{"shape":"String"}, + "InstanceId":{"shape":"String"} + } + }, + "AssociateElasticIpRequest":{ + "type":"structure", + "required":["ElasticIp"], + "members":{ + "ElasticIp":{"shape":"String"}, + "InstanceId":{"shape":"String"} + } + }, + "AttachElasticLoadBalancerRequest":{ + "type":"structure", + "required":[ + "ElasticLoadBalancerName", + "LayerId" + ], + "members":{ + "ElasticLoadBalancerName":{"shape":"String"}, + "LayerId":{"shape":"String"} + } + }, + "AutoScalingThresholds":{ + "type":"structure", + "members":{ + "InstanceCount":{"shape":"Integer"}, + "ThresholdsWaitTime":{"shape":"Minute"}, + "IgnoreMetricsTime":{"shape":"Minute"}, + "CpuThreshold":{"shape":"Double"}, + "MemoryThreshold":{"shape":"Double"}, + "LoadThreshold":{"shape":"Double"}, + "Alarms":{"shape":"Strings"} + } + }, + "AutoScalingType":{ + "type":"string", + "enum":[ + "load", + "timer" + ] + }, + "BlockDeviceMapping":{ + "type":"structure", + "members":{ + "DeviceName":{"shape":"String"}, + "NoDevice":{"shape":"String"}, + "VirtualName":{"shape":"String"}, + "Ebs":{"shape":"EbsBlockDevice"} + } + }, + "BlockDeviceMappings":{ + "type":"list", + "member":{"shape":"BlockDeviceMapping"} + }, + "Boolean":{ + "type":"boolean", + "box":true + }, + "ChefConfiguration":{ + "type":"structure", + "members":{ + "ManageBerkshelf":{"shape":"Boolean"}, + "BerkshelfVersion":{"shape":"String"} + } + }, + "CloneStackRequest":{ + "type":"structure", + "required":[ + "SourceStackId", + "ServiceRoleArn" + ], + "members":{ + "SourceStackId":{"shape":"String"}, + "Name":{"shape":"String"}, + "Region":{"shape":"String"}, + "VpcId":{"shape":"String"}, + "Attributes":{"shape":"StackAttributes"}, + "ServiceRoleArn":{"shape":"String"}, + "DefaultInstanceProfileArn":{"shape":"String"}, + "DefaultOs":{"shape":"String"}, + "HostnameTheme":{"shape":"String"}, + "DefaultAvailabilityZone":{"shape":"String"}, + "DefaultSubnetId":{"shape":"String"}, + "CustomJson":{"shape":"String"}, + "ConfigurationManager":{"shape":"StackConfigurationManager"}, + "ChefConfiguration":{"shape":"ChefConfiguration"}, + "UseCustomCookbooks":{"shape":"Boolean"}, + "UseOpsworksSecurityGroups":{"shape":"Boolean"}, + "CustomCookbooksSource":{"shape":"Source"}, + "DefaultSshKeyName":{"shape":"String"}, + "ClonePermissions":{"shape":"Boolean"}, + "CloneAppIds":{"shape":"Strings"}, + "DefaultRootDeviceType":{"shape":"RootDeviceType"}, + "AgentVersion":{"shape":"String"} + } + }, + "CloneStackResult":{ + "type":"structure", + "members":{ + "StackId":{"shape":"String"} + } + }, + "Command":{ + "type":"structure", + "members":{ + "CommandId":{"shape":"String"}, + "InstanceId":{"shape":"String"}, + "DeploymentId":{"shape":"String"}, + "CreatedAt":{"shape":"DateTime"}, + "AcknowledgedAt":{"shape":"DateTime"}, + "CompletedAt":{"shape":"DateTime"}, + "Status":{"shape":"String"}, + "ExitCode":{"shape":"Integer"}, + "LogUrl":{"shape":"String"}, + "Type":{"shape":"String"} + } + }, + "Commands":{ + "type":"list", + "member":{"shape":"Command"} + }, + "CreateAppRequest":{ + "type":"structure", + "required":[ + "StackId", + "Name", + "Type" + ], + "members":{ + "StackId":{"shape":"String"}, + "Shortname":{"shape":"String"}, + "Name":{"shape":"String"}, + "Description":{"shape":"String"}, + "DataSources":{"shape":"DataSources"}, + "Type":{"shape":"AppType"}, + "AppSource":{"shape":"Source"}, + "Domains":{"shape":"Strings"}, + "EnableSsl":{"shape":"Boolean"}, + "SslConfiguration":{"shape":"SslConfiguration"}, + "Attributes":{"shape":"AppAttributes"}, + "Environment":{"shape":"EnvironmentVariables"} + } + }, + "CreateAppResult":{ + "type":"structure", + "members":{ + "AppId":{"shape":"String"} + } + }, + "CreateDeploymentRequest":{ + "type":"structure", + "required":[ + "StackId", + "Command" + ], + "members":{ + "StackId":{"shape":"String"}, + "AppId":{"shape":"String"}, + "InstanceIds":{"shape":"Strings"}, + "LayerIds":{"shape":"Strings"}, + "Command":{"shape":"DeploymentCommand"}, + "Comment":{"shape":"String"}, + "CustomJson":{"shape":"String"} + } + }, + "CreateDeploymentResult":{ + "type":"structure", + "members":{ + "DeploymentId":{"shape":"String"} + } + }, + "CreateInstanceRequest":{ + "type":"structure", + "required":[ + "StackId", + "LayerIds", + "InstanceType" + ], + "members":{ + "StackId":{"shape":"String"}, + "LayerIds":{"shape":"Strings"}, + "InstanceType":{"shape":"String"}, + "AutoScalingType":{"shape":"AutoScalingType"}, + "Hostname":{"shape":"String"}, + "Os":{"shape":"String"}, + "AmiId":{"shape":"String"}, + "SshKeyName":{"shape":"String"}, + "AvailabilityZone":{"shape":"String"}, + "VirtualizationType":{"shape":"String"}, + "SubnetId":{"shape":"String"}, + "Architecture":{"shape":"Architecture"}, + "RootDeviceType":{"shape":"RootDeviceType"}, + "BlockDeviceMappings":{"shape":"BlockDeviceMappings"}, + "InstallUpdatesOnBoot":{"shape":"Boolean"}, + "EbsOptimized":{"shape":"Boolean"}, + "AgentVersion":{"shape":"String"}, + "Tenancy":{"shape":"String"} + } + }, + "CreateInstanceResult":{ + "type":"structure", + "members":{ + "InstanceId":{"shape":"String"} + } + }, + "CreateLayerRequest":{ + "type":"structure", + "required":[ + "StackId", + "Type", + "Name", + "Shortname" + ], + "members":{ + "StackId":{"shape":"String"}, + "Type":{"shape":"LayerType"}, + "Name":{"shape":"String"}, + "Shortname":{"shape":"String"}, + "Attributes":{"shape":"LayerAttributes"}, + "CustomInstanceProfileArn":{"shape":"String"}, + "CustomJson":{"shape":"String"}, + "CustomSecurityGroupIds":{"shape":"Strings"}, + "Packages":{"shape":"Strings"}, + "VolumeConfigurations":{"shape":"VolumeConfigurations"}, + "EnableAutoHealing":{"shape":"Boolean"}, + "AutoAssignElasticIps":{"shape":"Boolean"}, + "AutoAssignPublicIps":{"shape":"Boolean"}, + "CustomRecipes":{"shape":"Recipes"}, + "InstallUpdatesOnBoot":{"shape":"Boolean"}, + "UseEbsOptimizedInstances":{"shape":"Boolean"}, + "LifecycleEventConfiguration":{"shape":"LifecycleEventConfiguration"} + } + }, + "CreateLayerResult":{ + "type":"structure", + "members":{ + "LayerId":{"shape":"String"} + } + }, + "CreateStackRequest":{ + "type":"structure", + "required":[ + "Name", + "Region", + "ServiceRoleArn", + "DefaultInstanceProfileArn" + ], + "members":{ + "Name":{"shape":"String"}, + "Region":{"shape":"String"}, + "VpcId":{"shape":"String"}, + "Attributes":{"shape":"StackAttributes"}, + "ServiceRoleArn":{"shape":"String"}, + "DefaultInstanceProfileArn":{"shape":"String"}, + "DefaultOs":{"shape":"String"}, + "HostnameTheme":{"shape":"String"}, + "DefaultAvailabilityZone":{"shape":"String"}, + "DefaultSubnetId":{"shape":"String"}, + "CustomJson":{"shape":"String"}, + "ConfigurationManager":{"shape":"StackConfigurationManager"}, + "ChefConfiguration":{"shape":"ChefConfiguration"}, + "UseCustomCookbooks":{"shape":"Boolean"}, + "UseOpsworksSecurityGroups":{"shape":"Boolean"}, + "CustomCookbooksSource":{"shape":"Source"}, + "DefaultSshKeyName":{"shape":"String"}, + "DefaultRootDeviceType":{"shape":"RootDeviceType"}, + "AgentVersion":{"shape":"String"} + } + }, + "CreateStackResult":{ + "type":"structure", + "members":{ + "StackId":{"shape":"String"} + } + }, + "CreateUserProfileRequest":{ + "type":"structure", + "required":["IamUserArn"], + "members":{ + "IamUserArn":{"shape":"String"}, + "SshUsername":{"shape":"String"}, + "SshPublicKey":{"shape":"String"}, + "AllowSelfManagement":{"shape":"Boolean"} + } + }, + "CreateUserProfileResult":{ + "type":"structure", + "members":{ + "IamUserArn":{"shape":"String"} + } + }, + "DailyAutoScalingSchedule":{ + "type":"map", + "key":{"shape":"Hour"}, + "value":{"shape":"Switch"} + }, + "DataSource":{ + "type":"structure", + "members":{ + "Type":{"shape":"String"}, + "Arn":{"shape":"String"}, + "DatabaseName":{"shape":"String"} + } + }, + "DataSources":{ + "type":"list", + "member":{"shape":"DataSource"} + }, + "DateTime":{"type":"string"}, + "DeleteAppRequest":{ + "type":"structure", + "required":["AppId"], + "members":{ + "AppId":{"shape":"String"} + } + }, + "DeleteInstanceRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "InstanceId":{"shape":"String"}, + "DeleteElasticIp":{"shape":"Boolean"}, + "DeleteVolumes":{"shape":"Boolean"} + } + }, + "DeleteLayerRequest":{ + "type":"structure", + "required":["LayerId"], + "members":{ + "LayerId":{"shape":"String"} + } + }, + "DeleteStackRequest":{ + "type":"structure", + "required":["StackId"], + "members":{ + "StackId":{"shape":"String"} + } + }, + "DeleteUserProfileRequest":{ + "type":"structure", + "required":["IamUserArn"], + "members":{ + "IamUserArn":{"shape":"String"} + } + }, + "Deployment":{ + "type":"structure", + "members":{ + "DeploymentId":{"shape":"String"}, + "StackId":{"shape":"String"}, + "AppId":{"shape":"String"}, + "CreatedAt":{"shape":"DateTime"}, + "CompletedAt":{"shape":"DateTime"}, + "Duration":{"shape":"Integer"}, + "IamUserArn":{"shape":"String"}, + "Comment":{"shape":"String"}, + "Command":{"shape":"DeploymentCommand"}, + "Status":{"shape":"String"}, + "CustomJson":{"shape":"String"}, + "InstanceIds":{"shape":"Strings"} + } + }, + "DeploymentCommand":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{"shape":"DeploymentCommandName"}, + "Args":{"shape":"DeploymentCommandArgs"} + } + }, + "DeploymentCommandArgs":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"Strings"} + }, + "DeploymentCommandName":{ + "type":"string", + "enum":[ + "install_dependencies", + "update_dependencies", + "update_custom_cookbooks", + "execute_recipes", + "configure", + "setup", + "deploy", + "rollback", + "start", + "stop", + "restart", + "undeploy" + ] + }, + "Deployments":{ + "type":"list", + "member":{"shape":"Deployment"} + }, + "DeregisterEcsClusterRequest":{ + "type":"structure", + "required":["EcsClusterArn"], + "members":{ + "EcsClusterArn":{"shape":"String"} + } + }, + "DeregisterElasticIpRequest":{ + "type":"structure", + "required":["ElasticIp"], + "members":{ + "ElasticIp":{"shape":"String"} + } + }, + "DeregisterInstanceRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "InstanceId":{"shape":"String"} + } + }, + "DeregisterRdsDbInstanceRequest":{ + "type":"structure", + "required":["RdsDbInstanceArn"], + "members":{ + "RdsDbInstanceArn":{"shape":"String"} + } + }, + "DeregisterVolumeRequest":{ + "type":"structure", + "required":["VolumeId"], + "members":{ + "VolumeId":{"shape":"String"} + } + }, + "DescribeAgentVersionsRequest":{ + "type":"structure", + "members":{ + "StackId":{"shape":"String"}, + "ConfigurationManager":{"shape":"StackConfigurationManager"} + } + }, + "DescribeAgentVersionsResult":{ + "type":"structure", + "members":{ + "AgentVersions":{"shape":"AgentVersions"} + } + }, + "DescribeAppsRequest":{ + "type":"structure", + "members":{ + "StackId":{"shape":"String"}, + "AppIds":{"shape":"Strings"} + } + }, + "DescribeAppsResult":{ + "type":"structure", + "members":{ + "Apps":{"shape":"Apps"} + } + }, + "DescribeCommandsRequest":{ + "type":"structure", + "members":{ + "DeploymentId":{"shape":"String"}, + "InstanceId":{"shape":"String"}, + "CommandIds":{"shape":"Strings"} + } + }, + "DescribeCommandsResult":{ + "type":"structure", + "members":{ + "Commands":{"shape":"Commands"} + } + }, + "DescribeDeploymentsRequest":{ + "type":"structure", + "members":{ + "StackId":{"shape":"String"}, + "AppId":{"shape":"String"}, + "DeploymentIds":{"shape":"Strings"} + } + }, + "DescribeDeploymentsResult":{ + "type":"structure", + "members":{ + "Deployments":{"shape":"Deployments"} + } + }, + "DescribeEcsClustersRequest":{ + "type":"structure", + "members":{ + "EcsClusterArns":{"shape":"Strings"}, + "StackId":{"shape":"String"}, + "NextToken":{"shape":"String"}, + "MaxResults":{"shape":"Integer"} + } + }, + "DescribeEcsClustersResult":{ + "type":"structure", + "members":{ + "EcsClusters":{"shape":"EcsClusters"}, + "NextToken":{"shape":"String"} + } + }, + "DescribeElasticIpsRequest":{ + "type":"structure", + "members":{ + "InstanceId":{"shape":"String"}, + "StackId":{"shape":"String"}, + "Ips":{"shape":"Strings"} + } + }, + "DescribeElasticIpsResult":{ + "type":"structure", + "members":{ + "ElasticIps":{"shape":"ElasticIps"} + } + }, + "DescribeElasticLoadBalancersRequest":{ + "type":"structure", + "members":{ + "StackId":{"shape":"String"}, + "LayerIds":{"shape":"Strings"} + } + }, + "DescribeElasticLoadBalancersResult":{ + "type":"structure", + "members":{ + "ElasticLoadBalancers":{"shape":"ElasticLoadBalancers"} + } + }, + "DescribeInstancesRequest":{ + "type":"structure", + "members":{ + "StackId":{"shape":"String"}, + "LayerId":{"shape":"String"}, + "InstanceIds":{"shape":"Strings"} + } + }, + "DescribeInstancesResult":{ + "type":"structure", + "members":{ + "Instances":{"shape":"Instances"} + } + }, + "DescribeLayersRequest":{ + "type":"structure", + "members":{ + "StackId":{"shape":"String"}, + "LayerIds":{"shape":"Strings"} + } + }, + "DescribeLayersResult":{ + "type":"structure", + "members":{ + "Layers":{"shape":"Layers"} + } + }, + "DescribeLoadBasedAutoScalingRequest":{ + "type":"structure", + "required":["LayerIds"], + "members":{ + "LayerIds":{"shape":"Strings"} + } + }, + "DescribeLoadBasedAutoScalingResult":{ + "type":"structure", + "members":{ + "LoadBasedAutoScalingConfigurations":{"shape":"LoadBasedAutoScalingConfigurations"} + } + }, + "DescribeMyUserProfileResult":{ + "type":"structure", + "members":{ + "UserProfile":{"shape":"SelfUserProfile"} + } + }, + "DescribePermissionsRequest":{ + "type":"structure", + "members":{ + "IamUserArn":{"shape":"String"}, + "StackId":{"shape":"String"} + } + }, + "DescribePermissionsResult":{ + "type":"structure", + "members":{ + "Permissions":{"shape":"Permissions"} + } + }, + "DescribeRaidArraysRequest":{ + "type":"structure", + "members":{ + "InstanceId":{"shape":"String"}, + "StackId":{"shape":"String"}, + "RaidArrayIds":{"shape":"Strings"} + } + }, + "DescribeRaidArraysResult":{ + "type":"structure", + "members":{ + "RaidArrays":{"shape":"RaidArrays"} + } + }, + "DescribeRdsDbInstancesRequest":{ + "type":"structure", + "required":["StackId"], + "members":{ + "StackId":{"shape":"String"}, + "RdsDbInstanceArns":{"shape":"Strings"} + } + }, + "DescribeRdsDbInstancesResult":{ + "type":"structure", + "members":{ + "RdsDbInstances":{"shape":"RdsDbInstances"} + } + }, + "DescribeServiceErrorsRequest":{ + "type":"structure", + "members":{ + "StackId":{"shape":"String"}, + "InstanceId":{"shape":"String"}, + "ServiceErrorIds":{"shape":"Strings"} + } + }, + "DescribeServiceErrorsResult":{ + "type":"structure", + "members":{ + "ServiceErrors":{"shape":"ServiceErrors"} + } + }, + "DescribeStackProvisioningParametersRequest":{ + "type":"structure", + "required":["StackId"], + "members":{ + "StackId":{"shape":"String"} + } + }, + "DescribeStackProvisioningParametersResult":{ + "type":"structure", + "members":{ + "AgentInstallerUrl":{"shape":"String"}, + "Parameters":{"shape":"Parameters"} + } + }, + "DescribeStackSummaryRequest":{ + "type":"structure", + "required":["StackId"], + "members":{ + "StackId":{"shape":"String"} + } + }, + "DescribeStackSummaryResult":{ + "type":"structure", + "members":{ + "StackSummary":{"shape":"StackSummary"} + } + }, + "DescribeStacksRequest":{ + "type":"structure", + "members":{ + "StackIds":{"shape":"Strings"} + } + }, + "DescribeStacksResult":{ + "type":"structure", + "members":{ + "Stacks":{"shape":"Stacks"} + } + }, + "DescribeTimeBasedAutoScalingRequest":{ + "type":"structure", + "required":["InstanceIds"], + "members":{ + "InstanceIds":{"shape":"Strings"} + } + }, + "DescribeTimeBasedAutoScalingResult":{ + "type":"structure", + "members":{ + "TimeBasedAutoScalingConfigurations":{"shape":"TimeBasedAutoScalingConfigurations"} + } + }, + "DescribeUserProfilesRequest":{ + "type":"structure", + "members":{ + "IamUserArns":{"shape":"Strings"} + } + }, + "DescribeUserProfilesResult":{ + "type":"structure", + "members":{ + "UserProfiles":{"shape":"UserProfiles"} + } + }, + "DescribeVolumesRequest":{ + "type":"structure", + "members":{ + "InstanceId":{"shape":"String"}, + "StackId":{"shape":"String"}, + "RaidArrayId":{"shape":"String"}, + "VolumeIds":{"shape":"Strings"} + } + }, + "DescribeVolumesResult":{ + "type":"structure", + "members":{ + "Volumes":{"shape":"Volumes"} + } + }, + "DetachElasticLoadBalancerRequest":{ + "type":"structure", + "required":[ + "ElasticLoadBalancerName", + "LayerId" + ], + "members":{ + "ElasticLoadBalancerName":{"shape":"String"}, + "LayerId":{"shape":"String"} + } + }, + "DisassociateElasticIpRequest":{ + "type":"structure", + "required":["ElasticIp"], + "members":{ + "ElasticIp":{"shape":"String"} + } + }, + "Double":{ + "type":"double", + "box":true + }, + "EbsBlockDevice":{ + "type":"structure", + "members":{ + "SnapshotId":{"shape":"String"}, + "Iops":{"shape":"Integer"}, + "VolumeSize":{"shape":"Integer"}, + "VolumeType":{"shape":"VolumeType"}, + "DeleteOnTermination":{"shape":"Boolean"} + } + }, + "EcsCluster":{ + "type":"structure", + "members":{ + "EcsClusterArn":{"shape":"String"}, + "EcsClusterName":{"shape":"String"}, + "StackId":{"shape":"String"}, + "RegisteredAt":{"shape":"DateTime"} + } + }, + "EcsClusters":{ + "type":"list", + "member":{"shape":"EcsCluster"} + }, + "ElasticIp":{ + "type":"structure", + "members":{ + "Ip":{"shape":"String"}, + "Name":{"shape":"String"}, + "Domain":{"shape":"String"}, + "Region":{"shape":"String"}, + "InstanceId":{"shape":"String"} + } + }, + "ElasticIps":{ + "type":"list", + "member":{"shape":"ElasticIp"} + }, + "ElasticLoadBalancer":{ + "type":"structure", + "members":{ + "ElasticLoadBalancerName":{"shape":"String"}, + "Region":{"shape":"String"}, + "DnsName":{"shape":"String"}, + "StackId":{"shape":"String"}, + "LayerId":{"shape":"String"}, + "VpcId":{"shape":"String"}, + "AvailabilityZones":{"shape":"Strings"}, + "SubnetIds":{"shape":"Strings"}, + "Ec2InstanceIds":{"shape":"Strings"} + } + }, + "ElasticLoadBalancers":{ + "type":"list", + "member":{"shape":"ElasticLoadBalancer"} + }, + "EnvironmentVariable":{ + "type":"structure", + "required":[ + "Key", + "Value" + ], + "members":{ + "Key":{"shape":"String"}, + "Value":{"shape":"String"}, + "Secure":{"shape":"Boolean"} + } + }, + "EnvironmentVariables":{ + "type":"list", + "member":{"shape":"EnvironmentVariable"} + }, + "GetHostnameSuggestionRequest":{ + "type":"structure", + "required":["LayerId"], + "members":{ + "LayerId":{"shape":"String"} + } + }, + "GetHostnameSuggestionResult":{ + "type":"structure", + "members":{ + "LayerId":{"shape":"String"}, + "Hostname":{"shape":"String"} + } + }, + "GrantAccessRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "InstanceId":{"shape":"String"}, + "ValidForInMinutes":{"shape":"ValidForInMinutes"} + } + }, + "GrantAccessResult":{ + "type":"structure", + "members":{ + "TemporaryCredential":{"shape":"TemporaryCredential"} + } + }, + "Hour":{"type":"string"}, + "Instance":{ + "type":"structure", + "members":{ + "AgentVersion":{"shape":"String"}, + "AmiId":{"shape":"String"}, + "Architecture":{"shape":"Architecture"}, + "AutoScalingType":{"shape":"AutoScalingType"}, + "AvailabilityZone":{"shape":"String"}, + "BlockDeviceMappings":{"shape":"BlockDeviceMappings"}, + "CreatedAt":{"shape":"DateTime"}, + "EbsOptimized":{"shape":"Boolean"}, + "Ec2InstanceId":{"shape":"String"}, + "EcsClusterArn":{"shape":"String"}, + "EcsContainerInstanceArn":{"shape":"String"}, + "ElasticIp":{"shape":"String"}, + "Hostname":{"shape":"String"}, + "InfrastructureClass":{"shape":"String"}, + "InstallUpdatesOnBoot":{"shape":"Boolean"}, + "InstanceId":{"shape":"String"}, + "InstanceProfileArn":{"shape":"String"}, + "InstanceType":{"shape":"String"}, + "LastServiceErrorId":{"shape":"String"}, + "LayerIds":{"shape":"Strings"}, + "Os":{"shape":"String"}, + "Platform":{"shape":"String"}, + "PrivateDns":{"shape":"String"}, + "PrivateIp":{"shape":"String"}, + "PublicDns":{"shape":"String"}, + "PublicIp":{"shape":"String"}, + "RegisteredBy":{"shape":"String"}, + "ReportedAgentVersion":{"shape":"String"}, + "ReportedOs":{"shape":"ReportedOs"}, + "RootDeviceType":{"shape":"RootDeviceType"}, + "RootDeviceVolumeId":{"shape":"String"}, + "SecurityGroupIds":{"shape":"Strings"}, + "SshHostDsaKeyFingerprint":{"shape":"String"}, + "SshHostRsaKeyFingerprint":{"shape":"String"}, + "SshKeyName":{"shape":"String"}, + "StackId":{"shape":"String"}, + "Status":{"shape":"String"}, + "SubnetId":{"shape":"String"}, + "Tenancy":{"shape":"String"}, + "VirtualizationType":{"shape":"VirtualizationType"} + } + }, + "InstanceIdentity":{ + "type":"structure", + "members":{ + "Document":{"shape":"String"}, + "Signature":{"shape":"String"} + } + }, + "Instances":{ + "type":"list", + "member":{"shape":"Instance"} + }, + "InstancesCount":{ + "type":"structure", + "members":{ + "Assigning":{"shape":"Integer"}, + "Booting":{"shape":"Integer"}, + "ConnectionLost":{"shape":"Integer"}, + "Deregistering":{"shape":"Integer"}, + "Online":{"shape":"Integer"}, + "Pending":{"shape":"Integer"}, + "Rebooting":{"shape":"Integer"}, + "Registered":{"shape":"Integer"}, + "Registering":{"shape":"Integer"}, + "Requested":{"shape":"Integer"}, + "RunningSetup":{"shape":"Integer"}, + "SetupFailed":{"shape":"Integer"}, + "ShuttingDown":{"shape":"Integer"}, + "StartFailed":{"shape":"Integer"}, + "Stopped":{"shape":"Integer"}, + "Stopping":{"shape":"Integer"}, + "Terminated":{"shape":"Integer"}, + "Terminating":{"shape":"Integer"}, + "Unassigning":{"shape":"Integer"} + } + }, + "Integer":{ + "type":"integer", + "box":true + }, + "Layer":{ + "type":"structure", + "members":{ + "StackId":{"shape":"String"}, + "LayerId":{"shape":"String"}, + "Type":{"shape":"LayerType"}, + "Name":{"shape":"String"}, + "Shortname":{"shape":"String"}, + "Attributes":{"shape":"LayerAttributes"}, + "CustomInstanceProfileArn":{"shape":"String"}, + "CustomJson":{"shape":"String"}, + "CustomSecurityGroupIds":{"shape":"Strings"}, + "DefaultSecurityGroupNames":{"shape":"Strings"}, + "Packages":{"shape":"Strings"}, + "VolumeConfigurations":{"shape":"VolumeConfigurations"}, + "EnableAutoHealing":{"shape":"Boolean"}, + "AutoAssignElasticIps":{"shape":"Boolean"}, + "AutoAssignPublicIps":{"shape":"Boolean"}, + "DefaultRecipes":{"shape":"Recipes"}, + "CustomRecipes":{"shape":"Recipes"}, + "CreatedAt":{"shape":"DateTime"}, + "InstallUpdatesOnBoot":{"shape":"Boolean"}, + "UseEbsOptimizedInstances":{"shape":"Boolean"}, + "LifecycleEventConfiguration":{"shape":"LifecycleEventConfiguration"} + } + }, + "LayerAttributes":{ + "type":"map", + "key":{"shape":"LayerAttributesKeys"}, + "value":{"shape":"String"} + }, + "LayerAttributesKeys":{ + "type":"string", + "enum":[ + "EcsClusterArn", + "EnableHaproxyStats", + "HaproxyStatsUrl", + "HaproxyStatsUser", + "HaproxyStatsPassword", + "HaproxyHealthCheckUrl", + "HaproxyHealthCheckMethod", + "MysqlRootPassword", + "MysqlRootPasswordUbiquitous", + "GangliaUrl", + "GangliaUser", + "GangliaPassword", + "MemcachedMemory", + "NodejsVersion", + "RubyVersion", + "RubygemsVersion", + "ManageBundler", + "BundlerVersion", + "RailsStack", + "PassengerVersion", + "Jvm", + "JvmVersion", + "JvmOptions", + "JavaAppServer", + "JavaAppServerVersion" + ] + }, + "LayerType":{ + "type":"string", + "enum":[ + "aws-flow-ruby", + "ecs-cluster", + "java-app", + "lb", + "web", + "php-app", + "rails-app", + "nodejs-app", + "memcached", + "db-master", + "monitoring-master", + "custom" + ] + }, + "Layers":{ + "type":"list", + "member":{"shape":"Layer"} + }, + "LifecycleEventConfiguration":{ + "type":"structure", + "members":{ + "Shutdown":{"shape":"ShutdownEventConfiguration"} + } + }, + "LoadBasedAutoScalingConfiguration":{ + "type":"structure", + "members":{ + "LayerId":{"shape":"String"}, + "Enable":{"shape":"Boolean"}, + "UpScaling":{"shape":"AutoScalingThresholds"}, + "DownScaling":{"shape":"AutoScalingThresholds"} + } + }, + "LoadBasedAutoScalingConfigurations":{ + "type":"list", + "member":{"shape":"LoadBasedAutoScalingConfiguration"} + }, + "Minute":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "Parameters":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"String"} + }, + "Permission":{ + "type":"structure", + "members":{ + "StackId":{"shape":"String"}, + "IamUserArn":{"shape":"String"}, + "AllowSsh":{"shape":"Boolean"}, + "AllowSudo":{"shape":"Boolean"}, + "Level":{"shape":"String"} + } + }, + "Permissions":{ + "type":"list", + "member":{"shape":"Permission"} + }, + "RaidArray":{ + "type":"structure", + "members":{ + "RaidArrayId":{"shape":"String"}, + "InstanceId":{"shape":"String"}, + "Name":{"shape":"String"}, + "RaidLevel":{"shape":"Integer"}, + "NumberOfDisks":{"shape":"Integer"}, + "Size":{"shape":"Integer"}, + "Device":{"shape":"String"}, + "MountPoint":{"shape":"String"}, + "AvailabilityZone":{"shape":"String"}, + "CreatedAt":{"shape":"DateTime"}, + "StackId":{"shape":"String"}, + "VolumeType":{"shape":"String"}, + "Iops":{"shape":"Integer"} + } + }, + "RaidArrays":{ + "type":"list", + "member":{"shape":"RaidArray"} + }, + "RdsDbInstance":{ + "type":"structure", + "members":{ + "RdsDbInstanceArn":{"shape":"String"}, + "DbInstanceIdentifier":{"shape":"String"}, + "DbUser":{"shape":"String"}, + "DbPassword":{"shape":"String"}, + "Region":{"shape":"String"}, + "Address":{"shape":"String"}, + "Engine":{"shape":"String"}, + "StackId":{"shape":"String"}, + "MissingOnRds":{"shape":"Boolean"} + } + }, + "RdsDbInstances":{ + "type":"list", + "member":{"shape":"RdsDbInstance"} + }, + "RebootInstanceRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "InstanceId":{"shape":"String"} + } + }, + "Recipes":{ + "type":"structure", + "members":{ + "Setup":{"shape":"Strings"}, + "Configure":{"shape":"Strings"}, + "Deploy":{"shape":"Strings"}, + "Undeploy":{"shape":"Strings"}, + "Shutdown":{"shape":"Strings"} + } + }, + "RegisterEcsClusterRequest":{ + "type":"structure", + "required":[ + "EcsClusterArn", + "StackId" + ], + "members":{ + "EcsClusterArn":{"shape":"String"}, + "StackId":{"shape":"String"} + } + }, + "RegisterEcsClusterResult":{ + "type":"structure", + "members":{ + "EcsClusterArn":{"shape":"String"} + } + }, + "RegisterElasticIpRequest":{ + "type":"structure", + "required":[ + "ElasticIp", + "StackId" + ], + "members":{ + "ElasticIp":{"shape":"String"}, + "StackId":{"shape":"String"} + } + }, + "RegisterElasticIpResult":{ + "type":"structure", + "members":{ + "ElasticIp":{"shape":"String"} + } + }, + "RegisterInstanceRequest":{ + "type":"structure", + "required":["StackId"], + "members":{ + "StackId":{"shape":"String"}, + "Hostname":{"shape":"String"}, + "PublicIp":{"shape":"String"}, + "PrivateIp":{"shape":"String"}, + "RsaPublicKey":{"shape":"String"}, + "RsaPublicKeyFingerprint":{"shape":"String"}, + "InstanceIdentity":{"shape":"InstanceIdentity"} + } + }, + "RegisterInstanceResult":{ + "type":"structure", + "members":{ + "InstanceId":{"shape":"String"} + } + }, + "RegisterRdsDbInstanceRequest":{ + "type":"structure", + "required":[ + "StackId", + "RdsDbInstanceArn", + "DbUser", + "DbPassword" + ], + "members":{ + "StackId":{"shape":"String"}, + "RdsDbInstanceArn":{"shape":"String"}, + "DbUser":{"shape":"String"}, + "DbPassword":{"shape":"String"} + } + }, + "RegisterVolumeRequest":{ + "type":"structure", + "required":["StackId"], + "members":{ + "Ec2VolumeId":{"shape":"String"}, + "StackId":{"shape":"String"} + } + }, + "RegisterVolumeResult":{ + "type":"structure", + "members":{ + "VolumeId":{"shape":"String"} + } + }, + "ReportedOs":{ + "type":"structure", + "members":{ + "Family":{"shape":"String"}, + "Name":{"shape":"String"}, + "Version":{"shape":"String"} + } + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "exception":true + }, + "RootDeviceType":{ + "type":"string", + "enum":[ + "ebs", + "instance-store" + ] + }, + "SelfUserProfile":{ + "type":"structure", + "members":{ + "IamUserArn":{"shape":"String"}, + "Name":{"shape":"String"}, + "SshUsername":{"shape":"String"}, + "SshPublicKey":{"shape":"String"} + } + }, + "ServiceError":{ + "type":"structure", + "members":{ + "ServiceErrorId":{"shape":"String"}, + "StackId":{"shape":"String"}, + "InstanceId":{"shape":"String"}, + "Type":{"shape":"String"}, + "Message":{"shape":"String"}, + "CreatedAt":{"shape":"DateTime"} + } + }, + "ServiceErrors":{ + "type":"list", + "member":{"shape":"ServiceError"} + }, + "SetLoadBasedAutoScalingRequest":{ + "type":"structure", + "required":["LayerId"], + "members":{ + "LayerId":{"shape":"String"}, + "Enable":{"shape":"Boolean"}, + "UpScaling":{"shape":"AutoScalingThresholds"}, + "DownScaling":{"shape":"AutoScalingThresholds"} + } + }, + "SetPermissionRequest":{ + "type":"structure", + "required":[ + "StackId", + "IamUserArn" + ], + "members":{ + "StackId":{"shape":"String"}, + "IamUserArn":{"shape":"String"}, + "AllowSsh":{"shape":"Boolean"}, + "AllowSudo":{"shape":"Boolean"}, + "Level":{"shape":"String"} + } + }, + "SetTimeBasedAutoScalingRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "InstanceId":{"shape":"String"}, + "AutoScalingSchedule":{"shape":"WeeklyAutoScalingSchedule"} + } + }, + "ShutdownEventConfiguration":{ + "type":"structure", + "members":{ + "ExecutionTimeout":{"shape":"Integer"}, + "DelayUntilElbConnectionsDrained":{"shape":"Boolean"} + } + }, + "Source":{ + "type":"structure", + "members":{ + "Type":{"shape":"SourceType"}, + "Url":{"shape":"String"}, + "Username":{"shape":"String"}, + "Password":{"shape":"String"}, + "SshKey":{"shape":"String"}, + "Revision":{"shape":"String"} + } + }, + "SourceType":{ + "type":"string", + "enum":[ + "git", + "svn", + "archive", + "s3" + ] + }, + "SslConfiguration":{ + "type":"structure", + "required":[ + "Certificate", + "PrivateKey" + ], + "members":{ + "Certificate":{"shape":"String"}, + "PrivateKey":{"shape":"String"}, + "Chain":{"shape":"String"} + } + }, + "Stack":{ + "type":"structure", + "members":{ + "StackId":{"shape":"String"}, + "Name":{"shape":"String"}, + "Arn":{"shape":"String"}, + "Region":{"shape":"String"}, + "VpcId":{"shape":"String"}, + "Attributes":{"shape":"StackAttributes"}, + "ServiceRoleArn":{"shape":"String"}, + "DefaultInstanceProfileArn":{"shape":"String"}, + "DefaultOs":{"shape":"String"}, + "HostnameTheme":{"shape":"String"}, + "DefaultAvailabilityZone":{"shape":"String"}, + "DefaultSubnetId":{"shape":"String"}, + "CustomJson":{"shape":"String"}, + "ConfigurationManager":{"shape":"StackConfigurationManager"}, + "ChefConfiguration":{"shape":"ChefConfiguration"}, + "UseCustomCookbooks":{"shape":"Boolean"}, + "UseOpsworksSecurityGroups":{"shape":"Boolean"}, + "CustomCookbooksSource":{"shape":"Source"}, + "DefaultSshKeyName":{"shape":"String"}, + "CreatedAt":{"shape":"DateTime"}, + "DefaultRootDeviceType":{"shape":"RootDeviceType"}, + "AgentVersion":{"shape":"String"} + } + }, + "StackAttributes":{ + "type":"map", + "key":{"shape":"StackAttributesKeys"}, + "value":{"shape":"String"} + }, + "StackAttributesKeys":{ + "type":"string", + "enum":["Color"] + }, + "StackConfigurationManager":{ + "type":"structure", + "members":{ + "Name":{"shape":"String"}, + "Version":{"shape":"String"} + } + }, + "StackSummary":{ + "type":"structure", + "members":{ + "StackId":{"shape":"String"}, + "Name":{"shape":"String"}, + "Arn":{"shape":"String"}, + "LayersCount":{"shape":"Integer"}, + "AppsCount":{"shape":"Integer"}, + "InstancesCount":{"shape":"InstancesCount"} + } + }, + "Stacks":{ + "type":"list", + "member":{"shape":"Stack"} + }, + "StartInstanceRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "InstanceId":{"shape":"String"} + } + }, + "StartStackRequest":{ + "type":"structure", + "required":["StackId"], + "members":{ + "StackId":{"shape":"String"} + } + }, + "StopInstanceRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "InstanceId":{"shape":"String"} + } + }, + "StopStackRequest":{ + "type":"structure", + "required":["StackId"], + "members":{ + "StackId":{"shape":"String"} + } + }, + "String":{"type":"string"}, + "Strings":{ + "type":"list", + "member":{"shape":"String"} + }, + "Switch":{"type":"string"}, + "TemporaryCredential":{ + "type":"structure", + "members":{ + "Username":{"shape":"String"}, + "Password":{"shape":"String"}, + "ValidForInMinutes":{"shape":"Integer"}, + "InstanceId":{"shape":"String"} + } + }, + "TimeBasedAutoScalingConfiguration":{ + "type":"structure", + "members":{ + "InstanceId":{"shape":"String"}, + "AutoScalingSchedule":{"shape":"WeeklyAutoScalingSchedule"} + } + }, + "TimeBasedAutoScalingConfigurations":{ + "type":"list", + "member":{"shape":"TimeBasedAutoScalingConfiguration"} + }, + "UnassignInstanceRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "InstanceId":{"shape":"String"} + } + }, + "UnassignVolumeRequest":{ + "type":"structure", + "required":["VolumeId"], + "members":{ + "VolumeId":{"shape":"String"} + } + }, + "UpdateAppRequest":{ + "type":"structure", + "required":["AppId"], + "members":{ + "AppId":{"shape":"String"}, + "Name":{"shape":"String"}, + "Description":{"shape":"String"}, + "DataSources":{"shape":"DataSources"}, + "Type":{"shape":"AppType"}, + "AppSource":{"shape":"Source"}, + "Domains":{"shape":"Strings"}, + "EnableSsl":{"shape":"Boolean"}, + "SslConfiguration":{"shape":"SslConfiguration"}, + "Attributes":{"shape":"AppAttributes"}, + "Environment":{"shape":"EnvironmentVariables"} + } + }, + "UpdateElasticIpRequest":{ + "type":"structure", + "required":["ElasticIp"], + "members":{ + "ElasticIp":{"shape":"String"}, + "Name":{"shape":"String"} + } + }, + "UpdateInstanceRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "InstanceId":{"shape":"String"}, + "LayerIds":{"shape":"Strings"}, + "InstanceType":{"shape":"String"}, + "AutoScalingType":{"shape":"AutoScalingType"}, + "Hostname":{"shape":"String"}, + "Os":{"shape":"String"}, + "AmiId":{"shape":"String"}, + "SshKeyName":{"shape":"String"}, + "Architecture":{"shape":"Architecture"}, + "InstallUpdatesOnBoot":{"shape":"Boolean"}, + "EbsOptimized":{"shape":"Boolean"}, + "AgentVersion":{"shape":"String"} + } + }, + "UpdateLayerRequest":{ + "type":"structure", + "required":["LayerId"], + "members":{ + "LayerId":{"shape":"String"}, + "Name":{"shape":"String"}, + "Shortname":{"shape":"String"}, + "Attributes":{"shape":"LayerAttributes"}, + "CustomInstanceProfileArn":{"shape":"String"}, + "CustomJson":{"shape":"String"}, + "CustomSecurityGroupIds":{"shape":"Strings"}, + "Packages":{"shape":"Strings"}, + "VolumeConfigurations":{"shape":"VolumeConfigurations"}, + "EnableAutoHealing":{"shape":"Boolean"}, + "AutoAssignElasticIps":{"shape":"Boolean"}, + "AutoAssignPublicIps":{"shape":"Boolean"}, + "CustomRecipes":{"shape":"Recipes"}, + "InstallUpdatesOnBoot":{"shape":"Boolean"}, + "UseEbsOptimizedInstances":{"shape":"Boolean"}, + "LifecycleEventConfiguration":{"shape":"LifecycleEventConfiguration"} + } + }, + "UpdateMyUserProfileRequest":{ + "type":"structure", + "members":{ + "SshPublicKey":{"shape":"String"} + } + }, + "UpdateRdsDbInstanceRequest":{ + "type":"structure", + "required":["RdsDbInstanceArn"], + "members":{ + "RdsDbInstanceArn":{"shape":"String"}, + "DbUser":{"shape":"String"}, + "DbPassword":{"shape":"String"} + } + }, + "UpdateStackRequest":{ + "type":"structure", + "required":["StackId"], + "members":{ + "StackId":{"shape":"String"}, + "Name":{"shape":"String"}, + "Attributes":{"shape":"StackAttributes"}, + "ServiceRoleArn":{"shape":"String"}, + "DefaultInstanceProfileArn":{"shape":"String"}, + "DefaultOs":{"shape":"String"}, + "HostnameTheme":{"shape":"String"}, + "DefaultAvailabilityZone":{"shape":"String"}, + "DefaultSubnetId":{"shape":"String"}, + "CustomJson":{"shape":"String"}, + "ConfigurationManager":{"shape":"StackConfigurationManager"}, + "ChefConfiguration":{"shape":"ChefConfiguration"}, + "UseCustomCookbooks":{"shape":"Boolean"}, + "CustomCookbooksSource":{"shape":"Source"}, + "DefaultSshKeyName":{"shape":"String"}, + "DefaultRootDeviceType":{"shape":"RootDeviceType"}, + "UseOpsworksSecurityGroups":{"shape":"Boolean"}, + "AgentVersion":{"shape":"String"} + } + }, + "UpdateUserProfileRequest":{ + "type":"structure", + "required":["IamUserArn"], + "members":{ + "IamUserArn":{"shape":"String"}, + "SshUsername":{"shape":"String"}, + "SshPublicKey":{"shape":"String"}, + "AllowSelfManagement":{"shape":"Boolean"} + } + }, + "UpdateVolumeRequest":{ + "type":"structure", + "required":["VolumeId"], + "members":{ + "VolumeId":{"shape":"String"}, + "Name":{"shape":"String"}, + "MountPoint":{"shape":"String"} + } + }, + "UserProfile":{ + "type":"structure", + "members":{ + "IamUserArn":{"shape":"String"}, + "Name":{"shape":"String"}, + "SshUsername":{"shape":"String"}, + "SshPublicKey":{"shape":"String"}, + "AllowSelfManagement":{"shape":"Boolean"} + } + }, + "UserProfiles":{ + "type":"list", + "member":{"shape":"UserProfile"} + }, + "ValidForInMinutes":{ + "type":"integer", + "box":true, + "max":1440, + "min":60 + }, + "ValidationException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "exception":true + }, + "VirtualizationType":{ + "type":"string", + "enum":[ + "paravirtual", + "hvm" + ] + }, + "Volume":{ + "type":"structure", + "members":{ + "VolumeId":{"shape":"String"}, + "Ec2VolumeId":{"shape":"String"}, + "Name":{"shape":"String"}, + "RaidArrayId":{"shape":"String"}, + "InstanceId":{"shape":"String"}, + "Status":{"shape":"String"}, + "Size":{"shape":"Integer"}, + "Device":{"shape":"String"}, + "MountPoint":{"shape":"String"}, + "Region":{"shape":"String"}, + "AvailabilityZone":{"shape":"String"}, + "VolumeType":{"shape":"String"}, + "Iops":{"shape":"Integer"} + } + }, + "VolumeConfiguration":{ + "type":"structure", + "required":[ + "MountPoint", + "NumberOfDisks", + "Size" + ], + "members":{ + "MountPoint":{"shape":"String"}, + "RaidLevel":{"shape":"Integer"}, + "NumberOfDisks":{"shape":"Integer"}, + "Size":{"shape":"Integer"}, + "VolumeType":{"shape":"String"}, + "Iops":{"shape":"Integer"} + } + }, + "VolumeConfigurations":{ + "type":"list", + "member":{"shape":"VolumeConfiguration"} + }, + "VolumeType":{ + "type":"string", + "enum":[ + "gp2", + "io1", + "standard" + ] + }, + "Volumes":{ + "type":"list", + "member":{"shape":"Volume"} + }, + "WeeklyAutoScalingSchedule":{ + "type":"structure", + "members":{ + "Monday":{"shape":"DailyAutoScalingSchedule"}, + "Tuesday":{"shape":"DailyAutoScalingSchedule"}, + "Wednesday":{"shape":"DailyAutoScalingSchedule"}, + "Thursday":{"shape":"DailyAutoScalingSchedule"}, + "Friday":{"shape":"DailyAutoScalingSchedule"}, + "Saturday":{"shape":"DailyAutoScalingSchedule"}, + "Sunday":{"shape":"DailyAutoScalingSchedule"} + } + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/opsworks/2013-02-18/docs-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/opsworks/2013-02-18/docs-2.json new file mode 100644 index 000000000..1e74540b2 --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/opsworks/2013-02-18/docs-2.json @@ -0,0 +1,1688 @@ +{ + "version": "2.0", + "service": "Welcome to the AWS OpsWorks API Reference. This guide provides descriptions, syntax, and usage examples for AWS OpsWorks actions and data types, including common parameters and error codes.
AWS OpsWorks is an application management service that provides an integrated experience for overseeing the complete application lifecycle. For information about this product, go to the AWS OpsWorks details page.
SDKs and CLI
The most common way to use the AWS OpsWorks API is by using the AWS Command Line Interface (CLI) or by using one of the AWS SDKs to implement applications in your preferred language. For more information, see:
Endpoints
AWS OpsWorks supports two endpoints, opsworks.us-east-1.amazonaws.com and opsworks.ap-south-1.amazonaws.com (both HTTPS). You must connect to one of those two endpoints. You can then use the API to direct AWS OpsWorks to create stacks in any AWS region. Stacks created in all regions except ap-south-1 are connected to the us-east-1 regional endpoint; stacks created in ap-south-1 are associated with the ap-south-1 regional endpoint, and can only be accessed or managed within that endpoint.
Chef Versions
When you call CreateStack, CloneStack, or UpdateStack we recommend you use the ConfigurationManager parameter to specify the Chef version. The recommended and default value for Linux stacks is currently 12. Windows stacks use Chef 12.2. For more information, see Chef Versions.
You can specify Chef 12, 11.10, or 11.4 for your Linux stack. We recommend migrating your existing Linux stacks to Chef 12 as soon as possible.
Assign a registered instance to a layer.
You can assign registered on-premises instances to any layer type.
You can assign registered Amazon EC2 instances only to custom layers.
You cannot use this action with instances that were created with AWS OpsWorks.
Required Permissions: To use this action, an AWS Identity and Access Management (IAM) user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
", + "AssignVolume": "Assigns one of the stack's registered Amazon EBS volumes to a specified instance. The volume must first be registered with the stack by calling RegisterVolume. After you register the volume, you must call UpdateVolume to specify a mount point before calling AssignVolume. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
", + "AssociateElasticIp": "Associates one of the stack's registered Elastic IP addresses with a specified instance. The address must first be registered with the stack by calling RegisterElasticIp. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
", + "AttachElasticLoadBalancer": "Attaches an Elastic Load Balancing load balancer to a specified layer. For more information, see Elastic Load Balancing.
You must create the Elastic Load Balancing instance separately, by using the Elastic Load Balancing console, API, or CLI. For more information, see Elastic Load Balancing Developer Guide.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
", + "CloneStack": "Creates a clone of a specified stack. For more information, see Clone a Stack. By default, all parameters are set to the values used by the parent stack.
Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
", + "CreateApp": "Creates an app for a specified stack. For more information, see Creating Apps.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
", + "CreateDeployment": "Runs deployment or stack commands. For more information, see Deploying Apps and Run Stack Commands.
Required Permissions: To use this action, an IAM user must have a Deploy or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
", + "CreateInstance": "Creates an instance in a specified stack. For more information, see Adding an Instance to a Layer.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
", + "CreateLayer": "Creates a layer. For more information, see How to Create a Layer.
You should use CreateLayer for noncustom layer types such as PHP App Server only if the stack does not have an existing layer of that type. A stack can have at most one instance of each noncustom layer; if you attempt to create a second instance, CreateLayer fails. A stack can have an arbitrary number of custom layers, so you can call CreateLayer as many times as you like for that layer type.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
", + "CreateStack": "Creates a new stack. For more information, see Create a New Stack.
Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
", + "CreateUserProfile": "Creates a new user profile.
Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
", + "DeleteApp": "Deletes a specified app.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
", + "DeleteInstance": "Deletes a specified instance, which terminates the associated Amazon EC2 instance. You must stop an instance before you can delete it.
For more information, see Deleting Instances.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
", + "DeleteLayer": "Deletes a specified layer. You must first stop and then delete all associated instances or unassign registered instances. For more information, see How to Delete a Layer.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
", + "DeleteStack": "Deletes a specified stack. You must first delete all instances, layers, and apps or deregister registered instances. For more information, see Shut Down a Stack.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
", + "DeleteUserProfile": "Deletes a user profile.
Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
", + "DeregisterEcsCluster": "Deregisters a specified Amazon ECS cluster from a stack. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html.
", + "DeregisterElasticIp": "Deregisters a specified Elastic IP address. The address can then be registered by another stack. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
", + "DeregisterInstance": "Deregister a registered Amazon EC2 or on-premises instance. This action removes the instance from the stack and returns it to your control. This action can not be used with instances that were created with AWS OpsWorks.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
", + "DeregisterRdsDbInstance": "Deregisters an Amazon RDS instance.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
", + "DeregisterVolume": "Deregisters an Amazon EBS volume. The volume can then be registered by another stack. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
", + "DescribeAgentVersions": "Describes the available AWS OpsWorks agent versions. You must specify a stack ID or a configuration manager. DescribeAgentVersions returns a list of available agent versions for the specified stack or configuration manager.
Requests a description of a specified set of apps.
You must specify at least one of the parameters.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
", + "DescribeCommands": "Describes the results of specified commands.
You must specify at least one of the parameters.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
", + "DescribeDeployments": "Requests a description of a specified set of deployments.
You must specify at least one of the parameters.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
", + "DescribeEcsClusters": "Describes Amazon ECS clusters that are registered with a stack. If you specify only a stack ID, you can use the MaxResults and NextToken parameters to paginate the response. However, AWS OpsWorks currently supports only one cluster per layer, so the result set has a maximum of one element.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack or an attached policy that explicitly grants permission. For more information on user permissions, see Managing User Permissions.
", + "DescribeElasticIps": "Describes Elastic IP addresses.
You must specify at least one of the parameters.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
", + "DescribeElasticLoadBalancers": "Describes a stack's Elastic Load Balancing instances.
You must specify at least one of the parameters.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
", + "DescribeInstances": "Requests a description of a set of instances.
You must specify at least one of the parameters.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
", + "DescribeLayers": "Requests a description of one or more layers in a specified stack.
You must specify at least one of the parameters.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
", + "DescribeLoadBasedAutoScaling": "Describes load-based auto scaling configurations for specified layers.
You must specify at least one of the parameters.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
", + "DescribeMyUserProfile": "Describes a user's SSH information.
Required Permissions: To use this action, an IAM user must have self-management enabled or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
", + "DescribePermissions": "Describes the permissions for a specified stack.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
", + "DescribeRaidArrays": "Describe an instance's RAID arrays.
You must specify at least one of the parameters.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
", + "DescribeRdsDbInstances": "Describes Amazon RDS instances.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
", + "DescribeServiceErrors": "Describes AWS OpsWorks service errors.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
", + "DescribeStackProvisioningParameters": "Requests a description of a stack's provisioning parameters.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
", + "DescribeStackSummary": "Describes the number of layers and apps in a specified stack, and the number of instances in each state, such as running_setup or online.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
", + "DescribeStacks": "Requests a description of one or more stacks.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
", + "DescribeTimeBasedAutoScaling": "Describes time-based auto scaling configurations for specified instances.
You must specify at least one of the parameters.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
", + "DescribeUserProfiles": "Describe specified users.
Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
", + "DescribeVolumes": "Describes an instance's Amazon EBS volumes.
You must specify at least one of the parameters.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
", + "DetachElasticLoadBalancer": "Detaches a specified Elastic Load Balancing instance from its layer.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
", + "DisassociateElasticIp": "Disassociates an Elastic IP address from its instance. The address remains registered with the stack. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
", + "GetHostnameSuggestion": "Gets a generated host name for the specified layer, based on the current host name theme.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
", + "GrantAccess": "This action can be used only with Windows stacks.
Grants RDP access to a Windows instance for a specified time period.
", + "RebootInstance": "Reboots a specified instance. For more information, see Starting, Stopping, and Rebooting Instances.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
", + "RegisterEcsCluster": "Registers a specified Amazon ECS cluster with a stack. You can register only one cluster with a stack. A cluster can be registered with only one stack. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
", + "RegisterElasticIp": "Registers an Elastic IP address with a specified stack. An address can be registered with only one stack at a time. If the address is already registered, you must first deregister it by calling DeregisterElasticIp. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
", + "RegisterInstance": "Registers instances with a specified stack that were created outside of AWS OpsWorks.
We do not recommend using this action to register instances. The complete registration operation has two primary steps, installing the AWS OpsWorks agent on the instance and registering the instance with the stack. RegisterInstance handles only the second step. You should instead use the AWS CLI register command, which performs the entire registration operation. For more information, see Registering an Instance with an AWS OpsWorks Stack.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
", + "RegisterRdsDbInstance": "Registers an Amazon RDS instance with a stack.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
", + "RegisterVolume": "Registers an Amazon EBS volume with a specified stack. A volume can be registered with only one stack at a time. If the volume is already registered, you must first deregister it by calling DeregisterVolume. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
", + "SetLoadBasedAutoScaling": "Specify the load-based auto scaling configuration for a specified layer. For more information, see Managing Load with Time-based and Load-based Instances.
To use load-based auto scaling, you must create a set of load-based auto scaling instances. Load-based auto scaling operates only on the instances from that set, so you must ensure that you have created enough instances to handle the maximum anticipated load.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
", + "SetPermission": "Specifies a user's permissions. For more information, see Security and Permissions.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
", + "SetTimeBasedAutoScaling": "Specify the time-based auto scaling configuration for a specified instance. For more information, see Managing Load with Time-based and Load-based Instances.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
", + "StartInstance": "Starts a specified instance. For more information, see Starting, Stopping, and Rebooting Instances.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
", + "StartStack": "Starts a stack's instances.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
", + "StopInstance": "Stops a specified instance. When you stop a standard instance, the data disappears and must be reinstalled when you restart the instance. You can stop an Amazon EBS-backed instance without losing data. For more information, see Starting, Stopping, and Rebooting Instances.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
", + "StopStack": "Stops a specified stack.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
", + "UnassignInstance": "Unassigns a registered instance from all of it's layers. The instance remains in the stack as an unassigned instance and can be assigned to another layer, as needed. You cannot use this action with instances that were created with AWS OpsWorks.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
", + "UnassignVolume": "Unassigns an assigned Amazon EBS volume. The volume remains registered with the stack. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
", + "UpdateApp": "Updates a specified app.
Required Permissions: To use this action, an IAM user must have a Deploy or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
", + "UpdateElasticIp": "Updates a registered Elastic IP address's name. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
", + "UpdateInstance": "Updates a specified instance.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
", + "UpdateLayer": "Updates a specified layer.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
", + "UpdateMyUserProfile": "Updates a user's SSH public key.
Required Permissions: To use this action, an IAM user must have self-management enabled or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
", + "UpdateRdsDbInstance": "Updates an Amazon RDS instance.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
", + "UpdateStack": "Updates a specified stack.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
", + "UpdateUserProfile": "Updates a specified user profile.
Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
", + "UpdateVolume": "Updates an Amazon EBS volume's name or mount point. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
" + }, + "shapes": { + "AgentVersion": { + "base": "Describes an agent version.
", + "refs": { + "AgentVersions$member": null + } + }, + "AgentVersions": { + "base": null, + "refs": { + "DescribeAgentVersionsResult$AgentVersions": "The agent versions for the specified stack or configuration manager. Note that this value is the complete version number, not the abbreviated number used by the console.
" + } + }, + "App": { + "base": "A description of the app.
", + "refs": { + "Apps$member": null + } + }, + "AppAttributes": { + "base": null, + "refs": { + "App$Attributes": "The stack attributes.
", + "CreateAppRequest$Attributes": "One or more user-defined key/value pairs to be added to the stack attributes.
", + "UpdateAppRequest$Attributes": "One or more user-defined key/value pairs to be added to the stack attributes.
" + } + }, + "AppAttributesKeys": { + "base": null, + "refs": { + "AppAttributes$key": null + } + }, + "AppType": { + "base": null, + "refs": { + "App$Type": "The app type.
", + "CreateAppRequest$Type": "The app type. Each supported type is associated with a particular layer. For example, PHP applications are associated with a PHP layer. AWS OpsWorks deploys an application to those instances that are members of the corresponding layer. If your app isn't one of the standard types, or you prefer to implement your own Deploy recipes, specify other.
The app type.
" + } + }, + "Apps": { + "base": null, + "refs": { + "DescribeAppsResult$Apps": "An array of App objects that describe the specified apps.
The instance architecture. The default option is x86_64. Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see Instance Families and Types.
The instance architecture: \"i386\" or \"x86_64\".
", + "UpdateInstanceRequest$Architecture": "The instance architecture. Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see Instance Families and Types.
" + } + }, + "AssignInstanceRequest": { + "base": null, + "refs": { + } + }, + "AssignVolumeRequest": { + "base": null, + "refs": { + } + }, + "AssociateElasticIpRequest": { + "base": null, + "refs": { + } + }, + "AttachElasticLoadBalancerRequest": { + "base": null, + "refs": { + } + }, + "AutoScalingThresholds": { + "base": "Describes a load-based auto scaling upscaling or downscaling threshold configuration, which specifies when AWS OpsWorks starts or stops load-based instances.
", + "refs": { + "LoadBasedAutoScalingConfiguration$UpScaling": "An AutoScalingThresholds object that describes the upscaling configuration, which defines how and when AWS OpsWorks increases the number of instances.
An AutoScalingThresholds object that describes the downscaling configuration, which defines how and when AWS OpsWorks reduces the number of instances.
An AutoScalingThresholds object with the upscaling threshold configuration. If the load exceeds these thresholds for a specified amount of time, AWS OpsWorks starts a specified number of instances.
An AutoScalingThresholds object with the downscaling threshold configuration. If the load falls below these thresholds for a specified amount of time, AWS OpsWorks stops a specified number of instances.
For load-based or time-based instances, the type. Windows stacks can use only time-based instances.
", + "Instance$AutoScalingType": "For load-based or time-based instances, the type.
", + "UpdateInstanceRequest$AutoScalingType": "For load-based or time-based instances, the type. Windows stacks can use only time-based instances.
" + } + }, + "BlockDeviceMapping": { + "base": "Describes a block device mapping. This data type maps directly to the Amazon EC2 BlockDeviceMapping data type.
", + "refs": { + "BlockDeviceMappings$member": null + } + }, + "BlockDeviceMappings": { + "base": null, + "refs": { + "CreateInstanceRequest$BlockDeviceMappings": "An array of BlockDeviceMapping objects that specify the instance's block devices. For more information, see Block Device Mapping. Note that block device mappings are not supported for custom AMIs.
An array of BlockDeviceMapping objects that specify the instance's block device mappings.
Whether to enable SSL for the app.
", + "ChefConfiguration$ManageBerkshelf": "Whether to enable Berkshelf.
", + "CloneStackRequest$UseCustomCookbooks": "Whether to use custom cookbooks.
", + "CloneStackRequest$UseOpsworksSecurityGroups": "Whether to associate the AWS OpsWorks built-in security groups with the stack's layers.
AWS OpsWorks provides a standard set of built-in security groups, one for each layer, which are associated with layers by default. With UseOpsworksSecurityGroups you can instead provide your own custom security groups. UseOpsworksSecurityGroups has the following settings:
True - AWS OpsWorks automatically associates the appropriate built-in security group with each layer (default setting). You can associate additional security groups with a layer after you create it but you cannot delete the built-in security group.
False - AWS OpsWorks does not associate built-in security groups with layers. You must create appropriate Amazon Elastic Compute Cloud (Amazon EC2) security groups and associate a security group with each layer that you create. However, you can still manually associate a built-in security group with a layer on creation; custom security groups are required only for those layers that need custom settings.
For more information, see Create a New Stack.
", + "CloneStackRequest$ClonePermissions": "Whether to clone the source stack's permissions.
", + "CreateAppRequest$EnableSsl": "Whether to enable SSL for the app.
", + "CreateInstanceRequest$InstallUpdatesOnBoot": "Whether to install operating system and package updates when the instance boots. The default value is true. To control when updates are installed, set this value to false. You must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or by manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.
We strongly recommend using the default value of true to ensure that your instances have the latest security updates.
Whether to create an Amazon EBS-optimized instance.
", + "CreateLayerRequest$EnableAutoHealing": "Whether to disable auto healing for the layer.
", + "CreateLayerRequest$AutoAssignElasticIps": "Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer.
", + "CreateLayerRequest$AutoAssignPublicIps": "For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances. For more information, see How to Edit a Layer.
", + "CreateLayerRequest$InstallUpdatesOnBoot": "Whether to install operating system and package updates when the instance boots. The default value is true. To control when updates are installed, set this value to false. You must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or by manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.
To ensure that your instances have the latest security updates, we strongly recommend using the default value of true.
Whether to use Amazon EBS-optimized instances.
", + "CreateStackRequest$UseCustomCookbooks": "Whether the stack uses custom cookbooks.
", + "CreateStackRequest$UseOpsworksSecurityGroups": "Whether to associate the AWS OpsWorks built-in security groups with the stack's layers.
AWS OpsWorks provides a standard set of built-in security groups, one for each layer, which are associated with layers by default. With UseOpsworksSecurityGroups you can instead provide your own custom security groups. UseOpsworksSecurityGroups has the following settings:
True - AWS OpsWorks automatically associates the appropriate built-in security group with each layer (default setting). You can associate additional security groups with a layer after you create it, but you cannot delete the built-in security group.
False - AWS OpsWorks does not associate built-in security groups with layers. You must create appropriate EC2 security groups and associate a security group with each layer that you create. However, you can still manually associate a built-in security group with a layer on creation; custom security groups are required only for those layers that need custom settings.
For more information, see Create a New Stack.
", + "CreateUserProfileRequest$AllowSelfManagement": "Whether users can specify their own SSH public key through the My Settings page. For more information, see Setting an IAM User's Public SSH Key.
", + "DeleteInstanceRequest$DeleteElasticIp": "Whether to delete the instance Elastic IP address.
", + "DeleteInstanceRequest$DeleteVolumes": "Whether to delete the instance's Amazon EBS volumes.
", + "EbsBlockDevice$DeleteOnTermination": "Whether the volume is deleted on instance termination.
", + "EnvironmentVariable$Secure": "(Optional) Whether the variable's value will be returned by the DescribeApps action. To conceal an environment variable's value, set Secure to true. DescribeApps then returns *****FILTERED***** instead of the actual value. The default value for Secure is false.
Whether this is an Amazon EBS-optimized instance.
", + "Instance$InstallUpdatesOnBoot": "Whether to install operating system and package updates when the instance boots. The default value is true. If this value is set to false, you must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or by manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.
We strongly recommend using the default value of true, to ensure that your instances have the latest security updates.
Whether auto healing is disabled for the layer.
", + "Layer$AutoAssignElasticIps": "Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer.
", + "Layer$AutoAssignPublicIps": "For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances. For more information, see How to Edit a Layer.
", + "Layer$InstallUpdatesOnBoot": "Whether to install operating system and package updates when the instance boots. The default value is true. If this value is set to false, you must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.
We strongly recommend using the default value of true, to ensure that your instances have the latest security updates.
Whether the layer uses Amazon EBS-optimized instances.
", + "LoadBasedAutoScalingConfiguration$Enable": "Whether load-based auto scaling is enabled for the layer.
", + "Permission$AllowSsh": "Whether the user can use SSH.
", + "Permission$AllowSudo": "Whether the user can use sudo.
", + "RdsDbInstance$MissingOnRds": "Set to true if AWS OpsWorks was unable to discover the Amazon RDS instance. AWS OpsWorks attempts to discover the instance only once. If this value is set to true, you must deregister the instance and then register it again.
Enables load-based auto scaling for the layer.
", + "SetPermissionRequest$AllowSsh": "The user is allowed to use SSH to communicate with the instance.
", + "SetPermissionRequest$AllowSudo": "The user is allowed to use sudo to elevate privileges.
", + "ShutdownEventConfiguration$DelayUntilElbConnectionsDrained": "Whether to enable Elastic Load Balancing connection draining. For more information, see Connection Draining
", + "Stack$UseCustomCookbooks": "Whether the stack uses custom cookbooks.
", + "Stack$UseOpsworksSecurityGroups": "Whether the stack automatically associates the AWS OpsWorks built-in security groups with the stack's layers.
", + "UpdateAppRequest$EnableSsl": "Whether SSL is enabled for the app.
", + "UpdateInstanceRequest$InstallUpdatesOnBoot": "Whether to install operating system and package updates when the instance boots. The default value is true. To control when updates are installed, set this value to false. You must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or by manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.
We strongly recommend using the default value of true, to ensure that your instances have the latest security updates.
This property cannot be updated.
", + "UpdateLayerRequest$EnableAutoHealing": "Whether to disable auto healing for the layer.
", + "UpdateLayerRequest$AutoAssignElasticIps": "Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer.
", + "UpdateLayerRequest$AutoAssignPublicIps": "For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances. For more information, see How to Edit a Layer.
", + "UpdateLayerRequest$InstallUpdatesOnBoot": "Whether to install operating system and package updates when the instance boots. The default value is true. To control when updates are installed, set this value to false. You must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.
We strongly recommend using the default value of true, to ensure that your instances have the latest security updates.
Whether to use Amazon EBS-optimized instances.
", + "UpdateStackRequest$UseCustomCookbooks": "Whether the stack uses custom cookbooks.
", + "UpdateStackRequest$UseOpsworksSecurityGroups": "Whether to associate the AWS OpsWorks built-in security groups with the stack's layers.
AWS OpsWorks provides a standard set of built-in security groups, one for each layer, which are associated with layers by default. UseOpsworksSecurityGroups allows you to provide your own custom security groups instead of using the built-in groups. UseOpsworksSecurityGroups has the following settings:
True - AWS OpsWorks automatically associates the appropriate built-in security group with each layer (default setting). You can associate additional security groups with a layer after you create it, but you cannot delete the built-in security group.
False - AWS OpsWorks does not associate built-in security groups with layers. You must create appropriate EC2 security groups and associate a security group with each layer that you create. However, you can still manually associate a built-in security group with a layer on. Custom security groups are required only for those layers that need custom settings.
For more information, see Create a New Stack.
", + "UpdateUserProfileRequest$AllowSelfManagement": "Whether users can specify their own SSH public key through the My Settings page. For more information, see Managing User Permissions.
", + "UserProfile$AllowSelfManagement": "Whether users can specify their own SSH public key through the My Settings page. For more information, see Managing User Permissions.
" + } + }, + "ChefConfiguration": { + "base": "Describes the Chef configuration.
", + "refs": { + "CloneStackRequest$ChefConfiguration": "A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version on Chef 11.10 stacks. For more information, see Create a New Stack.
A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version on Chef 11.10 stacks. For more information, see Create a New Stack.
A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version. For more information, see Create a New Stack.
A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version on Chef 11.10 stacks. For more information, see Create a New Stack.
Contains the response to a CloneStack request.
Describes a command.
", + "refs": { + "Commands$member": null + } + }, + "Commands": { + "base": null, + "refs": { + "DescribeCommandsResult$Commands": "An array of Command objects that describe each of the specified commands.
Contains the response to a CreateApp request.
Contains the response to a CreateDeployment request.
Contains the response to a CreateInstance request.
Contains the response to a CreateLayer request.
Contains the response to a CreateStack request.
Contains the response to a CreateUserProfile request.
The schedule for Monday.
", + "WeeklyAutoScalingSchedule$Tuesday": "The schedule for Tuesday.
", + "WeeklyAutoScalingSchedule$Wednesday": "The schedule for Wednesday.
", + "WeeklyAutoScalingSchedule$Thursday": "The schedule for Thursday.
", + "WeeklyAutoScalingSchedule$Friday": "The schedule for Friday.
", + "WeeklyAutoScalingSchedule$Saturday": "The schedule for Saturday.
", + "WeeklyAutoScalingSchedule$Sunday": "The schedule for Sunday.
" + } + }, + "DataSource": { + "base": "Describes an app's data source.
", + "refs": { + "DataSources$member": null + } + }, + "DataSources": { + "base": null, + "refs": { + "App$DataSources": "The app's data sources.
", + "CreateAppRequest$DataSources": "The app's data source.
", + "UpdateAppRequest$DataSources": "The app's data sources.
" + } + }, + "DateTime": { + "base": null, + "refs": { + "Command$CreatedAt": "Date and time when the command was run.
", + "Command$AcknowledgedAt": "Date and time when the command was acknowledged.
", + "Command$CompletedAt": "Date when the command completed.
", + "Deployment$CreatedAt": "Date when the deployment was created.
", + "Deployment$CompletedAt": "Date when the deployment completed.
", + "EcsCluster$RegisteredAt": "The time and date that the cluster was registered with the stack.
", + "Instance$CreatedAt": "The time that the instance was created.
", + "Layer$CreatedAt": "Date when the layer was created.
", + "RaidArray$CreatedAt": "When the RAID array was created.
", + "ServiceError$CreatedAt": "When the error occurred.
", + "Stack$CreatedAt": "The date when the stack was created.
" + } + }, + "DeleteAppRequest": { + "base": null, + "refs": { + } + }, + "DeleteInstanceRequest": { + "base": null, + "refs": { + } + }, + "DeleteLayerRequest": { + "base": null, + "refs": { + } + }, + "DeleteStackRequest": { + "base": null, + "refs": { + } + }, + "DeleteUserProfileRequest": { + "base": null, + "refs": { + } + }, + "Deployment": { + "base": "Describes a deployment of a stack or app.
", + "refs": { + "Deployments$member": null + } + }, + "DeploymentCommand": { + "base": "Used to specify a stack or deployment command.
", + "refs": { + "CreateDeploymentRequest$Command": "A DeploymentCommand object that specifies the deployment command and any associated arguments.
The arguments of those commands that take arguments. It should be set to a JSON object with the following format:
{\"arg_name1\" : [\"value1\", \"value2\", ...], \"arg_name2\" : [\"value1\", \"value2\", ...], ...}
The update_dependencies command takes two arguments:
upgrade_os_to - Specifies the desired Amazon Linux version for instances whose OS you want to upgrade, such as Amazon Linux 2014.09. You must also set the allow_reboot argument to true.
allow_reboot - Specifies whether to allow AWS OpsWorks to reboot the instances if necessary, after installing the updates. This argument can be set to either true or false. The default value is false.
For example, to upgrade an instance to Amazon Linux 2014.09, set Args to the following.
{ \"upgrade_os_to\":[\"Amazon Linux 2014.09\"], \"allow_reboot\":[\"true\"] }
Specifies the operation. You can specify only one command.
For stacks, the following commands are available:
execute_recipes: Execute one or more recipes. To specify the recipes, set an Args parameter named recipes to the list of recipes to be executed. For example, to execute phpapp::appsetup, set Args to {\"recipes\":[\"phpapp::appsetup\"]}.
install_dependencies: Install the stack's dependencies.
update_custom_cookbooks: Update the stack's custom cookbooks.
update_dependencies: Update the stack's dependencies.
The update_dependencies and install_dependencies commands are supported only for Linux instances. You can run the commands successfully on Windows instances, but they do nothing.
For apps, the following commands are available:
deploy: Deploy an app. Ruby on Rails apps have an optional Args parameter named migrate. Set Args to {\"migrate\":[\"true\"]} to migrate the database. The default setting is {\"migrate\":[\"false\"]}.
rollback Roll the app back to the previous version. When you update an app, AWS OpsWorks stores the previous version, up to a maximum of five versions. You can use this command to roll an app back as many as four versions.
start: Start the app's web or application server.
stop: Stop the app's web or application server.
restart: Restart the app's web or application server.
undeploy: Undeploy the app.
An array of Deployment objects that describe the deployments.
Contains the response to a DescribeAgentVersions request.
Contains the response to a DescribeApps request.
Contains the response to a DescribeCommands request.
Contains the response to a DescribeDeployments request.
Contains the response to a DescribeEcsClusters request.
Contains the response to a DescribeElasticIps request.
Contains the response to a DescribeElasticLoadBalancers request.
Contains the response to a DescribeInstances request.
Contains the response to a DescribeLayers request.
Contains the response to a DescribeLoadBasedAutoScaling request.
Contains the response to a DescribeMyUserProfile request.
Contains the response to a DescribePermissions request.
Contains the response to a DescribeRaidArrays request.
Contains the response to a DescribeRdsDbInstances request.
Contains the response to a DescribeServiceErrors request.
Contains the response to a DescribeStackProvisioningParameters request.
Contains the response to a DescribeStackSummary request.
Contains the response to a DescribeStacks request.
Contains the response to a DescribeTimeBasedAutoScaling request.
Contains the response to a DescribeUserProfiles request.
Contains the response to a DescribeVolumes request.
The CPU utilization threshold, as a percent of the available CPU. A value of -1 disables the threshold.
", + "AutoScalingThresholds$MemoryThreshold": "The memory utilization threshold, as a percent of the available memory. A value of -1 disables the threshold.
", + "AutoScalingThresholds$LoadThreshold": "The load threshold. A value of -1 disables the threshold. For more information about how load is computed, see Load (computing).
" + } + }, + "EbsBlockDevice": { + "base": "Describes an Amazon EBS volume. This data type maps directly to the Amazon EC2 EbsBlockDevice data type.
", + "refs": { + "BlockDeviceMapping$Ebs": "An EBSBlockDevice that defines how to configure an Amazon EBS volume when the instance is launched.
Describes a registered Amazon ECS cluster.
", + "refs": { + "EcsClusters$member": null + } + }, + "EcsClusters": { + "base": null, + "refs": { + "DescribeEcsClustersResult$EcsClusters": "A list of EcsCluster objects containing the cluster descriptions.
Describes an Elastic IP address.
", + "refs": { + "ElasticIps$member": null + } + }, + "ElasticIps": { + "base": null, + "refs": { + "DescribeElasticIpsResult$ElasticIps": "An ElasticIps object that describes the specified Elastic IP addresses.
Describes an Elastic Load Balancing instance.
", + "refs": { + "ElasticLoadBalancers$member": null + } + }, + "ElasticLoadBalancers": { + "base": null, + "refs": { + "DescribeElasticLoadBalancersResult$ElasticLoadBalancers": "A list of ElasticLoadBalancer objects that describe the specified Elastic Load Balancing instances.
Represents an app's environment variable.
", + "refs": { + "EnvironmentVariables$member": null + } + }, + "EnvironmentVariables": { + "base": null, + "refs": { + "App$Environment": "An array of EnvironmentVariable objects that specify environment variables to be associated with the app. After you deploy the app, these variables are defined on the associated app server instances. For more information, see Environment Variables.
There is no specific limit on the number of environment variables. However, the size of the associated data structure - which includes the variable names, values, and protected flag values - cannot exceed 10 KB (10240 Bytes). This limit should accommodate most if not all use cases, but if you do exceed it, you will cause an exception (API) with an \"Environment: is too large (maximum is 10KB)\" message.
An array of EnvironmentVariable objects that specify environment variables to be associated with the app. After you deploy the app, these variables are defined on the associated app server instance. For more information, see Environment Variables.
There is no specific limit on the number of environment variables. However, the size of the associated data structure - which includes the variables' names, values, and protected flag values - cannot exceed 10 KB (10240 Bytes). This limit should accommodate most if not all use cases. Exceeding it will cause an exception with the message, \"Environment: is too large (maximum is 10KB).\"
This parameter is supported only by Chef 11.10 stacks. If you have specified one or more environment variables, you cannot modify the stack's Chef version.
An array of EnvironmentVariable objects that specify environment variables to be associated with the app. After you deploy the app, these variables are defined on the associated app server instances.For more information, see Environment Variables.
There is no specific limit on the number of environment variables. However, the size of the associated data structure - which includes the variables' names, values, and protected flag values - cannot exceed 10 KB (10240 Bytes). This limit should accommodate most if not all use cases. Exceeding it will cause an exception with the message, \"Environment: is too large (maximum is 10KB).\"
This parameter is supported only by Chef 11.10 stacks. If you have specified one or more environment variables, you cannot modify the stack's Chef version.
Contains the response to a GetHostnameSuggestion request.
Contains the response to a GrantAccess request.
Describes an instance.
", + "refs": { + "Instances$member": null + } + }, + "InstanceIdentity": { + "base": "Contains a description of an Amazon EC2 instance from the Amazon EC2 metadata service. For more information, see Instance Metadata and User Data.
", + "refs": { + "RegisterInstanceRequest$InstanceIdentity": "An InstanceIdentity object that contains the instance's identity.
" + } + }, + "Instances": { + "base": null, + "refs": { + "DescribeInstancesResult$Instances": "An array of Instance objects that describe the instances.
Describes how many instances a stack has for each status.
", + "refs": { + "StackSummary$InstancesCount": "An InstancesCount object with the number of instances in each status.
The number of instances to add or remove when the load exceeds a threshold.
", + "Command$ExitCode": "The command exit code.
", + "Deployment$Duration": "The deployment duration.
", + "DescribeEcsClustersRequest$MaxResults": "To receive a paginated response, use this parameter to specify the maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.
The number of I/O operations per second (IOPS) that the volume supports. For more information, see EbsBlockDevice.
", + "EbsBlockDevice$VolumeSize": "The volume size, in GiB. For more information, see EbsBlockDevice.
", + "InstancesCount$Assigning": "The number of instances in the Assigning state.
", + "InstancesCount$Booting": "The number of instances with booting status.
The number of instances with connection_lost status.
The number of instances in the Deregistering state.
", + "InstancesCount$Online": "The number of instances with online status.
The number of instances with pending status.
The number of instances with rebooting status.
The number of instances in the Registered state.
", + "InstancesCount$Registering": "The number of instances in the Registering state.
", + "InstancesCount$Requested": "The number of instances with requested status.
The number of instances with running_setup status.
The number of instances with setup_failed status.
The number of instances with shutting_down status.
The number of instances with start_failed status.
The number of instances with stopped status.
The number of instances with stopping status.
The number of instances with terminated status.
The number of instances with terminating status.
The number of instances in the Unassigning state.
", + "RaidArray$RaidLevel": "The RAID level.
", + "RaidArray$NumberOfDisks": "The number of disks in the array.
", + "RaidArray$Size": "The array's size.
", + "RaidArray$Iops": "For PIOPS volumes, the IOPS per disk.
", + "ShutdownEventConfiguration$ExecutionTimeout": "The time, in seconds, that AWS OpsWorks will wait after triggering a Shutdown event before shutting down an instance.
", + "StackSummary$LayersCount": "The number of layers.
", + "StackSummary$AppsCount": "The number of apps.
", + "TemporaryCredential$ValidForInMinutes": "The length of time (in minutes) that the grant is valid. When the grant expires, at the end of this period, the user will no longer be able to use the credentials to log in. If they are logged in at the time, they will be automatically logged out.
", + "Volume$Size": "The volume size.
", + "Volume$Iops": "For PIOPS volumes, the IOPS per disk.
", + "VolumeConfiguration$RaidLevel": "The volume RAID level.
", + "VolumeConfiguration$NumberOfDisks": "The number of disks in the volume.
", + "VolumeConfiguration$Size": "The volume size.
", + "VolumeConfiguration$Iops": "For PIOPS volumes, the IOPS per disk.
" + } + }, + "Layer": { + "base": "Describes a layer.
", + "refs": { + "Layers$member": null + } + }, + "LayerAttributes": { + "base": null, + "refs": { + "CreateLayerRequest$Attributes": "One or more user-defined key-value pairs to be added to the stack attributes.
To create a cluster layer, set the EcsClusterArn attribute to the cluster's ARN.
The layer attributes.
For the HaproxyStatsPassword, MysqlRootPassword, and GangliaPassword attributes, AWS OpsWorks returns *****FILTERED***** instead of the actual value
For an ECS Cluster layer, AWS OpsWorks the EcsClusterArn attribute is set to the cluster's ARN.
One or more user-defined key/value pairs to be added to the stack attributes.
" + } + }, + "LayerAttributesKeys": { + "base": null, + "refs": { + "LayerAttributes$key": null + } + }, + "LayerType": { + "base": null, + "refs": { + "CreateLayerRequest$Type": "The layer type. A stack cannot have more than one built-in layer of the same type. It can have any number of custom layers. Built-in layers are not available in Chef 12 stacks.
", + "Layer$Type": "The layer type.
" + } + }, + "Layers": { + "base": null, + "refs": { + "DescribeLayersResult$Layers": "An array of Layer objects that describe the layers.
Specifies the lifecycle event configuration
", + "refs": { + "CreateLayerRequest$LifecycleEventConfiguration": "A LifeCycleEventConfiguration object that you can use to configure the Shutdown event to specify an execution timeout and enable or disable Elastic Load Balancer connection draining.
A LifeCycleEventConfiguration object that specifies the Shutdown event configuration.
Describes a layer's load-based auto scaling configuration.
", + "refs": { + "LoadBasedAutoScalingConfigurations$member": null + } + }, + "LoadBasedAutoScalingConfigurations": { + "base": null, + "refs": { + "DescribeLoadBasedAutoScalingResult$LoadBasedAutoScalingConfigurations": "An array of LoadBasedAutoScalingConfiguration objects that describe each layer's configuration.
The amount of time, in minutes, that the load must exceed a threshold before more instances are added or removed.
", + "AutoScalingThresholds$IgnoreMetricsTime": "The amount of time (in minutes) after a scaling event occurs that AWS OpsWorks should ignore metrics and suppress additional scaling events. For example, AWS OpsWorks adds new instances following an upscaling event but the instances won't start reducing the load until they have been booted and configured. There is no point in raising additional scaling events during that operation, which typically takes several minutes. IgnoreMetricsTime allows you to direct AWS OpsWorks to suppress scaling events long enough to get the new instances online.
An embedded object that contains the provisioning parameters.
" + } + }, + "Permission": { + "base": "Describes stack or user permissions.
", + "refs": { + "Permissions$member": null + } + }, + "Permissions": { + "base": null, + "refs": { + "DescribePermissionsResult$Permissions": "An array of Permission objects that describe the stack permissions.
If the request object contains only a stack ID, the array contains a Permission object with permissions for each of the stack IAM ARNs.
If the request object contains only an IAM ARN, the array contains a Permission object with permissions for each of the user's stack IDs.
If the request contains a stack ID and an IAM ARN, the array contains a single Permission object with permissions for the specified stack and IAM ARN.
Describes an instance's RAID array.
", + "refs": { + "RaidArrays$member": null + } + }, + "RaidArrays": { + "base": null, + "refs": { + "DescribeRaidArraysResult$RaidArrays": "A RaidArrays object that describes the specified RAID arrays.
Describes an Amazon RDS instance.
", + "refs": { + "RdsDbInstances$member": null + } + }, + "RdsDbInstances": { + "base": null, + "refs": { + "DescribeRdsDbInstancesResult$RdsDbInstances": "An a array of RdsDbInstance objects that describe the instances.
AWS OpsWorks supports five lifecycle events: setup, configuration, deploy, undeploy, and shutdown. For each layer, AWS OpsWorks runs a set of standard recipes for each event. In addition, you can provide custom recipes for any or all layers and events. AWS OpsWorks runs custom event recipes after the standard recipes. LayerCustomRecipes specifies the custom recipes for a particular layer to be run in response to each of the five events.
To specify a recipe, use the cookbook's directory name in the repository followed by two colons and the recipe name, which is the recipe's file name without the .rb extension. For example: phpapp2::dbsetup specifies the dbsetup.rb recipe in the repository's phpapp2 folder.
", + "refs": { + "CreateLayerRequest$CustomRecipes": "A LayerCustomRecipes object that specifies the layer custom recipes.
A LayerCustomRecipes object that specifies the layer's custom recipes.
A LayerCustomRecipes object that specifies the layer's custom recipes.
Contains the response to a RegisterEcsCluster request.
Contains the response to a RegisterElasticIp request.
Contains the response to a RegisterInstanceResult request.
Contains the response to a RegisterVolume request.
A registered instance's reported operating system.
", + "refs": { + "Instance$ReportedOs": "For registered instances, the reported operating system.
" + } + }, + "ResourceNotFoundException": { + "base": "Indicates that a resource was not found.
", + "refs": { + } + }, + "RootDeviceType": { + "base": null, + "refs": { + "CloneStackRequest$DefaultRootDeviceType": "The default root device type. This value is used by default for all instances in the cloned stack, but you can override it when you create an instance. For more information, see Storage for the Root Device.
", + "CreateInstanceRequest$RootDeviceType": "The instance root device type. For more information, see Storage for the Root Device.
", + "CreateStackRequest$DefaultRootDeviceType": "The default root device type. This value is the default for all instances in the stack, but you can override it when you create an instance. The default option is instance-store. For more information, see Storage for the Root Device.
The instance's root device type. For more information, see Storage for the Root Device.
", + "Stack$DefaultRootDeviceType": "The default root device type. This value is used by default for all instances in the stack, but you can override it when you create an instance. For more information, see Storage for the Root Device.
", + "UpdateStackRequest$DefaultRootDeviceType": "The default root device type. This value is used by default for all instances in the stack, but you can override it when you create an instance. For more information, see Storage for the Root Device.
" + } + }, + "SelfUserProfile": { + "base": "Describes a user's SSH information.
", + "refs": { + "DescribeMyUserProfileResult$UserProfile": "A UserProfile object that describes the user's SSH information.
Describes an AWS OpsWorks service error.
", + "refs": { + "ServiceErrors$member": null + } + }, + "ServiceErrors": { + "base": null, + "refs": { + "DescribeServiceErrorsResult$ServiceErrors": "An array of ServiceError objects that describe the specified service errors.
The Shutdown event configuration.
", + "refs": { + "LifecycleEventConfiguration$Shutdown": "A ShutdownEventConfiguration object that specifies the Shutdown event configuration.
Contains the information required to retrieve an app or cookbook from a repository. For more information, see Creating Apps or Custom Recipes and Cookbooks.
", + "refs": { + "App$AppSource": "A Source object that describes the app repository.
A Source object that specifies the app repository.
A Source object that specifies the app repository.
The repository type.
" + } + }, + "SslConfiguration": { + "base": "Describes an app's SSL configuration.
", + "refs": { + "App$SslConfiguration": "An SslConfiguration object with the SSL configuration.
An SslConfiguration object with the SSL configuration.
An SslConfiguration object with the SSL configuration.
Describes a stack.
", + "refs": { + "Stacks$member": null + } + }, + "StackAttributes": { + "base": null, + "refs": { + "CloneStackRequest$Attributes": "A list of stack attributes and values as key/value pairs to be added to the cloned stack.
", + "CreateStackRequest$Attributes": "One or more user-defined key-value pairs to be added to the stack attributes.
", + "Stack$Attributes": "The stack's attributes.
", + "UpdateStackRequest$Attributes": "One or more user-defined key-value pairs to be added to the stack attributes.
" + } + }, + "StackAttributesKeys": { + "base": null, + "refs": { + "StackAttributes$key": null + } + }, + "StackConfigurationManager": { + "base": "Describes the configuration manager.
", + "refs": { + "AgentVersion$ConfigurationManager": "The configuration manager.
", + "CloneStackRequest$ConfigurationManager": "The configuration manager. When you clone a stack we recommend that you use the configuration manager to specify the Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is currently 12.
", + "CreateStackRequest$ConfigurationManager": "The configuration manager. When you create a stack we recommend that you use the configuration manager to specify the Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is currently 11.4.
", + "DescribeAgentVersionsRequest$ConfigurationManager": "The configuration manager.
", + "Stack$ConfigurationManager": "The configuration manager.
", + "UpdateStackRequest$ConfigurationManager": "The configuration manager. When you update a stack, we recommend that you use the configuration manager to specify the Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is currently 11.4.
" + } + }, + "StackSummary": { + "base": "Summarizes the number of layers, instances, and apps in a stack.
", + "refs": { + "DescribeStackSummaryResult$StackSummary": "A StackSummary object that contains the results.
An array of Stack objects that describe the stacks.
The agent version.
", + "App$AppId": "The app ID.
", + "App$StackId": "The app stack ID.
", + "App$Shortname": "The app's short name.
", + "App$Name": "The app name.
", + "App$Description": "A description of the app.
", + "App$CreatedAt": "When the app was created.
", + "AppAttributes$value": null, + "AssignInstanceRequest$InstanceId": "The instance ID.
", + "AssignVolumeRequest$VolumeId": "The volume ID.
", + "AssignVolumeRequest$InstanceId": "The instance ID.
", + "AssociateElasticIpRequest$ElasticIp": "The Elastic IP address.
", + "AssociateElasticIpRequest$InstanceId": "The instance ID.
", + "AttachElasticLoadBalancerRequest$ElasticLoadBalancerName": "The Elastic Load Balancing instance's name.
", + "AttachElasticLoadBalancerRequest$LayerId": "The ID of the layer that the Elastic Load Balancing instance is to be attached to.
", + "BlockDeviceMapping$DeviceName": "The device name that is exposed to the instance, such as /dev/sdh. For the root device, you can use the explicit device name or you can set this parameter to ROOT_DEVICE and AWS OpsWorks will provide the correct device name.
Suppresses the specified device included in the AMI's block device mapping.
", + "BlockDeviceMapping$VirtualName": "The virtual device name. For more information, see BlockDeviceMapping.
", + "ChefConfiguration$BerkshelfVersion": "The Berkshelf version.
", + "CloneStackRequest$SourceStackId": "The source stack ID.
", + "CloneStackRequest$Name": "The cloned stack name.
", + "CloneStackRequest$Region": "The cloned stack AWS region, such as \"us-east-1\". For more information about AWS regions, see Regions and Endpoints.
", + "CloneStackRequest$VpcId": "The ID of the VPC that the cloned stack is to be launched into. It must be in the specified region. All instances are launched into this VPC, and you cannot change the ID later.
If your account supports EC2 Classic, the default value is no VPC.
If your account does not support EC2 Classic, the default value is the default VPC for the specified region.
If the VPC ID corresponds to a default VPC and you have specified either the DefaultAvailabilityZone or the DefaultSubnetId parameter only, AWS OpsWorks infers the value of the other parameter. If you specify neither parameter, AWS OpsWorks sets these parameters to the first valid Availability Zone for the specified region and the corresponding default VPC subnet ID, respectively.
If you specify a nondefault VPC ID, note the following:
It must belong to a VPC in your account that is in the specified region.
You must specify a value for DefaultSubnetId.
For more information on how to use AWS OpsWorks with a VPC, see Running a Stack in a VPC. For more information on default VPC and EC2 Classic, see Supported Platforms.
", + "CloneStackRequest$ServiceRoleArn": "The stack AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks to work with AWS resources on your behalf. You must set this parameter to the Amazon Resource Name (ARN) for an existing IAM role. If you create a stack by using the AWS OpsWorks console, it creates the role for you. You can obtain an existing stack's IAM ARN programmatically by calling DescribePermissions. For more information about IAM ARNs, see Using Identifiers.
You must set this parameter to a valid service role ARN or the action will fail; there is no default value. You can specify the source stack's service role ARN, if you prefer, but you must do so explicitly.
The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see Using Identifiers.
", + "CloneStackRequest$DefaultOs": "The stack's operating system, which must be set to one of the following.
A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.
A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.
CentOS 7
Red Hat Enterprise Linux 7
Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web.
A custom AMI: Custom. You specify the custom AMI you want to use when you create instances. For more information on how to use custom AMIs with OpsWorks, see Using Custom AMIs.
The default option is the parent stack's operating system. For more information on the supported operating systems, see AWS OpsWorks Operating Systems.
You can specify a different Linux operating system for the cloned stack, but you cannot change from Linux to Windows or Windows to Linux.
The stack's host name theme, with spaces are replaced by underscores. The theme is used to generate host names for the stack's instances. By default, HostnameTheme is set to Layer_Dependent, which creates host names by appending integers to the layer's short name. The other themes are:
Baked_Goods
Clouds
Europe_Cities
Fruits
Greek_Deities
Legendary_creatures_from_Japan
Planets_and_Moons
Roman_Deities
Scottish_Islands
US_Cities
Wild_Cats
To obtain a generated host name, call GetHostNameSuggestion, which returns a host name based on the current theme.
The cloned stack's default Availability Zone, which must be in the specified region. For more information, see Regions and Endpoints. If you also specify a value for DefaultSubnetId, the subnet must be in the same zone. For more information, see the VpcId parameter description.
The stack's default VPC subnet ID. This parameter is required if you specify a value for the VpcId parameter. All instances are launched into this subnet unless you specify otherwise when you create the instance. If you also specify a value for DefaultAvailabilityZone, the subnet must be in that zone. For information on default values and when this parameter is required, see the VpcId parameter description.
A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values. The string should be in the following format and must escape characters such as '\"':
\"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"
For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes
", + "CloneStackRequest$DefaultSshKeyName": "A default Amazon EC2 key pair name. The default value is none. If you specify a key pair name, AWS OpsWorks installs the public key on the instance and you can use the private key with an SSH client to log in to the instance. For more information, see Using SSH to Communicate with an Instance and Managing SSH Access. You can override this setting by specifying a different key pair, or no key pair, when you create an instance.
", + "CloneStackRequest$AgentVersion": "The default AWS OpsWorks agent version. You have the following options:
Auto-update - Set this parameter to LATEST. AWS OpsWorks automatically installs new agent versions on the stack's instances as soon as they are available.
Fixed version - Set this parameter to your preferred agent version. To update the agent version, you must edit the stack configuration and specify a new version. AWS OpsWorks then automatically installs that version on the stack's instances.
The default setting is LATEST. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions.
You can also specify an agent version when you create or update an instance, which overrides the stack's default setting.
The cloned stack ID.
", + "Command$CommandId": "The command ID.
", + "Command$InstanceId": "The ID of the instance where the command was executed.
", + "Command$DeploymentId": "The command deployment ID.
", + "Command$Status": "The command status:
failed
successful
skipped
pending
The URL of the command log.
", + "Command$Type": "The command type:
deploy
rollback
start
stop
restart
undeploy
update_dependencies
install_dependencies
update_custom_cookbooks
execute_recipes
The stack ID.
", + "CreateAppRequest$Shortname": "The app's short name.
", + "CreateAppRequest$Name": "The app name.
", + "CreateAppRequest$Description": "A description of the app.
", + "CreateAppResult$AppId": "The app ID.
", + "CreateDeploymentRequest$StackId": "The stack ID.
", + "CreateDeploymentRequest$AppId": "The app ID. This parameter is required for app deployments, but not for other deployment commands.
", + "CreateDeploymentRequest$Comment": "A user-defined comment.
", + "CreateDeploymentRequest$CustomJson": "A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values. The string should be in the following format and must escape characters such as '\"':
\"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"
For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.
", + "CreateDeploymentResult$DeploymentId": "The deployment ID, which can be used with other requests to identify the deployment.
", + "CreateInstanceRequest$StackId": "The stack ID.
", + "CreateInstanceRequest$InstanceType": "The instance type, such as t2.micro. For a list of supported instance types, open the stack in the console, choose Instances, and choose + Instance. The Size list contains the currently supported types. For more information, see Instance Families and Types. The parameter values that you use to specify the various types are in the API Name column of the Available Instance Types table.
The instance host name.
", + "CreateInstanceRequest$Os": "The instance's operating system, which must be set to one of the following.
A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.
A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.
CentOS 7
Red Hat Enterprise Linux 7
A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web.
A custom AMI: Custom.
For more information on the supported operating systems, see AWS OpsWorks Operating Systems.
The default option is the current Amazon Linux version. If you set this parameter to Custom, you must use the CreateInstance action's AmiId parameter to specify the custom AMI that you want to use. Block device mappings are not supported if the value is Custom. For more information on the supported operating systems, see Operating SystemsFor more information on how to use custom AMIs with AWS OpsWorks, see Using Custom AMIs.
A custom AMI ID to be used to create the instance. The AMI should be based on one of the supported operating systems. For more information, see Using Custom AMIs.
If you specify a custom AMI, you must set Os to Custom.
The instance's Amazon EC2 key-pair name.
", + "CreateInstanceRequest$AvailabilityZone": "The instance Availability Zone. For more information, see Regions and Endpoints.
", + "CreateInstanceRequest$VirtualizationType": "The instance's virtualization type, paravirtual or hvm.
The ID of the instance's subnet. If the stack is running in a VPC, you can use this parameter to override the stack's default subnet ID value and direct AWS OpsWorks to launch the instance in a different subnet.
", + "CreateInstanceRequest$AgentVersion": "The default AWS OpsWorks agent version. You have the following options:
INHERIT - Use the stack's default agent version setting.
version_number - Use the specified agent version. This value overrides the stack's default setting. To update the agent version, edit the instance configuration and specify a new version. AWS OpsWorks then automatically installs that version on the instance.
The default setting is INHERIT. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions.
The instance's tenancy option. The default option is no tenancy, or if the instance is running in a VPC, inherit tenancy settings from the VPC. The following are valid values for this parameter: dedicated, default, or host. Because there are costs associated with changes in tenancy options, we recommend that you research tenancy options before choosing them for your instances. For more information about dedicated hosts, see Dedicated Hosts Overview and Amazon EC2 Dedicated Hosts. For more information about dedicated instances, see Dedicated Instances and Amazon EC2 Dedicated Instances.
The instance ID.
", + "CreateLayerRequest$StackId": "The layer stack ID.
", + "CreateLayerRequest$Name": "The layer name, which is used by the console.
", + "CreateLayerRequest$Shortname": "For custom layers only, use this parameter to specify the layer's short name, which is used internally by AWS OpsWorks and by Chef recipes. The short name is also used as the name for the directory where your app files are installed. It can have a maximum of 200 characters, which are limited to the alphanumeric characters, '-', '_', and '.'.
The built-in layers' short names are defined by AWS OpsWorks. For more information, see the Layer Reference.
", + "CreateLayerRequest$CustomInstanceProfileArn": "The ARN of an IAM profile to be used for the layer's EC2 instances. For more information about IAM ARNs, see Using Identifiers.
", + "CreateLayerRequest$CustomJson": "A JSON-formatted string containing custom stack configuration and deployment attributes to be installed on the layer's instances. For more information, see Using Custom JSON. This feature is supported as of version 1.7.42 of the AWS CLI.
", + "CreateLayerResult$LayerId": "The layer ID.
", + "CreateStackRequest$Name": "The stack name.
", + "CreateStackRequest$Region": "The stack's AWS region, such as \"us-east-1\". For more information about Amazon regions, see Regions and Endpoints.
", + "CreateStackRequest$VpcId": "The ID of the VPC that the stack is to be launched into. The VPC must be in the stack's region. All instances are launched into this VPC. You cannot change the ID later.
If your account supports EC2-Classic, the default value is no VPC.
If your account does not support EC2-Classic, the default value is the default VPC for the specified region.
If the VPC ID corresponds to a default VPC and you have specified either the DefaultAvailabilityZone or the DefaultSubnetId parameter only, AWS OpsWorks infers the value of the other parameter. If you specify neither parameter, AWS OpsWorks sets these parameters to the first valid Availability Zone for the specified region and the corresponding default VPC subnet ID, respectively.
If you specify a nondefault VPC ID, note the following:
It must belong to a VPC in your account that is in the specified region.
You must specify a value for DefaultSubnetId.
For more information on how to use AWS OpsWorks with a VPC, see Running a Stack in a VPC. For more information on default VPC and EC2-Classic, see Supported Platforms.
", + "CreateStackRequest$ServiceRoleArn": "The stack's AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks to work with AWS resources on your behalf. You must set this parameter to the Amazon Resource Name (ARN) for an existing IAM role. For more information about IAM ARNs, see Using Identifiers.
", + "CreateStackRequest$DefaultInstanceProfileArn": "The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see Using Identifiers.
", + "CreateStackRequest$DefaultOs": "The stack's default operating system, which is installed on every instance unless you specify a different operating system when you create the instance. You can specify one of the following.
A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.
A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.
CentOS 7
Red Hat Enterprise Linux 7
A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web.
A custom AMI: Custom. You specify the custom AMI you want to use when you create instances. For more information, see Using Custom AMIs.
The default option is the current Amazon Linux version. For more information on the supported operating systems, see AWS OpsWorks Operating Systems.
", + "CreateStackRequest$HostnameTheme": "The stack's host name theme, with spaces replaced by underscores. The theme is used to generate host names for the stack's instances. By default, HostnameTheme is set to Layer_Dependent, which creates host names by appending integers to the layer's short name. The other themes are:
Baked_Goods
Clouds
Europe_Cities
Fruits
Greek_Deities
Legendary_creatures_from_Japan
Planets_and_Moons
Roman_Deities
Scottish_Islands
US_Cities
Wild_Cats
To obtain a generated host name, call GetHostNameSuggestion, which returns a host name based on the current theme.
The stack's default Availability Zone, which must be in the specified region. For more information, see Regions and Endpoints. If you also specify a value for DefaultSubnetId, the subnet must be in the same zone. For more information, see the VpcId parameter description.
The stack's default VPC subnet ID. This parameter is required if you specify a value for the VpcId parameter. All instances are launched into this subnet unless you specify otherwise when you create the instance. If you also specify a value for DefaultAvailabilityZone, the subnet must be in that zone. For information on default values and when this parameter is required, see the VpcId parameter description.
A string that contains user-defined, custom JSON. It can be used to override the corresponding default stack configuration attribute values or to pass data to recipes. The string should be in the following escape characters such as '\"':
\"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"
For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.
", + "CreateStackRequest$DefaultSshKeyName": "A default Amazon EC2 key pair name. The default value is none. If you specify a key pair name, AWS OpsWorks installs the public key on the instance and you can use the private key with an SSH client to log in to the instance. For more information, see Using SSH to Communicate with an Instance and Managing SSH Access. You can override this setting by specifying a different key pair, or no key pair, when you create an instance.
", + "CreateStackRequest$AgentVersion": "The default AWS OpsWorks agent version. You have the following options:
Auto-update - Set this parameter to LATEST. AWS OpsWorks automatically installs new agent versions on the stack's instances as soon as they are available.
Fixed version - Set this parameter to your preferred agent version. To update the agent version, you must edit the stack configuration and specify a new version. AWS OpsWorks then automatically installs that version on the stack's instances.
The default setting is the most recent release of the agent. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions.
You can also specify an agent version when you create or update an instance, which overrides the stack's default setting.
The stack ID, which is an opaque string that you use to identify the stack when performing actions such as DescribeStacks.
The user's IAM ARN.
", + "CreateUserProfileRequest$SshUsername": "The user's SSH user name. The allowable characters are [a-z], [A-Z], [0-9], '-', and '_'. If the specified name includes other punctuation marks, AWS OpsWorks removes them. For example, my.name will be changed to myname. If you do not specify an SSH user name, AWS OpsWorks generates one from the IAM user name.
The user's public SSH key.
", + "CreateUserProfileResult$IamUserArn": "The user's IAM ARN.
", + "DataSource$Type": "The data source's type, AutoSelectOpsworksMysqlInstance, OpsworksMysqlInstance, or RdsDbInstance.
The data source's ARN.
", + "DataSource$DatabaseName": "The database name.
", + "DeleteAppRequest$AppId": "The app ID.
", + "DeleteInstanceRequest$InstanceId": "The instance ID.
", + "DeleteLayerRequest$LayerId": "The layer ID.
", + "DeleteStackRequest$StackId": "The stack ID.
", + "DeleteUserProfileRequest$IamUserArn": "The user's IAM ARN.
", + "Deployment$DeploymentId": "The deployment ID.
", + "Deployment$StackId": "The stack ID.
", + "Deployment$AppId": "The app ID.
", + "Deployment$IamUserArn": "The user's IAM ARN.
", + "Deployment$Comment": "A user-defined comment.
", + "Deployment$Status": "The deployment status:
running
successful
failed
A string that contains user-defined custom JSON. It can be used to override the corresponding default stack configuration attribute values for stack or to pass data to recipes. The string should be in the following format and must escape characters such as '\"':
\"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"
For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.
", + "DeploymentCommandArgs$key": null, + "DeregisterEcsClusterRequest$EcsClusterArn": "The cluster's ARN.
", + "DeregisterElasticIpRequest$ElasticIp": "The Elastic IP address.
", + "DeregisterInstanceRequest$InstanceId": "The instance ID.
", + "DeregisterRdsDbInstanceRequest$RdsDbInstanceArn": "The Amazon RDS instance's ARN.
", + "DeregisterVolumeRequest$VolumeId": "The AWS OpsWorks volume ID, which is the GUID that AWS OpsWorks assigned to the instance when you registered the volume with the stack, not the Amazon EC2 volume ID.
", + "DescribeAgentVersionsRequest$StackId": "The stack ID.
", + "DescribeAppsRequest$StackId": "The app stack ID. If you use this parameter, DescribeApps returns a description of the apps in the specified stack.
The deployment ID. If you include this parameter, DescribeCommands returns a description of the commands associated with the specified deployment.
The instance ID. If you include this parameter, DescribeCommands returns a description of the commands associated with the specified instance.
The stack ID. If you include this parameter, DescribeDeployments returns a description of the commands associated with the specified stack.
The app ID. If you include this parameter, DescribeDeployments returns a description of the commands associated with the specified app.
A stack ID. DescribeEcsClusters returns a description of the cluster that is registered with the stack.
If the previous paginated request did not return all of the remaining results, the response object'sNextToken parameter value is set to a token. To retrieve the next set of results, call DescribeEcsClusters again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
If a paginated request does not return all of the remaining results, this parameter is set to a token that you can assign to the request object's NextToken parameter to retrieve the next set of results. If the previous paginated request returned all of the remaining results, this parameter is set to null.
The instance ID. If you include this parameter, DescribeElasticIps returns a description of the Elastic IP addresses associated with the specified instance.
A stack ID. If you include this parameter, DescribeElasticIps returns a description of the Elastic IP addresses that are registered with the specified stack.
A stack ID. The action describes the stack's Elastic Load Balancing instances.
", + "DescribeInstancesRequest$StackId": "A stack ID. If you use this parameter, DescribeInstances returns descriptions of the instances associated with the specified stack.
A layer ID. If you use this parameter, DescribeInstances returns descriptions of the instances associated with the specified layer.
The stack ID.
", + "DescribePermissionsRequest$IamUserArn": "The user's IAM ARN. For more information about IAM ARNs, see Using Identifiers.
", + "DescribePermissionsRequest$StackId": "The stack ID.
", + "DescribeRaidArraysRequest$InstanceId": "The instance ID. If you use this parameter, DescribeRaidArrays returns descriptions of the RAID arrays associated with the specified instance.
The stack ID.
", + "DescribeRdsDbInstancesRequest$StackId": "The stack ID that the instances are registered with. The operation returns descriptions of all registered Amazon RDS instances.
", + "DescribeServiceErrorsRequest$StackId": "The stack ID. If you use this parameter, DescribeServiceErrors returns descriptions of the errors associated with the specified stack.
The instance ID. If you use this parameter, DescribeServiceErrors returns descriptions of the errors associated with the specified instance.
The stack ID
", + "DescribeStackProvisioningParametersResult$AgentInstallerUrl": "The AWS OpsWorks agent installer's URL.
", + "DescribeStackSummaryRequest$StackId": "The stack ID.
", + "DescribeVolumesRequest$InstanceId": "The instance ID. If you use this parameter, DescribeVolumes returns descriptions of the volumes associated with the specified instance.
A stack ID. The action describes the stack's registered Amazon EBS volumes.
", + "DescribeVolumesRequest$RaidArrayId": "The RAID array ID. If you use this parameter, DescribeVolumes returns descriptions of the volumes associated with the specified RAID array.
The Elastic Load Balancing instance's name.
", + "DetachElasticLoadBalancerRequest$LayerId": "The ID of the layer that the Elastic Load Balancing instance is attached to.
", + "DisassociateElasticIpRequest$ElasticIp": "The Elastic IP address.
", + "EbsBlockDevice$SnapshotId": "The snapshot ID.
", + "EcsCluster$EcsClusterArn": "The cluster's ARN.
", + "EcsCluster$EcsClusterName": "The cluster name.
", + "EcsCluster$StackId": "The stack ID.
", + "ElasticIp$Ip": "The IP address.
", + "ElasticIp$Name": "The name.
", + "ElasticIp$Domain": "The domain.
", + "ElasticIp$Region": "The AWS region. For more information, see Regions and Endpoints.
", + "ElasticIp$InstanceId": "The ID of the instance that the address is attached to.
", + "ElasticLoadBalancer$ElasticLoadBalancerName": "The Elastic Load Balancing instance's name.
", + "ElasticLoadBalancer$Region": "The instance's AWS region.
", + "ElasticLoadBalancer$DnsName": "The instance's public DNS name.
", + "ElasticLoadBalancer$StackId": "The ID of the stack that the instance is associated with.
", + "ElasticLoadBalancer$LayerId": "The ID of the layer that the instance is attached to.
", + "ElasticLoadBalancer$VpcId": "The VPC ID.
", + "EnvironmentVariable$Key": "(Required) The environment variable's name, which can consist of up to 64 characters and must be specified. The name can contain upper- and lowercase letters, numbers, and underscores (_), but it must start with a letter or underscore.
", + "EnvironmentVariable$Value": "(Optional) The environment variable's value, which can be left empty. If you specify a value, it can contain up to 256 characters, which must all be printable.
", + "GetHostnameSuggestionRequest$LayerId": "The layer ID.
", + "GetHostnameSuggestionResult$LayerId": "The layer ID.
", + "GetHostnameSuggestionResult$Hostname": "The generated host name.
", + "GrantAccessRequest$InstanceId": "The instance's AWS OpsWorks ID.
", + "Instance$AgentVersion": "The agent version. This parameter is set to INHERIT if the instance inherits the default stack setting or to a a version number for a fixed agent version.
A custom AMI ID to be used to create the instance. For more information, see Instances
", + "Instance$AvailabilityZone": "The instance Availability Zone. For more information, see Regions and Endpoints.
", + "Instance$Ec2InstanceId": "The ID of the associated Amazon EC2 instance.
", + "Instance$EcsClusterArn": "For container instances, the Amazon ECS cluster's ARN.
", + "Instance$EcsContainerInstanceArn": "For container instances, the instance's ARN.
", + "Instance$ElasticIp": "The instance Elastic IP address .
", + "Instance$Hostname": "The instance host name.
", + "Instance$InfrastructureClass": "For registered instances, the infrastructure class: ec2 or on-premises.
The instance ID.
", + "Instance$InstanceProfileArn": "The ARN of the instance's IAM profile. For more information about IAM ARNs, see Using Identifiers.
", + "Instance$InstanceType": "The instance type, such as t2.micro.
The ID of the last service error. For more information, call DescribeServiceErrors.
", + "Instance$Os": "The instance's operating system.
", + "Instance$Platform": "The instance's platform.
", + "Instance$PrivateDns": "The The instance's private DNS name.
", + "Instance$PrivateIp": "The instance's private IP address.
", + "Instance$PublicDns": "The instance public DNS name.
", + "Instance$PublicIp": "The instance public IP address.
", + "Instance$RegisteredBy": "For registered instances, who performed the registration.
", + "Instance$ReportedAgentVersion": "The instance's reported AWS OpsWorks agent version.
", + "Instance$RootDeviceVolumeId": "The root device volume ID.
", + "Instance$SshHostDsaKeyFingerprint": "The SSH key's Deep Security Agent (DSA) fingerprint.
", + "Instance$SshHostRsaKeyFingerprint": "The SSH key's RSA fingerprint.
", + "Instance$SshKeyName": "The instance's Amazon EC2 key-pair name.
", + "Instance$StackId": "The stack ID.
", + "Instance$Status": "The instance status:
booting
connection_lost
online
pending
rebooting
requested
running_setup
setup_failed
shutting_down
start_failed
stop_failed
stopped
stopping
terminated
terminating
The instance's subnet ID; applicable only if the stack is running in a VPC.
", + "Instance$Tenancy": "The instance's tenancy option, such as dedicated or host.
A JSON document that contains the metadata.
", + "InstanceIdentity$Signature": "A signature that can be used to verify the document's accuracy and authenticity.
", + "Layer$StackId": "The layer stack ID.
", + "Layer$LayerId": "The layer ID.
", + "Layer$Name": "The layer name.
", + "Layer$Shortname": "The layer short name.
", + "Layer$CustomInstanceProfileArn": "The ARN of the default IAM profile to be used for the layer's EC2 instances. For more information about IAM ARNs, see Using Identifiers.
", + "Layer$CustomJson": "A JSON formatted string containing the layer's custom stack configuration and deployment attributes.
", + "LayerAttributes$value": null, + "LoadBasedAutoScalingConfiguration$LayerId": "The layer ID.
", + "Parameters$key": null, + "Parameters$value": null, + "Permission$StackId": "A stack ID.
", + "Permission$IamUserArn": "The Amazon Resource Name (ARN) for an AWS Identity and Access Management (IAM) role. For more information about IAM ARNs, see Using Identifiers.
", + "Permission$Level": "The user's permission level, which must be the following:
deny
show
deploy
manage
iam_only
For more information on the permissions associated with these levels, see Managing User Permissions
", + "RaidArray$RaidArrayId": "The array ID.
", + "RaidArray$InstanceId": "The instance ID.
", + "RaidArray$Name": "The array name.
", + "RaidArray$Device": "The array's Linux device. For example /dev/mdadm0.
", + "RaidArray$MountPoint": "The array's mount point.
", + "RaidArray$AvailabilityZone": "The array's Availability Zone. For more information, see Regions and Endpoints.
", + "RaidArray$StackId": "The stack ID.
", + "RaidArray$VolumeType": "The volume type, standard or PIOPS.
", + "RdsDbInstance$RdsDbInstanceArn": "The instance's ARN.
", + "RdsDbInstance$DbInstanceIdentifier": "The DB instance identifier.
", + "RdsDbInstance$DbUser": "The master user name.
", + "RdsDbInstance$DbPassword": "AWS OpsWorks returns *****FILTERED***** instead of the actual value.
The instance's AWS region.
", + "RdsDbInstance$Address": "The instance's address.
", + "RdsDbInstance$Engine": "The instance's database engine.
", + "RdsDbInstance$StackId": "The ID of the stack that the instance is registered with.
", + "RebootInstanceRequest$InstanceId": "The instance ID.
", + "RegisterEcsClusterRequest$EcsClusterArn": "The cluster's ARN.
", + "RegisterEcsClusterRequest$StackId": "The stack ID.
", + "RegisterEcsClusterResult$EcsClusterArn": "The cluster's ARN.
", + "RegisterElasticIpRequest$ElasticIp": "The Elastic IP address.
", + "RegisterElasticIpRequest$StackId": "The stack ID.
", + "RegisterElasticIpResult$ElasticIp": "The Elastic IP address.
", + "RegisterInstanceRequest$StackId": "The ID of the stack that the instance is to be registered with.
", + "RegisterInstanceRequest$Hostname": "The instance's hostname.
", + "RegisterInstanceRequest$PublicIp": "The instance's public IP address.
", + "RegisterInstanceRequest$PrivateIp": "The instance's private IP address.
", + "RegisterInstanceRequest$RsaPublicKey": "The instances public RSA key. This key is used to encrypt communication between the instance and the service.
", + "RegisterInstanceRequest$RsaPublicKeyFingerprint": "The instances public RSA key fingerprint.
", + "RegisterInstanceResult$InstanceId": "The registered instance's AWS OpsWorks ID.
", + "RegisterRdsDbInstanceRequest$StackId": "The stack ID.
", + "RegisterRdsDbInstanceRequest$RdsDbInstanceArn": "The Amazon RDS instance's ARN.
", + "RegisterRdsDbInstanceRequest$DbUser": "The database's master user name.
", + "RegisterRdsDbInstanceRequest$DbPassword": "The database password.
", + "RegisterVolumeRequest$Ec2VolumeId": "The Amazon EBS volume ID.
", + "RegisterVolumeRequest$StackId": "The stack ID.
", + "RegisterVolumeResult$VolumeId": "The volume ID.
", + "ReportedOs$Family": "The operating system family.
", + "ReportedOs$Name": "The operating system name.
", + "ReportedOs$Version": "The operating system version.
", + "ResourceNotFoundException$message": "The exception message.
", + "SelfUserProfile$IamUserArn": "The user's IAM ARN.
", + "SelfUserProfile$Name": "The user's name.
", + "SelfUserProfile$SshUsername": "The user's SSH user name.
", + "SelfUserProfile$SshPublicKey": "The user's SSH public key.
", + "ServiceError$ServiceErrorId": "The error ID.
", + "ServiceError$StackId": "The stack ID.
", + "ServiceError$InstanceId": "The instance ID.
", + "ServiceError$Type": "The error type.
", + "ServiceError$Message": "A message that describes the error.
", + "SetLoadBasedAutoScalingRequest$LayerId": "The layer ID.
", + "SetPermissionRequest$StackId": "The stack ID.
", + "SetPermissionRequest$IamUserArn": "The user's IAM ARN.
", + "SetPermissionRequest$Level": "The user's permission level, which must be set to one of the following strings. You cannot set your own permissions level.
deny
show
deploy
manage
iam_only
For more information on the permissions associated with these levels, see Managing User Permissions.
", + "SetTimeBasedAutoScalingRequest$InstanceId": "The instance ID.
", + "Source$Url": "The source URL.
", + "Source$Username": "This parameter depends on the repository type.
For Amazon S3 bundles, set Username to the appropriate IAM access key ID.
For HTTP bundles, Git repositories, and Subversion repositories, set Username to the user name.
When included in a request, the parameter depends on the repository type.
For Amazon S3 bundles, set Password to the appropriate IAM secret access key.
For HTTP bundles and Subversion repositories, set Password to the password.
For more information on how to safely handle IAM credentials, see http://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html.
In responses, AWS OpsWorks returns *****FILTERED***** instead of the actual value.
In requests, the repository's SSH key.
In responses, AWS OpsWorks returns *****FILTERED***** instead of the actual value.
The application's version. AWS OpsWorks enables you to easily deploy new versions of an application. One of the simplest approaches is to have branches or revisions in your repository that represent different versions that can potentially be deployed.
", + "SslConfiguration$Certificate": "The contents of the certificate's domain.crt file.
", + "SslConfiguration$PrivateKey": "The private key; the contents of the certificate's domain.kex file.
", + "SslConfiguration$Chain": "Optional. Can be used to specify an intermediate certificate authority key or client authentication.
", + "Stack$StackId": "The stack ID.
", + "Stack$Name": "The stack name.
", + "Stack$Arn": "The stack's ARN.
", + "Stack$Region": "The stack AWS region, such as \"us-east-1\". For more information about AWS regions, see Regions and Endpoints.
", + "Stack$VpcId": "The VPC ID; applicable only if the stack is running in a VPC.
", + "Stack$ServiceRoleArn": "The stack AWS Identity and Access Management (IAM) role.
", + "Stack$DefaultInstanceProfileArn": "The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see Using Identifiers.
", + "Stack$DefaultOs": "The stack's default operating system.
", + "Stack$HostnameTheme": "The stack host name theme, with spaces replaced by underscores.
", + "Stack$DefaultAvailabilityZone": "The stack's default Availability Zone. For more information, see Regions and Endpoints.
", + "Stack$DefaultSubnetId": "The default subnet ID; applicable only if the stack is running in a VPC.
", + "Stack$CustomJson": "A JSON object that contains user-defined attributes to be added to the stack configuration and deployment attributes. You can use custom JSON to override the corresponding default stack configuration attribute values or to pass data to recipes. The string should be in the following format and must escape characters such as '\"':
\"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"
For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.
", + "Stack$DefaultSshKeyName": "A default Amazon EC2 key pair for the stack's instances. You can override this value when you create or update an instance.
", + "Stack$AgentVersion": "The agent version. This parameter is set to LATEST for auto-update. or a version number for a fixed agent version.
The name. This parameter must be set to \"Chef\".
", + "StackConfigurationManager$Version": "The Chef version. This parameter must be set to 12, 11.10, or 11.4 for Linux stacks, and to 12.2 for Windows stacks. The default value for Linux stacks is 11.4.
", + "StackSummary$StackId": "The stack ID.
", + "StackSummary$Name": "The stack name.
", + "StackSummary$Arn": "The stack's ARN.
", + "StartInstanceRequest$InstanceId": "The instance ID.
", + "StartStackRequest$StackId": "The stack ID.
", + "StopInstanceRequest$InstanceId": "The instance ID.
", + "StopStackRequest$StackId": "The stack ID.
", + "Strings$member": null, + "TemporaryCredential$Username": "The user name.
", + "TemporaryCredential$Password": "The password.
", + "TemporaryCredential$InstanceId": "The instance's AWS OpsWorks ID.
", + "TimeBasedAutoScalingConfiguration$InstanceId": "The instance ID.
", + "UnassignInstanceRequest$InstanceId": "The instance ID.
", + "UnassignVolumeRequest$VolumeId": "The volume ID.
", + "UpdateAppRequest$AppId": "The app ID.
", + "UpdateAppRequest$Name": "The app name.
", + "UpdateAppRequest$Description": "A description of the app.
", + "UpdateElasticIpRequest$ElasticIp": "The address.
", + "UpdateElasticIpRequest$Name": "The new name.
", + "UpdateInstanceRequest$InstanceId": "The instance ID.
", + "UpdateInstanceRequest$InstanceType": "The instance type, such as t2.micro. For a list of supported instance types, open the stack in the console, choose Instances, and choose + Instance. The Size list contains the currently supported types. For more information, see Instance Families and Types. The parameter values that you use to specify the various types are in the API Name column of the Available Instance Types table.
The instance host name.
", + "UpdateInstanceRequest$Os": "The instance's operating system, which must be set to one of the following.
A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.
A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.
CentOS 7
Red Hat Enterprise Linux 7
A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web.
A custom AMI: Custom.
For more information on the supported operating systems, see AWS OpsWorks Operating Systems.
The default option is the current Amazon Linux version. If you set this parameter to Custom, you must use the AmiId parameter to specify the custom AMI that you want to use. For more information on the supported operating systems, see Operating Systems. For more information on how to use custom AMIs with OpsWorks, see Using Custom AMIs.
You can specify a different Linux operating system for the updated stack, but you cannot change from Linux to Windows or Windows to Linux.
A custom AMI ID to be used to create the instance. The AMI must be based on one of the supported operating systems. For more information, see Instances
If you specify a custom AMI, you must set Os to Custom.
The instance's Amazon EC2 key name.
", + "UpdateInstanceRequest$AgentVersion": "The default AWS OpsWorks agent version. You have the following options:
INHERIT - Use the stack's default agent version setting.
version_number - Use the specified agent version. This value overrides the stack's default setting. To update the agent version, you must edit the instance configuration and specify a new version. AWS OpsWorks then automatically installs that version on the instance.
The default setting is INHERIT. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions.
The layer ID.
", + "UpdateLayerRequest$Name": "The layer name, which is used by the console.
", + "UpdateLayerRequest$Shortname": "For custom layers only, use this parameter to specify the layer's short name, which is used internally by AWS OpsWorksand by Chef. The short name is also used as the name for the directory where your app files are installed. It can have a maximum of 200 characters and must be in the following format: /\\A[a-z0-9\\-\\_\\.]+\\Z/.
The built-in layers' short names are defined by AWS OpsWorks. For more information, see the Layer Reference
", + "UpdateLayerRequest$CustomInstanceProfileArn": "The ARN of an IAM profile to be used for all of the layer's EC2 instances. For more information about IAM ARNs, see Using Identifiers.
", + "UpdateLayerRequest$CustomJson": "A JSON-formatted string containing custom stack configuration and deployment attributes to be installed on the layer's instances. For more information, see Using Custom JSON.
", + "UpdateMyUserProfileRequest$SshPublicKey": "The user's SSH public key.
", + "UpdateRdsDbInstanceRequest$RdsDbInstanceArn": "The Amazon RDS instance's ARN.
", + "UpdateRdsDbInstanceRequest$DbUser": "The master user name.
", + "UpdateRdsDbInstanceRequest$DbPassword": "The database password.
", + "UpdateStackRequest$StackId": "The stack ID.
", + "UpdateStackRequest$Name": "The stack's new name.
", + "UpdateStackRequest$ServiceRoleArn": "Do not use this parameter. You cannot update a stack's service role.
", + "UpdateStackRequest$DefaultInstanceProfileArn": "The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see Using Identifiers.
", + "UpdateStackRequest$DefaultOs": "The stack's operating system, which must be set to one of the following:
A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.
A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.
CentOS 7
Red Hat Enterprise Linux 7
A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web.
A custom AMI: Custom. You specify the custom AMI you want to use when you create instances. For more information on how to use custom AMIs with OpsWorks, see Using Custom AMIs.
The default option is the stack's current operating system. For more information on the supported operating systems, see AWS OpsWorks Operating Systems.
", + "UpdateStackRequest$HostnameTheme": "The stack's new host name theme, with spaces replaced by underscores. The theme is used to generate host names for the stack's instances. By default, HostnameTheme is set to Layer_Dependent, which creates host names by appending integers to the layer's short name. The other themes are:
Baked_Goods
Clouds
Europe_Cities
Fruits
Greek_Deities
Legendary_creatures_from_Japan
Planets_and_Moons
Roman_Deities
Scottish_Islands
US_Cities
Wild_Cats
To obtain a generated host name, call GetHostNameSuggestion, which returns a host name based on the current theme.
The stack's default Availability Zone, which must be in the stack's region. For more information, see Regions and Endpoints. If you also specify a value for DefaultSubnetId, the subnet must be in the same zone. For more information, see CreateStack.
The stack's default VPC subnet ID. This parameter is required if you specify a value for the VpcId parameter. All instances are launched into this subnet unless you specify otherwise when you create the instance. If you also specify a value for DefaultAvailabilityZone, the subnet must be in that zone. For information on default values and when this parameter is required, see the VpcId parameter description.
A string that contains user-defined, custom JSON. It can be used to override the corresponding default stack configuration JSON values or to pass data to recipes. The string should be in the following format and escape characters such as '\"':
\"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"
For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.
", + "UpdateStackRequest$DefaultSshKeyName": "A default Amazon EC2 key-pair name. The default value is none. If you specify a key-pair name, AWS OpsWorks installs the public key on the instance and you can use the private key with an SSH client to log in to the instance. For more information, see Using SSH to Communicate with an Instance and Managing SSH Access. You can override this setting by specifying a different key pair, or no key pair, when you create an instance.
The default AWS OpsWorks agent version. You have the following options:
Auto-update - Set this parameter to LATEST. AWS OpsWorks automatically installs new agent versions on the stack's instances as soon as they are available.
Fixed version - Set this parameter to your preferred agent version. To update the agent version, you must edit the stack configuration and specify a new version. AWS OpsWorks then automatically installs that version on the stack's instances.
The default setting is LATEST. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions.
You can also specify an agent version when you create or update an instance, which overrides the stack's default setting.
The user IAM ARN.
", + "UpdateUserProfileRequest$SshUsername": "The user's SSH user name. The allowable characters are [a-z], [A-Z], [0-9], '-', and '_'. If the specified name includes other punctuation marks, AWS OpsWorks removes them. For example, my.name will be changed to myname. If you do not specify an SSH user name, AWS OpsWorks generates one from the IAM user name.
The user's new SSH public key.
", + "UpdateVolumeRequest$VolumeId": "The volume ID.
", + "UpdateVolumeRequest$Name": "The new name.
", + "UpdateVolumeRequest$MountPoint": "The new mount point.
", + "UserProfile$IamUserArn": "The user's IAM ARN.
", + "UserProfile$Name": "The user's name.
", + "UserProfile$SshUsername": "The user's SSH user name.
", + "UserProfile$SshPublicKey": "The user's SSH public key.
", + "ValidationException$message": "The exception message.
", + "Volume$VolumeId": "The volume ID.
", + "Volume$Ec2VolumeId": "The Amazon EC2 volume ID.
", + "Volume$Name": "The volume name.
", + "Volume$RaidArrayId": "The RAID array ID.
", + "Volume$InstanceId": "The instance ID.
", + "Volume$Status": "The value returned by DescribeVolumes.
", + "Volume$Device": "The device name.
", + "Volume$MountPoint": "The volume mount point. For example, \"/mnt/disk1\".
", + "Volume$Region": "The AWS region. For more information about AWS regions, see Regions and Endpoints.
", + "Volume$AvailabilityZone": "The volume Availability Zone. For more information, see Regions and Endpoints.
", + "Volume$VolumeType": "The volume type, standard or PIOPS.
", + "VolumeConfiguration$MountPoint": "The volume mount point. For example \"/dev/sdh\".
", + "VolumeConfiguration$VolumeType": "The volume type:
standard - Magnetic
io1 - Provisioned IOPS (SSD)
gp2 - General Purpose (SSD)
The app vhost settings with multiple domains separated by commas. For example: 'www.example.com, example.com'
The layer ID, which must correspond to a custom layer. You cannot assign a registered instance to a built-in layer.
", + "AutoScalingThresholds$Alarms": "Custom Cloudwatch auto scaling alarms, to be used as thresholds. This parameter takes a list of up to five alarm names, which are case sensitive and must be in the same region as the stack.
To use custom alarms, you must update your service role to allow cloudwatch:DescribeAlarms. You can either have AWS OpsWorks update the role for you when you first use this feature or you can edit the role manually. For more information, see Allowing AWS OpsWorks to Act on Your Behalf.
A list of source stack app IDs to be included in the cloned stack.
", + "CreateAppRequest$Domains": "The app virtual host settings, with multiple domains separated by commas. For example: 'www.example.com, example.com'
The instance IDs for the deployment targets.
", + "CreateDeploymentRequest$LayerIds": "The layer IDs for the deployment targets.
", + "CreateInstanceRequest$LayerIds": "An array that contains the instance's layer IDs.
", + "CreateLayerRequest$CustomSecurityGroupIds": "An array containing the layer custom security group IDs.
", + "CreateLayerRequest$Packages": "An array of Package objects that describes the layer packages.
The IDs of the target instances.
", + "DeploymentCommandArgs$value": null, + "DescribeAppsRequest$AppIds": "An array of app IDs for the apps to be described. If you use this parameter, DescribeApps returns a description of the specified apps. Otherwise, it returns a description of every app.
An array of command IDs. If you include this parameter, DescribeCommands returns a description of the specified commands. Otherwise, it returns a description of every command.
An array of deployment IDs to be described. If you include this parameter, DescribeDeployments returns a description of the specified deployments. Otherwise, it returns a description of every deployment.
A list of ARNs, one for each cluster to be described.
", + "DescribeElasticIpsRequest$Ips": "An array of Elastic IP addresses to be described. If you include this parameter, DescribeElasticIps returns a description of the specified Elastic IP addresses. Otherwise, it returns a description of every Elastic IP address.
A list of layer IDs. The action describes the Elastic Load Balancing instances for the specified layers.
", + "DescribeInstancesRequest$InstanceIds": "An array of instance IDs to be described. If you use this parameter, DescribeInstances returns a description of the specified instances. Otherwise, it returns a description of every instance.
An array of layer IDs that specify the layers to be described. If you omit this parameter, DescribeLayers returns a description of every layer in the specified stack.
An array of layer IDs.
", + "DescribeRaidArraysRequest$RaidArrayIds": "An array of RAID array IDs. If you use this parameter, DescribeRaidArrays returns descriptions of the specified arrays. Otherwise, it returns a description of every array.
An array containing the ARNs of the instances to be described.
", + "DescribeServiceErrorsRequest$ServiceErrorIds": "An array of service error IDs. If you use this parameter, DescribeServiceErrors returns descriptions of the specified errors. Otherwise, it returns a description of every error.
An array of stack IDs that specify the stacks to be described. If you omit this parameter, DescribeStacks returns a description of every stack.
An array of instance IDs.
", + "DescribeUserProfilesRequest$IamUserArns": "An array of IAM user ARNs that identify the users to be described.
", + "DescribeVolumesRequest$VolumeIds": "Am array of volume IDs. If you use this parameter, DescribeVolumes returns descriptions of the specified volumes. Otherwise, it returns a description of every volume.
A list of Availability Zones.
", + "ElasticLoadBalancer$SubnetIds": "A list of subnet IDs, if the stack is running in a VPC.
", + "ElasticLoadBalancer$Ec2InstanceIds": "A list of the EC2 instances that the Elastic Load Balancing instance is managing traffic for.
", + "Instance$LayerIds": "An array containing the instance layer IDs.
", + "Instance$SecurityGroupIds": "An array containing the instance security group IDs.
", + "Layer$CustomSecurityGroupIds": "An array containing the layer's custom security group IDs.
", + "Layer$DefaultSecurityGroupNames": "An array containing the layer's security group names.
", + "Layer$Packages": "An array of Package objects that describe the layer's packages.
An array of custom recipe names to be run following a setup event.
An array of custom recipe names to be run following a configure event.
An array of custom recipe names to be run following a deploy event.
An array of custom recipe names to be run following a undeploy event.
An array of custom recipe names to be run following a shutdown event.
The app's virtual host settings, with multiple domains separated by commas. For example: 'www.example.com, example.com'
The instance's layer IDs.
", + "UpdateLayerRequest$CustomSecurityGroupIds": "An array containing the layer's custom security group IDs.
", + "UpdateLayerRequest$Packages": "An array of Package objects that describe the layer's packages.
Contains the data needed by RDP clients such as the Microsoft Remote Desktop Connection to log in to the instance.
", + "refs": { + "GrantAccessResult$TemporaryCredential": "A TemporaryCredential object that contains the data needed to log in to the instance by RDP clients, such as the Microsoft Remote Desktop Connection.
Describes an instance's time-based auto scaling configuration.
", + "refs": { + "TimeBasedAutoScalingConfigurations$member": null + } + }, + "TimeBasedAutoScalingConfigurations": { + "base": null, + "refs": { + "DescribeTimeBasedAutoScalingResult$TimeBasedAutoScalingConfigurations": "An array of TimeBasedAutoScalingConfiguration objects that describe the configuration for the specified instances.
Describes a user's SSH information.
", + "refs": { + "UserProfiles$member": null + } + }, + "UserProfiles": { + "base": null, + "refs": { + "DescribeUserProfilesResult$UserProfiles": "A Users object that describes the specified users.
The length of time (in minutes) that the grant is valid. When the grant expires at the end of this period, the user will no longer be able to use the credentials to log in. If the user is logged in at the time, he or she automatically will be logged out.
" + } + }, + "ValidationException": { + "base": "Indicates that a request was not valid.
", + "refs": { + } + }, + "VirtualizationType": { + "base": null, + "refs": { + "Instance$VirtualizationType": "The instance's virtualization type: paravirtual or hvm.
Describes an instance's Amazon EBS volume.
", + "refs": { + "Volumes$member": null + } + }, + "VolumeConfiguration": { + "base": "Describes an Amazon EBS volume configuration.
", + "refs": { + "VolumeConfigurations$member": null + } + }, + "VolumeConfigurations": { + "base": null, + "refs": { + "CreateLayerRequest$VolumeConfigurations": "A VolumeConfigurations object that describes the layer's Amazon EBS volumes.
A VolumeConfigurations object that describes the layer's Amazon EBS volumes.
A VolumeConfigurations object that describes the layer's Amazon EBS volumes.
The volume type. gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, and standard for Magnetic volumes.
An array of volume IDs.
" + } + }, + "WeeklyAutoScalingSchedule": { + "base": "Describes a time-based instance's auto scaling schedule. The schedule consists of a set of key-value pairs.
The key is the time period (a UTC hour) and must be an integer from 0 - 23.
The value indicates whether the instance should be online or offline for the specified period, and must be set to \"on\" or \"off\"
The default setting for all time periods is off, so you use the following parameters primarily to specify the online periods. You don't have to explicitly specify offline periods unless you want to change an online period to an offline period.
The following example specifies that the instance should be online for four hours, from UTC 1200 - 1600. It will be off for the remainder of the day.
{ \"12\":\"on\", \"13\":\"on\", \"14\":\"on\", \"15\":\"on\" }
An AutoScalingSchedule with the instance schedule.
A WeeklyAutoScalingSchedule object with the instance schedule.
Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and scale a relational database in the cloud. It provides cost-efficient, resizable capacity for an industry-standard relational database and manages common database administration tasks, freeing up developers to focus on what makes their applications and businesses unique.
Amazon RDS gives you access to the capabilities of a familiar MySQL or Oracle database server. This means the code, applications, and tools you already use today with your existing MySQL or Oracle databases work with Amazon RDS without modification. Amazon RDS automatically backs up your database and maintains the database software that powers your DB Instance. Amazon RDS is flexible: you can scale your database instance's compute resources and storage capacity to meet your application's demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for the resources you use.
This is the Amazon RDS API Reference. It contains a comprehensive description of all Amazon RDS Query APIs and data types. Note that this API is asynchronous and some actions may require polling to determine when an action has been applied. See the parameter description to determine if a change is applied immediately or on the next instance reboot or during the maintenance window. To get started with Amazon RDS, go to the Amazon RDS Getting Started Guide. For more information on Amazon RDS concepts and usage scenarios, go to the Amazon RDS User Guide.
", + "operations": { + "AddSourceIdentifierToSubscription": "Adds a source identifier to an existing RDS event notification subscription.
", + "AddTagsToResource": "Adds metadata tags to a DB Instance. These tags can also be used with cost allocation reporting to track cost associated with a DB Instance.
For an overview on tagging DB Instances, see DB Instance Tags.
", + "AuthorizeDBSecurityGroupIngress": "Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC Security Groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC instances. Second, IP ranges are available if the application accessing your database is running on the Internet. Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).
For an overview of CIDR ranges, go to the Wikipedia Tutorial.
", + "CopyDBSnapshot": "Copies the specified DBSnapshot. The source DBSnapshot must be in the \"available\" state.
", + "CreateDBInstance": "Creates a new DB instance.
", + "CreateDBInstanceReadReplica": "Creates a DB Instance that acts as a Read Replica of a source DB Instance.
All Read Replica DB Instances are created as Single-AZ deployments with backups disabled. All other DB Instance attributes (including DB Security Groups and DB Parameter Groups) are inherited from the source DB Instance, except as specified below.
The source DB Instance must have backup retention enabled.
Creates a new DB Parameter Group.
A DB Parameter Group is initially created with the default parameters for the database engine used by the DB Instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup. Once you've created a DB Parameter Group, you need to associate it with your DB Instance using ModifyDBInstance. When you associate a new DB Parameter Group with a running DB Instance, you need to reboot the DB Instance for the new DB Parameter Group and associated settings to take effect.
", + "CreateDBSecurityGroup": "Creates a new DB Security Group. DB Security Groups control access to a DB Instance.
", + "CreateDBSnapshot": "Creates a DBSnapshot. The source DBInstance must be in \"available\" state.
", + "CreateDBSubnetGroup": "Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the region.
", + "CreateEventSubscription": "Creates an RDS event notification subscription. This action requires a topic ARN (Amazon Resource Name) created by either the RDS console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.
You can specify the type of source (SourceType) you want to be notified of, provide a list of RDS sources (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.
If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIdentifier = myDBInstance1, you will be notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you will receive notice of the events for that source type for all your RDS sources. If you do not specify either the SourceType nor the SourceIdentifier, you will be notified of events generated from all RDS sources belonging to your customer account.
", + "CreateOptionGroup": "Creates a new Option Group.
", + "DeleteDBInstance": "The DeleteDBInstance API deletes a previously provisioned RDS instance. A successful response from the web service indicates the request was received correctly. If a final DBSnapshot is requested the status of the RDS instance will be \"deleting\" until the DBSnapshot is created. DescribeDBInstance is used to monitor the status of this operation. This cannot be canceled or reverted once submitted.
", + "DeleteDBParameterGroup": "Deletes a specified DBParameterGroup. The DBParameterGroup cannot be associated with any RDS instances to be deleted.
Deletes a DB Security Group.
Deletes a DBSnapshot.
available state to be deleted.Deletes a DB subnet group.
Deletes an RDS event notification subscription.
", + "DeleteOptionGroup": "Deletes an existing Option Group.
", + "DescribeDBEngineVersions": "Returns a list of the available DB engines.
", + "DescribeDBInstances": "Returns information about provisioned RDS instances. This API supports pagination.
", + "DescribeDBParameterGroups": "Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DBParameterGroup.
", + "DescribeDBParameters": "Returns the detailed parameter list for a particular DBParameterGroup.
", + "DescribeDBSecurityGroups": "Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified, the list will contain only the descriptions of the specified DBSecurityGroup.
For an overview of CIDR ranges, go to the Wikipedia Tutorial.
", + "DescribeDBSnapshots": "Returns information about DBSnapshots. This API supports pagination.
", + "DescribeDBSubnetGroups": "Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.
For an overview of CIDR ranges, go to the Wikipedia Tutorial.
", + "DescribeEngineDefaultParameters": "Returns the default engine and system parameter information for the specified database engine.
", + "DescribeEventCategories": "Displays a list of categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in the Events topic in the Amazon RDS User Guide.
", + "DescribeEventSubscriptions": "Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.
If you specify a SubscriptionName, lists the description for that subscription.
", + "DescribeEvents": "Returns events related to DB instances, DB security groups, DB Snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB Iinstance, DB security group, DB Snapshot, or DB parameter group can be obtained by providing the source identifier as a parameter. By default, the past hour of events are returned.
You can see a list of event categories and source types in the Events topic in the Amazon RDS User Guide.
", + "DescribeOptionGroupOptions": "Describes all available options.
", + "DescribeOptionGroups": "Describes the available option groups.
", + "DescribeOrderableDBInstanceOptions": "Returns a list of orderable DB Instance options for the specified engine.
", + "DescribeReservedDBInstances": "Returns information about reserved DB Instances for this account, or about a specified reserved DB Instance.
", + "DescribeReservedDBInstancesOfferings": "Lists available reserved DB Instance offerings.
", + "ListTagsForResource": "Lists all tags on a DB Instance.
For an overview on tagging DB Instances, see DB Instance Tags.
", + "ModifyDBInstance": "Modify settings for a DB Instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.
", + "ModifyDBParameterGroup": "Modifies the parameters of a DBParameterGroup. To modify more than one parameter submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.
The apply-immediate method can be used only for dynamic parameters; the pending-reboot method can be used with MySQL and Oracle DB Instances for either dynamic or static parameters. For Microsoft SQL Server DB Instances, the pending-reboot method can be used only for static parameters.
Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the region.
", + "ModifyEventSubscription": "Modifies an existing RDS event notification subscription. Note that you cannot modify the source identifiers using this call; to change source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.
You can see a list of the event categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.
", + "ModifyOptionGroup": "Modifies an existing Option Group.
", + "PromoteReadReplica": "Promotes a Read Replica DB Instance to a standalone DB Instance.
", + "PurchaseReservedDBInstancesOffering": "Purchases a reserved DB Instance offering.
", + "RebootDBInstance": "Reboots a previously provisioned RDS instance. This API results in the application of modified DBParameterGroup parameters with ApplyStatus of pending-reboot to the RDS instance. This action is taken as soon as possible, and results in a momentary outage to the RDS instance during which the RDS instance status is set to rebooting. If the RDS instance is configured for MultiAZ, it is possible that the reboot will be conducted through a failover. A DBInstance event is created when the reboot is completed.
", + "RemoveSourceIdentifierFromSubscription": "Removes a source identifier from an existing RDS event notification subscription.
", + "RemoveTagsFromResource": "Removes metadata tags from a DB Instance.
For an overview on tagging DB Instances, see DB Instance Tags.
", + "ResetDBParameterGroup": "Modifies the parameters of a DBParameterGroup to the engine/system default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DBParameterGroup specify the DBParameterGroup name and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request.
", + "RestoreDBInstanceFromDBSnapshot": "Creates a new DB Instance from a DB snapshot. The target database is created from the source database restore point with the same configuration as the original source database, except that the new RDS instance is created with the default security group.
", + "RestoreDBInstanceToPointInTime": "Restores a DB Instance to an arbitrary point-in-time. Users can restore to any point in time before the latestRestorableTime for up to backupRetentionPeriod days. The target database is created from the source database with the same configuration as the original database except that the DB instance is created with the default DB security group.
", + "RevokeDBSecurityGroupIngress": "Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC Security Groups. Required parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId).
" + }, + "shapes": { + "AddSourceIdentifierToSubscriptionMessage": { + "base": "", + "refs": { + } + }, + "AddSourceIdentifierToSubscriptionResult": { + "base": null, + "refs": { + } + }, + "AddTagsToResourceMessage": { + "base": "", + "refs": { + } + }, + "ApplyMethod": { + "base": null, + "refs": { + "Parameter$ApplyMethod": "Indicates when to apply parameter updates.
" + } + }, + "AuthorizationAlreadyExistsFault": { + "base": "The specified CIDRIP or EC2 security group is already authorized for the specified DB security group.
", + "refs": { + } + }, + "AuthorizationNotFoundFault": { + "base": "Specified CIDRIP or EC2 security group is not authorized for the specified DB security group.
RDS may not also be authorized via IAM to perform necessary actions on your behalf.
", + "refs": { + } + }, + "AuthorizationQuotaExceededFault": { + "base": "DB security group authorization quota has been reached.
", + "refs": { + } + }, + "AuthorizeDBSecurityGroupIngressMessage": { + "base": "", + "refs": { + } + }, + "AuthorizeDBSecurityGroupIngressResult": { + "base": null, + "refs": { + } + }, + "AvailabilityZone": { + "base": "
Contains Availability Zone information.
This data type is used as an element in the following data type:
", + "refs": { + "AvailabilityZoneList$member": null, + "Subnet$SubnetAvailabilityZone": null + } + }, + "AvailabilityZoneList": { + "base": null, + "refs": { + "OrderableDBInstanceOption$AvailabilityZones": "A list of availability zones for the orderable DB Instance.
" + } + }, + "Boolean": { + "base": null, + "refs": { + "AvailabilityZone$ProvisionedIopsCapable": "True indicates the availability zone is capable of provisioned IOPs.
", + "DBInstance$MultiAZ": "Specifies if the DB Instance is a Multi-AZ deployment.
", + "DBInstance$AutoMinorVersionUpgrade": "Indicates that minor version patches are applied automatically.
", + "DBInstance$PubliclyAccessible": null, + "DeleteDBInstanceMessage$SkipFinalSnapshot": " Determines whether a final DB Snapshot is created before the DB Instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB Snapshot is created before the DB Instance is deleted.
false.Default: false
Indicates that only the default version of the specified engine or engine and major version combination is returned.
", + "EventSubscription$Enabled": "A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.
", + "ModifyDBInstanceMessage$ApplyImmediately": " Specifies whether or not the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB Instance.
If this parameter is passed as false, changes to the DB Instance are applied on the next call to RebootDBInstance, the next maintenance reboot, or the next failure reboot, whichever occurs first. See each parameter to determine when a change is applied.
Default: false
Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.
Constraints: This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB Instance's current version.
", + "ModifyOptionGroupMessage$ApplyImmediately": "Indicates whether the changes should be applied immediately, or during the next maintenance window for each instance associated with the Option Group.
", + "OptionGroup$AllowsVpcAndNonVpcInstanceMemberships": "Indicates whether this option group can be applied to both VPC and non-VPC instances. The value 'true' indicates the option group can be applied to both VPC and non-VPC instances.
", + "OptionGroupOption$PortRequired": "Specifies whether the option requires a port.
", + "OrderableDBInstanceOption$MultiAZCapable": "Indicates whether this orderable DB Instance is multi-AZ capable.
", + "OrderableDBInstanceOption$ReadReplicaCapable": "Indicates whether this orderable DB Instance can have a read replica.
", + "OrderableDBInstanceOption$Vpc": "Indicates whether this is a VPC orderable DB Instance.
", + "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.
Indicates if the reservation applies to Multi-AZ deployments.
", + "ReservedDBInstancesOffering$MultiAZ": "Indicates if the offering applies to Multi-AZ deployments.
", + "ResetDBParameterGroupMessage$ResetAllParameters": " Specifies whether (true) or not (false) to reset all parameters in the DB Parameter Group to default values.
Default: true
Specifies whether (true) or not (false) the DB Instance is restored from the latest backup time.
Default: false
Constraints: Cannot be specified if RestoreTime parameter is provided.
" + } + }, + "BooleanOptional": { + "base": null, + "refs": { + "CreateDBInstanceMessage$MultiAZ": "Specifies if the DB Instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the MultiAZ parameter is set to true.
", + "CreateDBInstanceMessage$AutoMinorVersionUpgrade": "Indicates that minor engine upgrades will be applied automatically to the DB Instance during the maintenance window.
Default: true
Indicates that minor engine upgrades will be applied automatically to the Read Replica during the maintenance window.
Default: Inherits from the source DB Instance
", + "CreateDBInstanceReadReplicaMessage$PubliclyAccessible": null, + "CreateEventSubscriptionMessage$Enabled": "A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.
", + "DescribeDBEngineVersionsMessage$ListSupportedCharacterSets": "If this parameter is specified, and if the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.
", + "DescribeOrderableDBInstanceOptionsMessage$Vpc": "The VPC filter value. Specify this parameter to show only the available VPC or non-VPC offerings.
", + "DescribeReservedDBInstancesMessage$MultiAZ": "The Multi-AZ filter value. Specify this parameter to show only those reservations matching the specified Multi-AZ parameter.
", + "DescribeReservedDBInstancesOfferingsMessage$MultiAZ": "The Multi-AZ filter value. Specify this parameter to show only the available offerings matching the specified Multi-AZ parameter.
", + "ModifyDBInstanceMessage$MultiAZ": " Specifies if the DB Instance is a Multi-AZ deployment. Changing this parameter does not result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.
Constraints: Cannot be specified if the DB Instance is a read replica.
", + "ModifyDBInstanceMessage$AutoMinorVersionUpgrade": " Indicates that minor version upgrades will be applied automatically to the DB Instance during the maintenance window. Changing this parameter does not result in an outage except in the following case and the change is asynchronously applied as soon as possible. An outage will result if this parameter is set to true during the maintenance window, and a newer minor version is available, and RDS has enabled auto patching for that engine version.
A Boolean value; set to true to activate the subscription.
", + "PendingModifiedValues$MultiAZ": "Indicates that the Single-AZ DB Instance is to change to a Multi-AZ deployment.
", + "RebootDBInstanceMessage$ForceFailover": " When true, the reboot will be conducted through a MultiAZ failover.
Constraint: You cannot specify true if the instance is not configured for MultiAZ.
Specifies if the DB Instance is a Multi-AZ deployment.
Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.
Indicates that minor version upgrades will be applied automatically to the DB Instance during the maintenance window.
", + "RestoreDBInstanceToPointInTimeMessage$MultiAZ": "Specifies if the DB Instance is a Multi-AZ deployment.
Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.
Indicates that minor version upgrades will be applied automatically to the DB Instance during the maintenance window.
" + } + }, + "CharacterSet": { + "base": "This data type is used as a response element in the action DescribeDBEngineVersions.
", + "refs": { + "DBEngineVersion$DefaultCharacterSet": " The default character set for new instances of this engine version, if the CharacterSetName parameter of the CreateDBInstance API is not specified.
", + "refs": { + } + }, + "CopyDBSnapshotResult": { + "base": null, + "refs": { + } + }, + "CreateDBInstanceMessage": { + "base": "
", + "refs": { + } + }, + "CreateDBInstanceReadReplicaMessage": { + "base": null, + "refs": { + } + }, + "CreateDBInstanceReadReplicaResult": { + "base": null, + "refs": { + } + }, + "CreateDBInstanceResult": { + "base": null, + "refs": { + } + }, + "CreateDBParameterGroupMessage": { + "base": "
", + "refs": { + } + }, + "CreateDBParameterGroupResult": { + "base": null, + "refs": { + } + }, + "CreateDBSecurityGroupMessage": { + "base": "
", + "refs": { + } + }, + "CreateDBSecurityGroupResult": { + "base": null, + "refs": { + } + }, + "CreateDBSnapshotMessage": { + "base": "
", + "refs": { + } + }, + "CreateDBSnapshotResult": { + "base": null, + "refs": { + } + }, + "CreateDBSubnetGroupMessage": { + "base": "
", + "refs": { + } + }, + "CreateDBSubnetGroupResult": { + "base": null, + "refs": { + } + }, + "CreateEventSubscriptionMessage": { + "base": "", + "refs": { + } + }, + "CreateEventSubscriptionResult": { + "base": null, + "refs": { + } + }, + "CreateOptionGroupMessage": { + "base": "", + "refs": { + } + }, + "CreateOptionGroupResult": { + "base": null, + "refs": { + } + }, + "DBEngineVersion": { + "base": "
This data type is used as a response element in the action DescribeDBEngineVersions.
", + "refs": { + "DBEngineVersionList$member": null + } + }, + "DBEngineVersionList": { + "base": null, + "refs": { + "DBEngineVersionMessage$DBEngineVersions": " A list of DBEngineVersion elements.
Contains the result of a successful invocation of the DescribeDBEngineVersions action.
", + "refs": { + } + }, + "DBInstance": { + "base": "Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBInstances action.
", + "refs": { + "CreateDBInstanceReadReplicaResult$DBInstance": null, + "CreateDBInstanceResult$DBInstance": null, + "DBInstanceList$member": null, + "DeleteDBInstanceResult$DBInstance": null, + "ModifyDBInstanceResult$DBInstance": null, + "PromoteReadReplicaResult$DBInstance": null, + "RebootDBInstanceResult$DBInstance": null, + "RestoreDBInstanceFromDBSnapshotResult$DBInstance": null, + "RestoreDBInstanceToPointInTimeResult$DBInstance": null + } + }, + "DBInstanceAlreadyExistsFault": { + "base": "User already has a DB instance with the given identifier.
", + "refs": { + } + }, + "DBInstanceList": { + "base": null, + "refs": { + "DBInstanceMessage$DBInstances": "A list of DBInstance instances.
" + } + }, + "DBInstanceMessage": { + "base": "Contains the result of a successful invocation of the DescribeDBInstances action.
", + "refs": { + } + }, + "DBInstanceNotFoundFault": { + "base": "DBInstanceIdentifier does not refer to an existing DB instance.
", + "refs": { + } + }, + "DBParameterGroup": { + "base": "Contains the result of a successful invocation of the CreateDBParameterGroup action.
This data type is used as a request parameter in the DeleteDBParameterGroup action, and as a response element in the DescribeDBParameterGroups action.
", + "refs": { + "CreateDBParameterGroupResult$DBParameterGroup": null, + "DBParameterGroupList$member": null + } + }, + "DBParameterGroupAlreadyExistsFault": { + "base": "A DB parameter group with the same name exists.
", + "refs": { + } + }, + "DBParameterGroupDetails": { + "base": "Contains the result of a successful invocation of the DescribeDBParameters action.
", + "refs": { + } + }, + "DBParameterGroupList": { + "base": null, + "refs": { + "DBParameterGroupsMessage$DBParameterGroups": "A list of DBParameterGroup instances.
" + } + }, + "DBParameterGroupNameMessage": { + "base": "Contains the result of a successful invocation of the ModifyDBParameterGroup or ResetDBParameterGroup action.
", + "refs": { + } + }, + "DBParameterGroupNotFoundFault": { + "base": "DBParameterGroupName does not refer to an existing DB parameter group.
", + "refs": { + } + }, + "DBParameterGroupQuotaExceededFault": { + "base": "Request would result in user exceeding the allowed number of DB parameter groups.
", + "refs": { + } + }, + "DBParameterGroupStatus": { + "base": "The status of the DB Parameter Group.
This data type is used as a response element in the following actions:
Provides the list of DB Parameter Groups applied to this DB Instance.
" + } + }, + "DBParameterGroupsMessage": { + "base": "Contains the result of a successful invocation of the DescribeDBParameterGroups action.
", + "refs": { + } + }, + "DBSecurityGroup": { + "base": "Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBSecurityGroups action.
", + "refs": { + "AuthorizeDBSecurityGroupIngressResult$DBSecurityGroup": null, + "CreateDBSecurityGroupResult$DBSecurityGroup": null, + "DBSecurityGroups$member": null, + "RevokeDBSecurityGroupIngressResult$DBSecurityGroup": null + } + }, + "DBSecurityGroupAlreadyExistsFault": { + "base": "A DB security group with the name specified in DBSecurityGroupName already exists.
", + "refs": { + } + }, + "DBSecurityGroupMembership": { + "base": "This data type is used as a response element in the following actions:
", + "refs": { + "DBSecurityGroupMembershipList$member": null + } + }, + "DBSecurityGroupMembershipList": { + "base": null, + "refs": { + "DBInstance$DBSecurityGroups": " Provides List of DB Security Group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.
If the Option requires access to a port, then this DB Security Group allows access to the port.
" + } + }, + "DBSecurityGroupMessage": { + "base": "Contains the result of a successful invocation of the DescribeDBSecurityGroups action.
", + "refs": { + } + }, + "DBSecurityGroupNameList": { + "base": null, + "refs": { + "CreateDBInstanceMessage$DBSecurityGroups": "A list of DB Security Groups to associate with this DB Instance.
Default: The default DB Security Group for the database engine.
", + "ModifyDBInstanceMessage$DBSecurityGroups": "A list of DB Security Groups to authorize on this DB Instance. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.
Constraints:
A list of DBSecurityGroupMemebrship name strings used for this option.
" + } + }, + "DBSecurityGroupNotFoundFault": { + "base": "DBSecurityGroupName does not refer to an existing DB security group.
", + "refs": { + } + }, + "DBSecurityGroupNotSupportedFault": { + "base": "A DB security group is not allowed for this action.
", + "refs": { + } + }, + "DBSecurityGroupQuotaExceededFault": { + "base": "Request would result in user exceeding the allowed number of DB security groups.
", + "refs": { + } + }, + "DBSecurityGroups": { + "base": null, + "refs": { + "DBSecurityGroupMessage$DBSecurityGroups": "A list of DBSecurityGroup instances.
" + } + }, + "DBSnapshot": { + "base": "Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBSnapshots action.
", + "refs": { + "CopyDBSnapshotResult$DBSnapshot": null, + "CreateDBSnapshotResult$DBSnapshot": null, + "DBSnapshotList$member": null, + "DeleteDBSnapshotResult$DBSnapshot": null + } + }, + "DBSnapshotAlreadyExistsFault": { + "base": "DBSnapshotIdentifier is already used by an existing snapshot.
", + "refs": { + } + }, + "DBSnapshotList": { + "base": null, + "refs": { + "DBSnapshotMessage$DBSnapshots": "A list of DBSnapshot instances.
" + } + }, + "DBSnapshotMessage": { + "base": "Contains the result of a successful invocation of the DescribeDBSnapshots action.
", + "refs": { + } + }, + "DBSnapshotNotFoundFault": { + "base": "DBSnapshotIdentifier does not refer to an existing DB snapshot.
", + "refs": { + } + }, + "DBSubnetGroup": { + "base": "Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBSubnetGroups action.
", + "refs": { + "CreateDBSubnetGroupResult$DBSubnetGroup": null, + "DBInstance$DBSubnetGroup": "Provides the inforamtion of the subnet group associated with the DB instance, including the name, descrption and subnets in the subnet group.
", + "DBSubnetGroups$member": null, + "ModifyDBSubnetGroupResult$DBSubnetGroup": null + } + }, + "DBSubnetGroupAlreadyExistsFault": { + "base": "DBSubnetGroupName is already used by an existing DB subnet group.
", + "refs": { + } + }, + "DBSubnetGroupDoesNotCoverEnoughAZs": { + "base": "Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
", + "refs": { + } + }, + "DBSubnetGroupMessage": { + "base": "Contains the result of a successful invocation of the DescribeDBSubnetGroups action.
", + "refs": { + } + }, + "DBSubnetGroupNotFoundFault": { + "base": "DBSubnetGroupName does not refer to an existing DB subnet group.
", + "refs": { + } + }, + "DBSubnetGroupQuotaExceededFault": { + "base": "Request would result in user exceeding the allowed number of DB subnet groups.
", + "refs": { + } + }, + "DBSubnetGroups": { + "base": null, + "refs": { + "DBSubnetGroupMessage$DBSubnetGroups": "A list of DBSubnetGroup instances.
" + } + }, + "DBSubnetQuotaExceededFault": { + "base": "Request would result in user exceeding the allowed number of subnets in a DB subnet groups.
", + "refs": { + } + }, + "DBUpgradeDependencyFailureFault": { + "base": "The DB upgrade failed because a resource the DB depends on could not be modified.
", + "refs": { + } + }, + "DeleteDBInstanceMessage": { + "base": "", + "refs": { + } + }, + "DeleteDBInstanceResult": { + "base": null, + "refs": { + } + }, + "DeleteDBParameterGroupMessage": { + "base": "
", + "refs": { + } + }, + "DeleteDBSecurityGroupMessage": { + "base": "
", + "refs": { + } + }, + "DeleteDBSnapshotMessage": { + "base": "
", + "refs": { + } + }, + "DeleteDBSnapshotResult": { + "base": null, + "refs": { + } + }, + "DeleteDBSubnetGroupMessage": { + "base": "
", + "refs": { + } + }, + "DeleteEventSubscriptionMessage": { + "base": "", + "refs": { + } + }, + "DeleteEventSubscriptionResult": { + "base": null, + "refs": { + } + }, + "DeleteOptionGroupMessage": { + "base": "
", + "refs": { + } + }, + "DescribeDBEngineVersionsMessage": { + "base": null, + "refs": { + } + }, + "DescribeDBInstancesMessage": { + "base": "
", + "refs": { + } + }, + "DescribeDBParameterGroupsMessage": { + "base": "
", + "refs": { + } + }, + "DescribeDBParametersMessage": { + "base": null, + "refs": { + } + }, + "DescribeDBSecurityGroupsMessage": { + "base": "
", + "refs": { + } + }, + "DescribeDBSnapshotsMessage": { + "base": "
", + "refs": { + } + }, + "DescribeDBSubnetGroupsMessage": { + "base": "
", + "refs": { + } + }, + "DescribeEngineDefaultParametersMessage": { + "base": "
", + "refs": { + } + }, + "DescribeEngineDefaultParametersResult": { + "base": null, + "refs": { + } + }, + "DescribeEventCategoriesMessage": { + "base": "", + "refs": { + } + }, + "DescribeEventSubscriptionsMessage": { + "base": "", + "refs": { + } + }, + "DescribeEventsMessage": { + "base": "
", + "refs": { + } + }, + "DescribeOptionGroupOptionsMessage": { + "base": "
", + "refs": { + } + }, + "DescribeOptionGroupsMessage": { + "base": "
", + "refs": { + } + }, + "DescribeOrderableDBInstanceOptionsMessage": { + "base": "
", + "refs": { + } + }, + "DescribeReservedDBInstancesMessage": { + "base": "
", + "refs": { + } + }, + "DescribeReservedDBInstancesOfferingsMessage": { + "base": "
", + "refs": { + } + }, + "Double": { + "base": null, + "refs": { + "RecurringCharge$RecurringChargeAmount": "
The amount of the recurring charge.
", + "ReservedDBInstance$FixedPrice": "The fixed price charged for this reserved DB Instance.
", + "ReservedDBInstance$UsagePrice": "The hourly price charged for this reserved DB Instance.
", + "ReservedDBInstancesOffering$FixedPrice": "The fixed price charged for this offering.
", + "ReservedDBInstancesOffering$UsagePrice": "The hourly price charged for this offering.
" + } + }, + "EC2SecurityGroup": { + "base": "This data type is used as a response element in the following actions:
", + "refs": { + "EC2SecurityGroupList$member": null + } + }, + "EC2SecurityGroupList": { + "base": null, + "refs": { + "DBSecurityGroup$EC2SecurityGroups": "Contains a list of EC2SecurityGroup elements.
" + } + }, + "Endpoint": { + "base": "This data type is used as a response element in the following actions:
", + "refs": { + "DBInstance$Endpoint": "Specifies the connection endpoint.
" + } + }, + "EngineDefaults": { + "base": "Contains the result of a successful invocation of the DescribeEngineDefaultParameters action.
", + "refs": { + "DescribeEngineDefaultParametersResult$EngineDefaults": null + } + }, + "Event": { + "base": "This data type is used as a response element in the DescribeEvents action.
", + "refs": { + "EventList$member": null + } + }, + "EventCategoriesList": { + "base": null, + "refs": { + "CreateEventSubscriptionMessage$EventCategories": "A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.
", + "DescribeEventsMessage$EventCategories": "A list of event categories that trigger notifications for a event notification subscription.
", + "Event$EventCategories": "Specifies the category for the event.
", + "EventCategoriesMap$EventCategories": "The event categories for the specified source type
", + "EventSubscription$EventCategoriesList": "A list of event categories for the RDS event notification subscription.
", + "ModifyEventSubscriptionMessage$EventCategories": "A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.
" + } + }, + "EventCategoriesMap": { + "base": "Contains the results of a successful invocation of the DescribeEventCategories action.
", + "refs": { + "EventCategoriesMapList$member": null + } + }, + "EventCategoriesMapList": { + "base": null, + "refs": { + "EventCategoriesMessage$EventCategoriesMapList": "A list of EventCategoriesMap data types.
" + } + }, + "EventCategoriesMessage": { + "base": "Data returned from the DescribeEventCategories action.
", + "refs": { + } + }, + "EventList": { + "base": null, + "refs": { + "EventsMessage$Events": "A list of Event instances.
" + } + }, + "EventSubscription": { + "base": "Contains the results of a successful invocation of the DescribeEventSubscriptions action.
", + "refs": { + "AddSourceIdentifierToSubscriptionResult$EventSubscription": null, + "CreateEventSubscriptionResult$EventSubscription": null, + "DeleteEventSubscriptionResult$EventSubscription": null, + "EventSubscriptionsList$member": null, + "ModifyEventSubscriptionResult$EventSubscription": null, + "RemoveSourceIdentifierFromSubscriptionResult$EventSubscription": null + } + }, + "EventSubscriptionQuotaExceededFault": { + "base": "You have reached the maximum number of event subscriptions.
", + "refs": { + } + }, + "EventSubscriptionsList": { + "base": null, + "refs": { + "EventSubscriptionsMessage$EventSubscriptionsList": "A list of EventSubscriptions data types.
" + } + }, + "EventSubscriptionsMessage": { + "base": "Data returned by the DescribeEventSubscriptions action.
", + "refs": { + } + }, + "EventsMessage": { + "base": "Contains the result of a successful invocation of the DescribeEvents action.
", + "refs": { + } + }, + "IPRange": { + "base": "This data type is used as a response element in the DescribeDBSecurityGroups action.
", + "refs": { + "IPRangeList$member": null + } + }, + "IPRangeList": { + "base": null, + "refs": { + "DBSecurityGroup$IPRanges": "Contains a list of IPRange elements.
" + } + }, + "InstanceQuotaExceededFault": { + "base": "Request would result in user exceeding the allowed number of DB instances.
", + "refs": { + } + }, + "InsufficientDBInstanceCapacityFault": { + "base": "Specified DB instance class is not available in the specified Availability Zone.
", + "refs": { + } + }, + "Integer": { + "base": null, + "refs": { + "DBInstance$AllocatedStorage": "Specifies the allocated storage size specified in gigabytes.
", + "DBInstance$BackupRetentionPeriod": "Specifies the number of days for which automatic DB Snapshots are retained.
", + "DBSnapshot$AllocatedStorage": "Specifies the allocated storage size in gigabytes (GB).
", + "DBSnapshot$Port": "Specifies the port that the database engine was listening on at the time of the snapshot.
", + "Endpoint$Port": "Specifies the port that the database engine is listening on.
", + "ReservedDBInstance$Duration": "The duration of the reservation in seconds.
", + "ReservedDBInstance$DBInstanceCount": "The number of reserved DB Instances.
", + "ReservedDBInstancesOffering$Duration": "The duration of the offering in seconds.
" + } + }, + "IntegerOptional": { + "base": null, + "refs": { + "CreateDBInstanceMessage$AllocatedStorage": "The amount of storage (in gigabytes) to be initially allocated for the database instance.
MySQL
Constraints: Must be an integer from 5 to 1024.
Type: Integer
Oracle
Constraints: Must be an integer from 10 to 1024.
SQL Server
Constraints: Must be an integer from 200 to 1024 (Standard Edition and Enterprise Edition) or from 30 to 1024 (Express Edition and Web Edition)
", + "CreateDBInstanceMessage$BackupRetentionPeriod": "The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
Default: 1
Constraints:
The port number on which the database accepts connections.
MySQL
Default: 3306
Valid Values: 1150-65535
Type: Integer
Oracle
Default: 1521
Valid Values: 1150-65535
SQL Server
Default: 1433
Valid Values: 1150-65535 except for 1434 and 3389.
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB Instance.
Constraints: Must be an integer greater than 1000.
", + "CreateDBInstanceReadReplicaMessage$Port": "The port number that the DB Instance uses for connections.
Default: Inherits from the source DB Instance
Valid Values: 1150-65535
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB Instance.
", + "DBInstance$Iops": "Specifies the Provisioned IOPS (I/O operations per second) value.
", + "DBSnapshot$Iops": "Specifies the Provisioned IOPS (I/O operations per second) value of the DB Instance at the time of the snapshot.
", + "DescribeDBEngineVersionsMessage$MaxRecords": " The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
", + "DescribeDBInstancesMessage$MaxRecords": " The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
", + "DescribeDBParameterGroupsMessage$MaxRecords": " The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
", + "DescribeDBParametersMessage$MaxRecords": " The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
", + "DescribeDBSecurityGroupsMessage$MaxRecords": " The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
", + "DescribeDBSnapshotsMessage$MaxRecords": " The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
", + "DescribeDBSubnetGroupsMessage$MaxRecords": " The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may 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 pagination token called a marker is included in the response so that the remaining results may be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
", + "DescribeEventSubscriptionsMessage$MaxRecords": " The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called 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 to retrieve events for.
Default: 60
", + "DescribeEventsMessage$MaxRecords": " The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
", + "DescribeOptionGroupOptionsMessage$MaxRecords": " The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
", + "DescribeOptionGroupsMessage$MaxRecords": " The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
", + "DescribeOrderableDBInstanceOptionsMessage$MaxRecords": " The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
", + "DescribeReservedDBInstancesMessage$MaxRecords": " The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
", + "DescribeReservedDBInstancesOfferingsMessage$MaxRecords": " The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
", + "ModifyDBInstanceMessage$AllocatedStorage": " The new storage capacity of the RDS instance. Changing this parameter does not result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.
MySQL
Default: Uses existing setting
Valid Values: 5-1024
Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
Type: Integer
Oracle
Default: Uses existing setting
Valid Values: 10-1024
Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
SQL Server
Cannot be modified.
", + "ModifyDBInstanceMessage$BackupRetentionPeriod": "The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
Changing this parameter can result in an outage if you change from 0 to a non-zero value or from a non-zero value to 0. These changes are applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously applied as soon as possible.
Default: Uses existing setting
Constraints:
The new Provisioned IOPS (I/O operations per second) value for the RDS instance. Changing this parameter does not result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.
Default: Uses existing setting
Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
Type: Integer
", + "Option$Port": "If required, the port configured for this option to use.
", + "OptionConfiguration$Port": "The optional port for the option.
", + "OptionGroupOption$DefaultPort": "If the option requires a port, specifies the default port for the option.
", + "PendingModifiedValues$AllocatedStorage": " Contains the new AllocatedStorage size for the DB Instance that will be applied or is in progress.
Specifies the pending port for the DB Instance.
", + "PendingModifiedValues$BackupRetentionPeriod": "Specifies the pending number of days for which automated backups are retained.
", + "PendingModifiedValues$Iops": "Specifies the new Provisioned IOPS value for the DB Instance that will be applied or is being applied.
", + "PromoteReadReplicaMessage$BackupRetentionPeriod": "The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
Default: 1
Constraints:
The number of instances to reserve.
Default: 1
The port number on which the database accepts connections.
Default: The same port as the original DB Instance
Constraints: Value must be 1150-65535
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB Instance.
Constraints: Must be an integer greater than 1000.
", + "RestoreDBInstanceToPointInTimeMessage$Port": "The port number on which the database accepts connections.
Constraints: Value must be 1150-65535
Default: The same port as the original DB Instance.
", + "RestoreDBInstanceToPointInTimeMessage$Iops": "The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB Instance.
Constraints: Must be an integer greater than 1000.
" + } + }, + "InvalidDBInstanceStateFault": { + "base": "The specified DB instance is not in the available state.
", + "refs": { + } + }, + "InvalidDBParameterGroupStateFault": { + "base": "The DB parameter group cannot be deleted because it is in use.
", + "refs": { + } + }, + "InvalidDBSecurityGroupStateFault": { + "base": "The state of the DB security group does not allow deletion.
", + "refs": { + } + }, + "InvalidDBSnapshotStateFault": { + "base": "The state of the DB snapshot does not allow deletion.
", + "refs": { + } + }, + "InvalidDBSubnetGroupStateFault": { + "base": "The DB subnet group cannot be deleted because it is in use.
", + "refs": { + } + }, + "InvalidDBSubnetStateFault": { + "base": "The DB subnet is not in the available state.
", + "refs": { + } + }, + "InvalidEventSubscriptionStateFault": { + "base": "This error can occur if someone else is modifying a subscription. You should retry the action.
", + "refs": { + } + }, + "InvalidOptionGroupStateFault": { + "base": "The option group is not in the available state.
", + "refs": { + } + }, + "InvalidRestoreFault": { + "base": "Cannot restore from vpc backup to non-vpc DB instance.
", + "refs": { + } + }, + "InvalidSubnet": { + "base": "The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
", + "refs": { + } + }, + "InvalidVPCNetworkStateFault": { + "base": "DB subnet group does not cover all Availability Zones after it is created because users' change.
", + "refs": { + } + }, + "KeyList": { + "base": null, + "refs": { + "RemoveTagsFromResourceMessage$TagKeys": "The tag key (name) of the tag to be removed.
" + } + }, + "ListTagsForResourceMessage": { + "base": "", + "refs": { + } + }, + "ModifyDBInstanceMessage": { + "base": "", + "refs": { + } + }, + "ModifyDBInstanceResult": { + "base": null, + "refs": { + } + }, + "ModifyDBParameterGroupMessage": { + "base": "
", + "refs": { + } + }, + "ModifyDBSubnetGroupMessage": { + "base": "
", + "refs": { + } + }, + "ModifyDBSubnetGroupResult": { + "base": null, + "refs": { + } + }, + "ModifyEventSubscriptionMessage": { + "base": "", + "refs": { + } + }, + "ModifyEventSubscriptionResult": { + "base": null, + "refs": { + } + }, + "ModifyOptionGroupMessage": { + "base": "
", + "refs": { + } + }, + "ModifyOptionGroupResult": { + "base": null, + "refs": { + } + }, + "Option": { + "base": "
Option details.
", + "refs": { + "OptionsList$member": null + } + }, + "OptionConfiguration": { + "base": "A list of all available options
", + "refs": { + "OptionConfigurationList$member": null + } + }, + "OptionConfigurationList": { + "base": null, + "refs": { + "ModifyOptionGroupMessage$OptionsToInclude": "Options in this list are added to the Option Group or, if already present, the specified configuration is used to update the existing configuration.
" + } + }, + "OptionGroup": { + "base": "", + "refs": { + "CreateOptionGroupResult$OptionGroup": null, + "ModifyOptionGroupResult$OptionGroup": null, + "OptionGroupsList$member": null + } + }, + "OptionGroupAlreadyExistsFault": { + "base": "
The option group you are trying to create already exists.
", + "refs": { + } + }, + "OptionGroupMembership": { + "base": null, + "refs": { + "DBInstance$OptionGroupMembership": "Specifies the name and status of the option group that this instance belongs to.
" + } + }, + "OptionGroupNotFoundFault": { + "base": "The specified option group could not be found.
", + "refs": { + } + }, + "OptionGroupOption": { + "base": "Available option.
", + "refs": { + "OptionGroupOptionsList$member": null + } + }, + "OptionGroupOptionsList": { + "base": "List of available options.
", + "refs": { + "OptionGroupOptionsMessage$OptionGroupOptions": null + } + }, + "OptionGroupOptionsMessage": { + "base": "", + "refs": { + } + }, + "OptionGroupQuotaExceededFault": { + "base": "
The quota of 20 option groups was exceeded for this AWS account.
", + "refs": { + } + }, + "OptionGroups": { + "base": "List of option groups.
", + "refs": { + } + }, + "OptionGroupsList": { + "base": null, + "refs": { + "OptionGroups$OptionGroupsList": "List of option groups.
" + } + }, + "OptionNamesList": { + "base": null, + "refs": { + "ModifyOptionGroupMessage$OptionsToRemove": "Options in this list are removed from the Option Group.
" + } + }, + "OptionsDependedOn": { + "base": null, + "refs": { + "OptionGroupOption$OptionsDependedOn": "List of all options that are prerequisites for this option.
" + } + }, + "OptionsList": { + "base": null, + "refs": { + "OptionGroup$Options": "Indicates what options are available in the option group.
" + } + }, + "OrderableDBInstanceOption": { + "base": "Contains a list of available options for a DB Instance
This data type is used as a response element in the DescribeOrderableDBInstanceOptions action.
", + "refs": { + "OrderableDBInstanceOptionsList$member": null + } + }, + "OrderableDBInstanceOptionsList": { + "base": null, + "refs": { + "OrderableDBInstanceOptionsMessage$OrderableDBInstanceOptions": "An OrderableDBInstanceOption structure containing information about orderable options for the DB Instance.
" + } + }, + "OrderableDBInstanceOptionsMessage": { + "base": "Contains the result of a successful invocation of the DescribeOrderableDBInstanceOptions action.
", + "refs": { + } + }, + "Parameter": { + "base": "This data type is used as a request parameter in the ModifyDBParameterGroup and ResetDBParameterGroup actions.
This data type is used as a response element in the DescribeEngineDefaultParameters and DescribeDBParameters actions.
", + "refs": { + "ParametersList$member": null + } + }, + "ParametersList": { + "base": null, + "refs": { + "DBParameterGroupDetails$Parameters": "A list of Parameter instances.
", + "EngineDefaults$Parameters": "Contains a list of engine default parameters.
", + "ModifyDBParameterGroupMessage$Parameters": "An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters may be modified in a single request.
Valid Values (for the application method): immediate | pending-reboot
An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters may be modified in a single request.
MySQL
Valid Values (for Apply method): immediate | pending-reboot
You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when DB Instance reboots.
Oracle
Valid Values (for Apply method): pending-reboot
This data type is used as a response element in the ModifyDBInstance action.
", + "refs": { + "DBInstance$PendingModifiedValues": "Specifies that changes to the DB Instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
" + } + }, + "PointInTimeRestoreNotEnabledFault": { + "base": "SourceDBInstanceIdentifier refers to a DB instance with BackupRetentionPeriod equal to 0.
", + "refs": { + } + }, + "PromoteReadReplicaMessage": { + "base": "", + "refs": { + } + }, + "PromoteReadReplicaResult": { + "base": null, + "refs": { + } + }, + "ProvisionedIopsNotAvailableInAZFault": { + "base": "
Provisioned IOPS not available in the specified Availability Zone.
", + "refs": { + } + }, + "PurchaseReservedDBInstancesOfferingMessage": { + "base": "", + "refs": { + } + }, + "PurchaseReservedDBInstancesOfferingResult": { + "base": null, + "refs": { + } + }, + "ReadReplicaDBInstanceIdentifierList": { + "base": null, + "refs": { + "DBInstance$ReadReplicaDBInstanceIdentifiers": "
Contains one or more identifiers of the Read Replicas associated with this DB Instance.
" + } + }, + "RebootDBInstanceMessage": { + "base": "", + "refs": { + } + }, + "RebootDBInstanceResult": { + "base": null, + "refs": { + } + }, + "RecurringCharge": { + "base": "
This data type is used as a response element in the DescribeReservedDBInstances and DescribeReservedDBInstancesOfferings actions.
", + "refs": { + "RecurringChargeList$member": null + } + }, + "RecurringChargeList": { + "base": null, + "refs": { + "ReservedDBInstance$RecurringCharges": "The recurring price charged to run this reserved DB Instance.
", + "ReservedDBInstancesOffering$RecurringCharges": "The recurring price charged to run this reserved DB Instance.
" + } + }, + "RemoveSourceIdentifierFromSubscriptionMessage": { + "base": "", + "refs": { + } + }, + "RemoveSourceIdentifierFromSubscriptionResult": { + "base": null, + "refs": { + } + }, + "RemoveTagsFromResourceMessage": { + "base": "", + "refs": { + } + }, + "ReservedDBInstance": { + "base": "This data type is used as a response element in the DescribeReservedDBInstances and PurchaseReservedDBInstancesOffering actions.
", + "refs": { + "PurchaseReservedDBInstancesOfferingResult$ReservedDBInstance": null, + "ReservedDBInstanceList$member": null + } + }, + "ReservedDBInstanceAlreadyExistsFault": { + "base": "User already has a reservation with the given identifier.
", + "refs": { + } + }, + "ReservedDBInstanceList": { + "base": null, + "refs": { + "ReservedDBInstanceMessage$ReservedDBInstances": "A list of of reserved DB Instances.
" + } + }, + "ReservedDBInstanceMessage": { + "base": "Contains the result of a successful invocation of the DescribeReservedDBInstances action.
", + "refs": { + } + }, + "ReservedDBInstanceNotFoundFault": { + "base": "The specified reserved DB Instance not found.
", + "refs": { + } + }, + "ReservedDBInstanceQuotaExceededFault": { + "base": "Request would exceed the user's DB Instance quota.
", + "refs": { + } + }, + "ReservedDBInstancesOffering": { + "base": "This data type is used as a response element in the DescribeReservedDBInstancesOfferings action.
", + "refs": { + "ReservedDBInstancesOfferingList$member": null + } + }, + "ReservedDBInstancesOfferingList": { + "base": null, + "refs": { + "ReservedDBInstancesOfferingMessage$ReservedDBInstancesOfferings": "A list of reserved DB Instance offerings.
" + } + }, + "ReservedDBInstancesOfferingMessage": { + "base": "Contains the result of a successful invocation of the DescribeReservedDBInstancesOfferings action.
", + "refs": { + } + }, + "ReservedDBInstancesOfferingNotFoundFault": { + "base": "Specified offering does not exist.
", + "refs": { + } + }, + "ResetDBParameterGroupMessage": { + "base": "", + "refs": { + } + }, + "RestoreDBInstanceFromDBSnapshotMessage": { + "base": "
", + "refs": { + } + }, + "RestoreDBInstanceFromDBSnapshotResult": { + "base": null, + "refs": { + } + }, + "RestoreDBInstanceToPointInTimeMessage": { + "base": "
", + "refs": { + } + }, + "RestoreDBInstanceToPointInTimeResult": { + "base": null, + "refs": { + } + }, + "RevokeDBSecurityGroupIngressMessage": { + "base": "
", + "refs": { + } + }, + "RevokeDBSecurityGroupIngressResult": { + "base": null, + "refs": { + } + }, + "SNSInvalidTopicFault": { + "base": "
SNS has responded that there is a problem with the SND topic specified.
", + "refs": { + } + }, + "SNSNoAuthorizationFault": { + "base": "You do not have permission to publish to the SNS topic ARN.
", + "refs": { + } + }, + "SNSTopicArnNotFoundFault": { + "base": "The SNS topic ARN does not exist.
", + "refs": { + } + }, + "SnapshotQuotaExceededFault": { + "base": "Request would result in user exceeding the allowed number of DB snapshots.
", + "refs": { + } + }, + "SourceIdsList": { + "base": null, + "refs": { + "CreateEventSubscriptionMessage$SourceIds": "The list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens.
Constraints:
A list of source Ids for the RDS event notification subscription.
" + } + }, + "SourceNotFoundFault": { + "base": "The requested source could not be found.
", + "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 source type for this event.
" + } + }, + "StorageQuotaExceededFault": { + "base": "Request would result in user exceeding the allowed amount of storage available across all DB instances.
", + "refs": { + } + }, + "String": { + "base": null, + "refs": { + "AddSourceIdentifierToSubscriptionMessage$SubscriptionName": "The name of the RDS event notification subscription you want to add a source identifier to.
", + "AddSourceIdentifierToSubscriptionMessage$SourceIdentifier": "The identifier of the event source to be added. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens.
Constraints:
The DB Instance the tags will be added to.
", + "AuthorizeDBSecurityGroupIngressMessage$DBSecurityGroupName": "The name of the DB Security Group to add authorization to.
", + "AuthorizeDBSecurityGroupIngressMessage$CIDRIP": "The IP range to authorize.
", + "AuthorizeDBSecurityGroupIngressMessage$EC2SecurityGroupName": " Name of the EC2 Security Group to authorize. For VPC DB Security Groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
Id of the EC2 Security Group to authorize. For VPC DB Security Groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
AWS Account Number of the owner of the EC2 Security Group specified in the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value. For VPC DB Security Groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
The name of the availability zone.
", + "CharacterSet$CharacterSetName": "The name of the character set.
", + "CharacterSet$CharacterSetDescription": "The description of the character set.
", + "CopyDBSnapshotMessage$SourceDBSnapshotIdentifier": "The identifier for the source DB snapshot.
Constraints:
Example: rds:mydb-2012-04-02-00-01
The identifier for the copied snapshot.
Constraints:
Example: my-db-snapshot
The meaning of this parameter differs according to the database engine you use.
MySQL
The name of the database to create when the DB Instance is created. If this parameter is not specified, no database is created in the DB Instance.
Constraints:
Type: String
Oracle
The Oracle System ID (SID) of the created DB Instance.
Default: ORCL
Constraints:
SQL Server
Not applicable. Must be null.
", + "CreateDBInstanceMessage$DBInstanceIdentifier": "The DB Instance identifier. This parameter is stored as a lowercase string.
Constraints:
Example: mydbinstance
The compute and memory capacity of the DB Instance.
Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge
The name of the database engine to be used for this instance.
Valid Values: MySQL | oracle-se1 | oracle-se | oracle-ee | sqlserver-ee | sqlserver-se | sqlserver-ex | sqlserver-web
The name of master user for the client DB Instance.
MySQL
Constraints:
Type: String
Oracle
Constraints:
SQL Server
Constraints:
The password for the master database user. Can be any printable ASCII character except \"/\", \"\\\", or \"@\".
Type: String
MySQL
Constraints: Must contain from 8 to 41 alphanumeric characters.
Oracle
Constraints: Must contain from 8 to 30 alphanumeric characters.
SQL Server
Constraints: Must contain from 8 to 128 alphanumeric characters.
", + "CreateDBInstanceMessage$AvailabilityZone": "The EC2 Availability Zone that the database instance will be created in.
Default: A random, system-chosen Availability Zone in the endpoint's region.
Example: us-east-1d
Constraint: The AvailabilityZone parameter cannot be specified if the MultiAZ parameter is set to true. The specified Availability Zone must be in the same region as the current endpoint.
A DB Subnet Group to associate with this DB Instance.
If there is no DB Subnet Group, then it is a non-VPC DB instance.
", + "CreateDBInstanceMessage$PreferredMaintenanceWindow": "The weekly time range (in UTC) during which system maintenance can occur.
Format: ddd:hh24:mi-ddd:hh24:mi
Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. The following list shows the time blocks for each region from which the default maintenance windows are assigned.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
", + "CreateDBInstanceMessage$DBParameterGroupName": "The name of the DB Parameter Group to associate with this DB instance. If this argument is omitted, the default DBParameterGroup for the specified engine will be used.
Constraints:
The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.
Default: A 30-minute window selected at random from an 8-hour block of time per region. The following list shows the time blocks for each region from which the default backup windows are assigned.
Constraints: Must be in the format hh24:mi-hh24:mi. Times should be Universal Time Coordinated (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes.
The version number of the database engine to use.
MySQL
Example: 5.1.42
Type: String
Oracle
Example: 11.2.0.2.v2
Type: String
SQL Server
Example: 10.50.2789.0.v1
License model information for this DB Instance.
Valid values: license-included | bring-your-own-license | general-public-license
Indicates that the DB Instance should be associated with the specified option group.
", + "CreateDBInstanceMessage$CharacterSetName": "For supported engines, indicates that the DB Instance should be associated with the specified CharacterSet.
", + "CreateDBInstanceReadReplicaMessage$DBInstanceIdentifier": "The DB Instance identifier of the Read Replica. This is the unique key that identifies a DB Instance. This parameter is stored as a lowercase string.
", + "CreateDBInstanceReadReplicaMessage$SourceDBInstanceIdentifier": "The identifier of the DB Instance that will act as the source for the Read Replica. Each DB Instance can have up to five Read Replicas.
Constraints: Must be the identifier of an existing DB Instance that is not already a Read Replica DB Instance.
", + "CreateDBInstanceReadReplicaMessage$DBInstanceClass": "The compute and memory capacity of the Read Replica.
Valid Values: db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge
Default: Inherits from the source DB Instance.
", + "CreateDBInstanceReadReplicaMessage$AvailabilityZone": "The Amazon EC2 Availability Zone that the Read Replica will be created in.
Default: A random, system-chosen Availability Zone in the endpoint's region.
Example: us-east-1d
The option group the DB instance will be associated with. If omitted, the default Option Group for the engine specified will be used.
", + "CreateDBParameterGroupMessage$DBParameterGroupName": "The name of the DB Parameter Group.
Constraints:
The DB Parameter Group Family name. A DB Parameter Group can be associated with one and only one DB Parameter Group Family, and can be applied only to a DB Instance running a database engine and engine version compatible with that DB Parameter Group Family.
", + "CreateDBParameterGroupMessage$Description": "The description for the DB Parameter Group.
", + "CreateDBSecurityGroupMessage$DBSecurityGroupName": "The name for the DB Security Group. This value is stored as a lowercase string.
Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Must not be \"Default\".
Example: mysecuritygroup
The description for the DB Security Group.
", + "CreateDBSnapshotMessage$DBSnapshotIdentifier": "The identifier for the DB Snapshot.
Constraints:
Example: my-snapshot-id
The DB Instance identifier. This is the unique key that identifies a DB Instance. This parameter isn't case sensitive.
Constraints:
The name for the DB Subnet Group. This value is stored as a lowercase string.
Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Must not be \"Default\".
Example: mySubnetgroup
The description for the DB Subnet Group.
", + "CreateEventSubscriptionMessage$SubscriptionName": "The name of the subscription.
Constraints: The name must be less than 255 characters.
", + "CreateEventSubscriptionMessage$SnsTopicArn": "The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.
", + "CreateEventSubscriptionMessage$SourceType": "The type of source that will be generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned.
Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot
", + "CreateOptionGroupMessage$OptionGroupName": "Specifies the name of the option group to be created.
Constraints:
Example: myOptiongroup
Specifies the name of the engine that this option group should be associated with.
", + "CreateOptionGroupMessage$MajorEngineVersion": "Specifies the major version of the engine that this option group should be associated with.
", + "CreateOptionGroupMessage$OptionGroupDescription": "The description of the option group.
", + "DBEngineVersion$Engine": "The name of the database engine.
", + "DBEngineVersion$EngineVersion": "The version number of the database engine.
", + "DBEngineVersion$DBParameterGroupFamily": "The name of the DBParameterGroupFamily for the database engine.
", + "DBEngineVersion$DBEngineDescription": "The description of the database engine.
", + "DBEngineVersion$DBEngineVersionDescription": "The description of the database engine version.
", + "DBEngineVersionMessage$Marker": " An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
Contains a user-supplied database identifier. This is the unique key that identifies a DB Instance.
", + "DBInstance$DBInstanceClass": "Contains the name of the compute and memory capacity class of the DB Instance.
", + "DBInstance$Engine": "Provides the name of the database engine to be used for this DB Instance.
", + "DBInstance$DBInstanceStatus": "Specifies the current state of this database.
", + "DBInstance$MasterUsername": "Contains the master username for the DB Instance.
", + "DBInstance$DBName": "The meaning of this parameter differs according to the database engine you use.
MySQL
Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB Instance was created. This same name is returned for the life of the DB Instance.
Type: String
Oracle
Contains the Oracle System ID (SID) of the created DB Instance.
", + "DBInstance$PreferredBackupWindow": " Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
Specifies the name of the Availability Zone the DB Instance is located in.
", + "DBInstance$PreferredMaintenanceWindow": "Specifies the weekly time range (in UTC) during which system maintenance can occur.
", + "DBInstance$EngineVersion": "Indicates the database engine version.
", + "DBInstance$ReadReplicaSourceDBInstanceIdentifier": "Contains the identifier of the source DB Instance if this DB Instance is a Read Replica.
", + "DBInstance$LicenseModel": "License model information for this DB Instance.
", + "DBInstance$CharacterSetName": "If present, specifies the name of the character set that this instance is associated with.
", + "DBInstance$SecondaryAvailabilityZone": "If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
", + "DBInstanceMessage$Marker": " An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
Provides the name of the DB Parameter Group.
", + "DBParameterGroup$DBParameterGroupFamily": "Provides the name of the DB Parameter Group Family that this DB Parameter Group is compatible with.
", + "DBParameterGroup$Description": "Provides the customer-specified description for this DB Parameter Group.
", + "DBParameterGroupDetails$Marker": " An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of the DB Parameter Group.
", + "DBParameterGroupStatus$DBParameterGroupName": "The name of the DP Parameter Group.
", + "DBParameterGroupStatus$ParameterApplyStatus": "The status of parameter updates.
", + "DBParameterGroupsMessage$Marker": " An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
Provides the AWS ID of the owner of a specific DB Security Group.
", + "DBSecurityGroup$DBSecurityGroupName": "Specifies the name of the DB Security Group.
", + "DBSecurityGroup$DBSecurityGroupDescription": "Provides the description of the DB Security Group.
", + "DBSecurityGroup$VpcId": "Provides the VpcId of the DB Security Group.
", + "DBSecurityGroupMembership$DBSecurityGroupName": "The name of the DB Security Group.
", + "DBSecurityGroupMembership$Status": "The status of the DB Security Group.
", + "DBSecurityGroupMessage$Marker": " An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
Specifies the identifier for the DB Snapshot.
", + "DBSnapshot$DBInstanceIdentifier": "Specifies the the DBInstanceIdentifier of the DB Instance this DB Snapshot was created from.
", + "DBSnapshot$Engine": "Specifies the name of the database engine.
", + "DBSnapshot$Status": "Specifies the status of this DB Snapshot.
", + "DBSnapshot$AvailabilityZone": "Specifies the name of the Availability Zone the DB Instance was located in at the time of the DB Snapshot.
", + "DBSnapshot$VpcId": "Provides the Vpc Id associated with the DB Snapshot.
", + "DBSnapshot$MasterUsername": "Provides the master username for the DB Instance.
", + "DBSnapshot$EngineVersion": "Specifies the version of the database engine.
", + "DBSnapshot$LicenseModel": "License model information for the restored DB Instance.
", + "DBSnapshot$SnapshotType": "Provides the type of the DB Snapshot.
", + "DBSnapshotMessage$Marker": " An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
Specifies the name of the DB Subnet Group.
", + "DBSubnetGroup$DBSubnetGroupDescription": "Provides the description of the DB Subnet Group.
", + "DBSubnetGroup$VpcId": "Provides the VpcId of the DB Subnet Group.
", + "DBSubnetGroup$SubnetGroupStatus": "Provides the status of the DB Subnet Group.
", + "DBSubnetGroupMessage$Marker": " An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The DB Instance identifier for the DB Instance to be deleted. This parameter isn't case sensitive.
Constraints:
The DBSnapshotIdentifier of the new DBSnapshot created when SkipFinalSnapshot is set to false.
Constraints:
The name of the DB Parameter Group.
Constraints:
The name of the DB Security Group to delete.
Constraints:
The DBSnapshot identifier.
Constraints: Must be the name of an existing DB Snapshot in the available state.
The name of the database subnet group to delete.
Constraints:
The name of the RDS event notification subscription you want to delete.
", + "DeleteOptionGroupMessage$OptionGroupName": "The name of the option group to be deleted.
The database engine to return.
", + "DescribeDBEngineVersionsMessage$EngineVersion": "The database engine version to return.
Example: 5.1.49
The name of a specific DB Parameter Group family to return details for.
Constraints:
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The user-supplied instance identifier. If this parameter is specified, information from only the specific DB Instance is returned. This parameter isn't case sensitive.
Constraints:
An optional pagination token provided by a previous DescribeDBInstances request. 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 DB Parameter Group to return details for.
Constraints:
An optional pagination token provided by a previous DescribeDBParameterGroups request. 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 DB Parameter Group to return details for.
Constraints:
The parameter types to return.
Default: All parameter types returned
Valid Values: user | system | engine-default
An optional pagination token provided by a previous DescribeDBParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of the DB Security Group to return details for.
", + "DescribeDBSecurityGroupsMessage$Marker": " An optional pagination token provided by a previous DescribeDBSecurityGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
A DB Instance Identifier to retrieve the list of DB Snapshots for. Cannot be used in conjunction with DBSnapshotIdentifier. This parameter isn't case sensitive.
Constraints:
A specific DB Snapshot Identifier to describe. Cannot be used in conjunction with DBInstanceIdentifier. This value is stored as a lowercase string.
Constraints:
SnapshotType parameter must also be specified.An optional snapshot type for which snapshots will be returned. If not specified, the returned results will include snapshots of all types.
", + "DescribeDBSnapshotsMessage$Marker": " An optional pagination token provided by a previous DescribeDBSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of the DB Subnet Group to return details for.
", + "DescribeDBSubnetGroupsMessage$Marker": " An optional pagination token provided by a previous DescribeDBSubnetGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of the DB Parameter Group Family.
", + "DescribeEngineDefaultParametersMessage$Marker": " An optional pagination token provided by a previous DescribeEngineDefaultParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The type of source that will be generating the events.
Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot
", + "DescribeEventSubscriptionsMessage$SubscriptionName": "The name of the RDS event notification subscription you want to describe.
", + "DescribeEventSubscriptionsMessage$Marker": " An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. 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 will be returned. If not specified, then all sources are included in the response.
Constraints:
An optional pagination token provided by a previous DescribeEvents request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
Options available for the given DB engine name to be described.
", + "DescribeOptionGroupOptionsMessage$MajorEngineVersion": "If specified, filters the results to include only options for the specified major engine version.
", + "DescribeOptionGroupOptionsMessage$Marker": "An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of the option group to describe. Cannot be supplied together with EngineName or MajorEngineVersion.
", + "DescribeOptionGroupsMessage$Marker": " An optional pagination token provided by a previous DescribeOptionGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
Filters the list of option groups to only include groups associated with a specific database engine.
", + "DescribeOptionGroupsMessage$MajorEngineVersion": "Filters the list of option groups to only include groups associated with a specific database engine version. If specified, then EngineName must also be specified.
", + "DescribeOrderableDBInstanceOptionsMessage$Engine": "The name of the engine to retrieve DB Instance options for.
", + "DescribeOrderableDBInstanceOptionsMessage$EngineVersion": "The engine version filter value. Specify this parameter to show only the available offerings matching the specified engine version.
", + "DescribeOrderableDBInstanceOptionsMessage$DBInstanceClass": "The DB Instance class filter value. Specify this parameter to show only the available offerings matching the specified DB Instance class.
", + "DescribeOrderableDBInstanceOptionsMessage$LicenseModel": "The license model filter value. Specify this parameter to show only the available offerings matching the specified license model.
", + "DescribeOrderableDBInstanceOptionsMessage$Marker": " An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
The reserved DB Instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID.
", + "DescribeReservedDBInstancesMessage$ReservedDBInstancesOfferingId": "The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.
", + "DescribeReservedDBInstancesMessage$DBInstanceClass": "The DB Instance class filter value. Specify this parameter to show only those reservations matching the specified DB Instances class.
", + "DescribeReservedDBInstancesMessage$Duration": "The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.
Valid Values: 1 | 3 | 31536000 | 94608000
The product description filter value. Specify this parameter to show only those reservations matching the specified product description.
", + "DescribeReservedDBInstancesMessage$OfferingType": "The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.
Valid Values: \"Light Utilization\" | \"Medium Utilization\" | \"Heavy Utilization\"
An optional pagination token provided by a previous request. 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. Specify this parameter to show only the available offering that matches the specified reservation identifier.
Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
The DB Instance class filter value. Specify this parameter to show only the available offerings matching the specified DB Instance class.
", + "DescribeReservedDBInstancesOfferingsMessage$Duration": "Duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.
Valid Values: 1 | 3 | 31536000 | 94608000
Product description filter value. Specify this parameter to show only the available offerings matching the specified product description.
", + "DescribeReservedDBInstancesOfferingsMessage$OfferingType": "The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.
Valid Values: \"Light Utilization\" | \"Medium Utilization\" | \"Heavy Utilization\"
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
Provides the status of the EC2 security group. Status can be \"authorizing\", \"authorized\", \"revoking\", and \"revoked\".
", + "EC2SecurityGroup$EC2SecurityGroupName": "Specifies the name of the EC2 Security Group.
", + "EC2SecurityGroup$EC2SecurityGroupId": "Specifies the id of the EC2 Security Group.
", + "EC2SecurityGroup$EC2SecurityGroupOwnerId": " Specifies the AWS ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field.
Specifies the DNS address of the DB Instance.
", + "EngineDefaults$DBParameterGroupFamily": "Specifies the name of the DB Parameter Group Family which the engine default parameters apply to.
", + "EngineDefaults$Marker": " An optional pagination token provided by a previous EngineDefaults request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
Provides the identifier for the source of the event.
", + "Event$Message": "Provides the text of this event.
", + "EventCategoriesList$member": null, + "EventCategoriesMap$SourceType": "The source type that the returned categories belong to
", + "EventSubscription$Id": "Not used.
", + "EventSubscription$CustomerAwsId": "The AWS customer account associated with the RDS event notification subscription.
", + "EventSubscription$CustSubscriptionId": "The RDS event notification subscription Id.
", + "EventSubscription$SnsTopicArn": "The topic ARN of the RDS event notification subscription.
", + "EventSubscription$Status": "The status of the RDS event notification subscription.
Constraints:
Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist
The status \"no-permission\" indicates that RDS no longer has permission to post to the SNS topic. The status \"topic-not-exist\" indicates that the topic was deleted after the subscription was created.
", + "EventSubscription$SubscriptionCreationTime": "The time the RDS event notification subscription was created.
", + "EventSubscription$SourceType": "The source type for the RDS event notification subscription.
", + "EventSubscriptionsMessage$Marker": " An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
An optional pagination token provided by a previous Events request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
Specifies the status of the IP range. Status can be \"authorizing\", \"authorized\", \"revoking\", and \"revoked\".
", + "IPRange$CIDRIP": "Specifies the IP range.
", + "KeyList$member": null, + "ListTagsForResourceMessage$ResourceName": "The DB Instance with tags to be listed.
", + "ModifyDBInstanceMessage$DBInstanceIdentifier": "The DB Instance identifier. This value is stored as a lowercase string.
Constraints:
The new compute and memory capacity of the DB Instance. To determine the instance classes that are available for a particular DB engine, use the DescribeOrderableDBInstanceOptions action.
Passing a value for this parameter causes an outage during the change and is applied during the next maintenance window, unless the ApplyImmediately parameter is specified as true for this request.
Default: Uses existing setting
Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge | db.m2.2xlarge | db.m2.4xlarge
The new password for the DB Instance master user. Can be any printable ASCII character except \"/\", \"\\\", or \"@\".
Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.
Default: Uses existing setting
Constraints: Must be 8 to 41 alphanumeric characters (MySQL), 8 to 30 alphanumeric characters (Oracle), or 8 to 128 alphanumeric characters (SQL Server).
The name of the DB Parameter Group to apply to this DB Instance. Changing this parameter does not result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.
Default: Uses existing setting
Constraints: The DB Parameter Group must be in the same DB Parameter Group family as this DB Instance.
", + "ModifyDBInstanceMessage$PreferredBackupWindow": " The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.
Constraints:
The weekly time range (in UTC) during which system maintenance can occur, which may result in an outage. Changing this parameter does not result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, then changing this parameter will cause a reboot of the DB Instance. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied.
Default: Uses existing setting
Format: ddd:hh24:mi-ddd:hh24:mi
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Must be at least 30 minutes
", + "ModifyDBInstanceMessage$EngineVersion": " The version number of the database engine to upgrade to. Changing this parameter results in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.
For major version upgrades, if a nondefault DB Parameter Group is currently in use, a new DB Parameter Group in the DB Parameter Group Family for the new engine version must be specified. The new DB Parameter Group can be the default for that DB Parameter Group Family.
Example: 5.1.42
Indicates that the DB Instance should be associated with the specified option group. Changing this parameter does not result in an outage except in the following case and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.
The new DB Instance identifier for the DB Instance when renaming a DB Instance. This value is stored as a lowercase string.
Constraints:
The name of the DB Parameter Group.
Constraints:
The name for the DB Subnet Group. This value is stored as a lowercase string.
Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Must not be \"Default\".
Example: mySubnetgroup
The description for the DB Subnet Group.
", + "ModifyEventSubscriptionMessage$SubscriptionName": "The name of the RDS event notification subscription.
", + "ModifyEventSubscriptionMessage$SnsTopicArn": "The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.
", + "ModifyEventSubscriptionMessage$SourceType": "The type of source that will be generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned.
Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot
", + "ModifyOptionGroupMessage$OptionGroupName": "The name of the option group to be modified.
", + "Option$OptionName": "The name of the option.
", + "Option$OptionDescription": "The description of the option.
", + "OptionConfiguration$OptionName": "The configuration of options to include in a group.
", + "OptionGroup$OptionGroupName": "Specifies the name of the option group.
", + "OptionGroup$OptionGroupDescription": "Provides the description of the option group.
", + "OptionGroup$EngineName": "Engine name that this option group can be applied to.
", + "OptionGroup$MajorEngineVersion": "Indicates the major engine version associated with this option group.
", + "OptionGroup$VpcId": "If AllowsVpcAndNonVpcInstanceMemberships is 'false', this field is blank. If AllowsVpcAndNonVpcInstanceMemberships is 'true' and this field is blank, then this option group can be applied to both VPC and non-VPC instances. If this field contains a value, then this option group can only be applied to instances that are in the VPC indicated by this field.
", + "OptionGroupMembership$OptionGroupName": "The name of the option group that the instance belongs to.
", + "OptionGroupMembership$Status": "The status of the DB Instance's option group membership (e.g. in-sync, pending, pending-maintenance, applying).
", + "OptionGroupOption$Name": "The name of the option.
", + "OptionGroupOption$Description": "The description of the option.
", + "OptionGroupOption$EngineName": "Engine name that this option can be applied to.
", + "OptionGroupOption$MajorEngineVersion": "Indicates the major engine version that the option is available for.
", + "OptionGroupOption$MinimumRequiredMinorEngineVersion": "The minimum required engine version for the option to be applied.
", + "OptionGroupOptionsMessage$Marker": "An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The engine type of the orderable DB Instance.
", + "OrderableDBInstanceOption$EngineVersion": "The engine version of the orderable DB Instance.
", + "OrderableDBInstanceOption$DBInstanceClass": "The DB Instance Class for the orderable DB Instance
", + "OrderableDBInstanceOption$LicenseModel": "The license model for the orderable DB Instance.
", + "OrderableDBInstanceOptionsMessage$Marker": " An optional pagination token provided by a previous OrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
Specifies the name of the parameter.
", + "Parameter$ParameterValue": "Specifies the value of the parameter.
", + "Parameter$Description": "Provides a description of the parameter.
", + "Parameter$Source": "Indicates the source of the parameter value.
", + "Parameter$ApplyType": "Specifies the engine specific parameters type.
", + "Parameter$DataType": "Specifies the valid data type for the parameter.
", + "Parameter$AllowedValues": "Specifies the valid range of values for the parameter.
", + "Parameter$MinimumEngineVersion": "The earliest engine version to which the parameter can apply.
", + "PendingModifiedValues$DBInstanceClass": " Contains the new DBInstanceClass for the DB Instance that will be applied or is in progress.
Contains the pending or in-progress change of the master credentials for the DB Instance.
", + "PendingModifiedValues$EngineVersion": "Indicates the database engine version.
", + "PendingModifiedValues$DBInstanceIdentifier": " Contains the new DBInstanceIdentifier for the DB Instance that will be applied or is in progress.
The DB Instance identifier. This value is stored as a lowercase string.
Constraints:
Example:
The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.
Default: A 30-minute window selected at random from an 8-hour block of time per region. The following list shows the time blocks for each region from which the default backup windows are assigned.
Constraints: Must be in the format hh24:mi-hh24:mi. Times should be Universal Time Coordinated (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes.
The ID of the Reserved DB Instance offering to purchase.
Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
", + "PurchaseReservedDBInstancesOfferingMessage$ReservedDBInstanceId": "Customer-specified identifier to track this reservation.
Example: myreservationID
", + "ReadReplicaDBInstanceIdentifierList$member": null, + "RebootDBInstanceMessage$DBInstanceIdentifier": "The DB Instance identifier. This parameter is stored as a lowercase string.
Constraints:
The frequency of the recurring charge.
", + "RemoveSourceIdentifierFromSubscriptionMessage$SubscriptionName": "The name of the RDS event notification subscription you want to remove a source identifier from.
", + "RemoveSourceIdentifierFromSubscriptionMessage$SourceIdentifier": "The source identifier to be removed from the subscription, such as the DB instance identifier for a DB instance or the name of a security group.
", + "RemoveTagsFromResourceMessage$ResourceName": "The DB Instance the tags will be removed from.
", + "ReservedDBInstance$ReservedDBInstanceId": "The unique identifier for the reservation.
", + "ReservedDBInstance$ReservedDBInstancesOfferingId": "The offering identifier.
", + "ReservedDBInstance$DBInstanceClass": "The DB instance class for the reserved DB Instance.
", + "ReservedDBInstance$CurrencyCode": "The currency code for the reserved DB Instance.
", + "ReservedDBInstance$ProductDescription": "The description of the reserved DB Instance.
", + "ReservedDBInstance$OfferingType": "The offering type of this reserved DB Instance.
", + "ReservedDBInstance$State": "The state of the reserved DB Instance.
", + "ReservedDBInstanceMessage$Marker": " An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The offering identifier.
", + "ReservedDBInstancesOffering$DBInstanceClass": "The DB instance class for the reserved DB Instance.
", + "ReservedDBInstancesOffering$CurrencyCode": "The currency code for the reserved DB Instance offering.
", + "ReservedDBInstancesOffering$ProductDescription": "The database engine used by the offering.
", + "ReservedDBInstancesOffering$OfferingType": "The offering type.
", + "ReservedDBInstancesOfferingMessage$Marker": " An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of the DB Parameter Group.
Constraints:
The identifier for the DB Snapshot to restore from.
Constraints:
Name of the DB Instance to create from the DB Snapshot. This parameter isn't case sensitive.
Constraints:
Example: my-snapshot-id
The compute and memory capacity of the Amazon RDS DB instance.
Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge
The EC2 Availability Zone that the database instance will be created in.
Default: A random, system-chosen Availability Zone.
Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.
Example: us-east-1a
The DB Subnet Group name to use for the new instance.
", + "RestoreDBInstanceFromDBSnapshotMessage$LicenseModel": "License model information for the restored DB Instance.
Default: Same as source.
Valid values: license-included | bring-your-own-license | general-public-license
The database name for the restored DB Instance.
This parameter doesn't apply to the MySQL engine.
The database engine to use for the new instance.
Default: The same as source
Constraint: Must be compatible with the engine of the source
Example: oracle-ee
The identifier of the source DB Instance from which to restore.
Constraints:
The name of the new database instance to be created.
Constraints:
The compute and memory capacity of the Amazon RDS DB instance.
Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge
Default: The same DBInstanceClass as the original DB Instance.
", + "RestoreDBInstanceToPointInTimeMessage$AvailabilityZone": "The EC2 Availability Zone that the database instance will be created in.
Default: A random, system-chosen Availability Zone.
Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.
Example: us-east-1a
The DB subnet group name to use for the new instance.
", + "RestoreDBInstanceToPointInTimeMessage$LicenseModel": "License model information for the restored DB Instance.
Default: Same as source.
Valid values: license-included | bring-your-own-license | general-public-license
The database name for the restored DB Instance.
This parameter is not used for the MySQL engine.
The database engine to use for the new instance.
Default: The same as source
Constraint: Must be compatible with the engine of the source
Example: oracle-ee
The name of the DB Security Group to revoke ingress from.
", + "RevokeDBSecurityGroupIngressMessage$CIDRIP": " The IP range to revoke access from. Must be a valid CIDR range. If CIDRIP is specified, EC2SecurityGroupName, EC2SecurityGroupId and EC2SecurityGroupOwnerId cannot be provided.
The name of the EC2 Security Group to revoke access from. For VPC DB Security Groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
The id of the EC2 Security Group to revoke access from. For VPC DB Security Groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
The AWS Account Number of the owner of the EC2 security group specified in the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value. For VPC DB Security Groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
Specifies the identifier of the subnet.
", + "Subnet$SubnetStatus": "Specifies the status of the subnet.
", + "SubnetIdentifierList$member": null, + "Tag$Key": "A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and cannot be prefixed with \"aws:\". The string may only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").
", + "Tag$Value": "A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and cannot be prefixed with \"aws:\". The string may only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").
", + "VpcSecurityGroupIdList$member": null, + "VpcSecurityGroupMembership$VpcSecurityGroupId": "The name of the VPC security group.
", + "VpcSecurityGroupMembership$Status": "The status of the VPC Security Group.
" + } + }, + "Subnet": { + "base": "This data type is used as a response element in the DescribeDBSubnetGroups action.
", + "refs": { + "SubnetList$member": null + } + }, + "SubnetAlreadyInUse": { + "base": "The DB subnet is already in use in the Availability Zone.
", + "refs": { + } + }, + "SubnetIdentifierList": { + "base": null, + "refs": { + "CreateDBSubnetGroupMessage$SubnetIds": "The EC2 Subnet IDs for the DB Subnet Group.
", + "ModifyDBSubnetGroupMessage$SubnetIds": "The EC2 Subnet IDs for the DB Subnet Group.
" + } + }, + "SubnetList": { + "base": null, + "refs": { + "DBSubnetGroup$Subnets": "Contains a list of Subnet elements.
" + } + }, + "SubscriptionAlreadyExistFault": { + "base": "The supplied subscription name already exists.
", + "refs": { + } + }, + "SubscriptionCategoryNotFoundFault": { + "base": "The supplied category does not exist.
", + "refs": { + } + }, + "SubscriptionNotFoundFault": { + "base": "The subscription name does not exist.
", + "refs": { + } + }, + "SupportedCharacterSetsList": { + "base": null, + "refs": { + "DBEngineVersion$SupportedCharacterSets": " A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance API.
Provides the date and time the DB Instance was created.
", + "DBInstance$LatestRestorableTime": "Specifies the latest time to which a database can be restored with point-in-time restore.
", + "DBSnapshot$SnapshotCreateTime": "Provides the time (UTC) when the snapshot was taken.
", + "DBSnapshot$InstanceCreateTime": "Specifies the time (UTC) when the snapshot was taken.
", + "DescribeEventsMessage$StartTime": "The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2009-07-08T18:00Z
", + "DescribeEventsMessage$EndTime": "The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2009-07-08T18:00Z
", + "Event$Date": "Specifies the date and time of the event.
", + "ReservedDBInstance$StartTime": "The time the reservation started.
", + "RestoreDBInstanceToPointInTimeMessage$RestoreTime": "The date and time to restore from.
Valid Values: Value must be a UTC time
Constraints:
Example: 2009-09-07T23:45:00Z
Metadata assigned to a DB Instance consisting of a key-value pair.
", + "refs": { + "TagList$member": null + } + }, + "TagList": { + "base": "A list of tags.
", + "refs": { + "AddTagsToResourceMessage$Tags": "The tags to be assigned to the DB Instance.
", + "TagListMessage$TagList": "List of tags returned by the ListTagsForResource operation.
" + } + }, + "TagListMessage": { + "base": "", + "refs": { + } + }, + "VpcSecurityGroupIdList": { + "base": null, + "refs": { + "CreateDBInstanceMessage$VpcSecurityGroupIds": "A list of EC2 VPC Security Groups to associate with this DB Instance.
Default: The default EC2 VPC Security Group for the DB Subnet group's VPC.
", + "ModifyDBInstanceMessage$VpcSecurityGroupIds": "A list of EC2 VPC Security Groups to authorize on this DB Instance. This change is asynchronously applied as soon as possible.
Constraints:
A list of VpcSecurityGroupMemebrship name strings used for this option.
" + } + }, + "VpcSecurityGroupMembership": { + "base": "This data type is used as a response element for queries on VPC security group membership.
", + "refs": { + "VpcSecurityGroupMembershipList$member": null + } + }, + "VpcSecurityGroupMembershipList": { + "base": null, + "refs": { + "DBInstance$VpcSecurityGroups": "Provides List of VPC security group elements that the DB Instance belongs to.
", + "Option$VpcSecurityGroupMemberships": "If the Option requires access to a port, then this VPC Security Group allows access to the port.
" + } + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/rds/2013-01-10/examples-1.json b/vendor/github.com/aws/aws-sdk-go/models/apis/rds/2013-01-10/examples-1.json new file mode 100644 index 000000000..0ea7e3b0b --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/rds/2013-01-10/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/rds/2013-01-10/paginators-1.json b/vendor/github.com/aws/aws-sdk-go/models/apis/rds/2013-01-10/paginators-1.json new file mode 100644 index 000000000..e70d762e0 --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/rds/2013-01-10/paginators-1.json @@ -0,0 +1,97 @@ +{ + "pagination": { + "DescribeDBEngineVersions": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "DBEngineVersions" + }, + "DescribeDBInstances": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "DBInstances" + }, + "DescribeDBParameterGroups": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "DBParameterGroups" + }, + "DescribeDBParameters": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "Parameters" + }, + "DescribeDBSecurityGroups": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "DBSecurityGroups" + }, + "DescribeDBSnapshots": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "DBSnapshots" + }, + "DescribeDBSubnetGroups": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "DBSubnetGroups" + }, + "DescribeEngineDefaultParameters": { + "input_token": "Marker", + "output_token": "EngineDefaults.Marker", + "limit_key": "MaxRecords", + "result_key": "EngineDefaults.Parameters" + }, + "DescribeEventSubscriptions": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "EventSubscriptionsList" + }, + "DescribeEvents": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "Events" + }, + "DescribeOptionGroupOptions": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "OptionGroupOptions" + }, + "DescribeOptionGroups": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "OptionGroupsList" + }, + "DescribeOrderableDBInstanceOptions": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "OrderableDBInstanceOptions" + }, + "DescribeReservedDBInstances": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "ReservedDBInstances" + }, + "DescribeReservedDBInstancesOfferings": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "ReservedDBInstancesOfferings" + }, + "ListTagsForResource": { + "result_key": "TagList" + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/rds/2013-02-12/api-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/rds/2013-02-12/api-2.json new file mode 100644 index 000000000..50bb7e4ce --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/rds/2013-02-12/api-2.json @@ -0,0 +1,3057 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2013-02-12", + "endpointPrefix":"rds", + "protocol":"query", + "serviceAbbreviation":"Amazon RDS", + "serviceFullName":"Amazon Relational Database Service", + "signatureVersion":"v4", + "xmlNamespace":"http://rds.amazonaws.com/doc/2013-02-12/" + }, + "operations":{ + "AddSourceIdentifierToSubscription":{ + "name":"AddSourceIdentifierToSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddSourceIdentifierToSubscriptionMessage"}, + "output":{ + "shape":"AddSourceIdentifierToSubscriptionResult", + "resultWrapper":"AddSourceIdentifierToSubscriptionResult" + }, + "errors":[ + {"shape":"SubscriptionNotFoundFault"}, + {"shape":"SourceNotFoundFault"} + ] + }, + "AddTagsToResource":{ + "name":"AddTagsToResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddTagsToResourceMessage"}, + "errors":[ + {"shape":"DBInstanceNotFoundFault"}, + {"shape":"DBSnapshotNotFoundFault"} + ] + }, + "AuthorizeDBSecurityGroupIngress":{ + "name":"AuthorizeDBSecurityGroupIngress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AuthorizeDBSecurityGroupIngressMessage"}, + "output":{ + "shape":"AuthorizeDBSecurityGroupIngressResult", + "resultWrapper":"AuthorizeDBSecurityGroupIngressResult" + }, + "errors":[ + {"shape":"DBSecurityGroupNotFoundFault"}, + {"shape":"InvalidDBSecurityGroupStateFault"}, + {"shape":"AuthorizationAlreadyExistsFault"}, + {"shape":"AuthorizationQuotaExceededFault"} + ] + }, + "CopyDBSnapshot":{ + "name":"CopyDBSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CopyDBSnapshotMessage"}, + "output":{ + "shape":"CopyDBSnapshotResult", + "resultWrapper":"CopyDBSnapshotResult" + }, + "errors":[ + {"shape":"DBSnapshotAlreadyExistsFault"}, + {"shape":"DBSnapshotNotFoundFault"}, + {"shape":"InvalidDBSnapshotStateFault"}, + {"shape":"SnapshotQuotaExceededFault"} + ] + }, + "CreateDBInstance":{ + "name":"CreateDBInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDBInstanceMessage"}, + "output":{ + "shape":"CreateDBInstanceResult", + "resultWrapper":"CreateDBInstanceResult" + }, + "errors":[ + {"shape":"DBInstanceAlreadyExistsFault"}, + {"shape":"InsufficientDBInstanceCapacityFault"}, + {"shape":"DBParameterGroupNotFoundFault"}, + {"shape":"DBSecurityGroupNotFoundFault"}, + {"shape":"InstanceQuotaExceededFault"}, + {"shape":"StorageQuotaExceededFault"}, + {"shape":"DBSubnetGroupNotFoundFault"}, + {"shape":"DBSubnetGroupDoesNotCoverEnoughAZs"}, + {"shape":"InvalidSubnet"}, + {"shape":"InvalidVPCNetworkStateFault"}, + {"shape":"ProvisionedIopsNotAvailableInAZFault"}, + {"shape":"OptionGroupNotFoundFault"} + ] + }, + "CreateDBInstanceReadReplica":{ + "name":"CreateDBInstanceReadReplica", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDBInstanceReadReplicaMessage"}, + "output":{ + "shape":"CreateDBInstanceReadReplicaResult", + "resultWrapper":"CreateDBInstanceReadReplicaResult" + }, + "errors":[ + {"shape":"DBInstanceAlreadyExistsFault"}, + {"shape":"InsufficientDBInstanceCapacityFault"}, + {"shape":"DBParameterGroupNotFoundFault"}, + {"shape":"DBSecurityGroupNotFoundFault"}, + {"shape":"InstanceQuotaExceededFault"}, + {"shape":"StorageQuotaExceededFault"}, + {"shape":"DBInstanceNotFoundFault"}, + {"shape":"InvalidDBInstanceStateFault"}, + {"shape":"DBSubnetGroupNotFoundFault"}, + {"shape":"DBSubnetGroupDoesNotCoverEnoughAZs"}, + {"shape":"InvalidSubnet"}, + {"shape":"InvalidVPCNetworkStateFault"}, + {"shape":"ProvisionedIopsNotAvailableInAZFault"}, + {"shape":"OptionGroupNotFoundFault"} + ] + }, + "CreateDBParameterGroup":{ + "name":"CreateDBParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDBParameterGroupMessage"}, + "output":{ + "shape":"CreateDBParameterGroupResult", + "resultWrapper":"CreateDBParameterGroupResult" + }, + "errors":[ + {"shape":"DBParameterGroupQuotaExceededFault"}, + {"shape":"DBParameterGroupAlreadyExistsFault"} + ] + }, + "CreateDBSecurityGroup":{ + "name":"CreateDBSecurityGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDBSecurityGroupMessage"}, + "output":{ + "shape":"CreateDBSecurityGroupResult", + "resultWrapper":"CreateDBSecurityGroupResult" + }, + "errors":[ + {"shape":"DBSecurityGroupAlreadyExistsFault"}, + {"shape":"DBSecurityGroupQuotaExceededFault"}, + {"shape":"DBSecurityGroupNotSupportedFault"} + ] + }, + "CreateDBSnapshot":{ + "name":"CreateDBSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDBSnapshotMessage"}, + "output":{ + "shape":"CreateDBSnapshotResult", + "resultWrapper":"CreateDBSnapshotResult" + }, + "errors":[ + {"shape":"DBSnapshotAlreadyExistsFault"}, + {"shape":"InvalidDBInstanceStateFault"}, + {"shape":"DBInstanceNotFoundFault"}, + {"shape":"SnapshotQuotaExceededFault"} + ] + }, + "CreateDBSubnetGroup":{ + "name":"CreateDBSubnetGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDBSubnetGroupMessage"}, + "output":{ + "shape":"CreateDBSubnetGroupResult", + "resultWrapper":"CreateDBSubnetGroupResult" + }, + "errors":[ + {"shape":"DBSubnetGroupAlreadyExistsFault"}, + {"shape":"DBSubnetGroupQuotaExceededFault"}, + {"shape":"DBSubnetQuotaExceededFault"}, + {"shape":"DBSubnetGroupDoesNotCoverEnoughAZs"}, + {"shape":"InvalidSubnet"} + ] + }, + "CreateEventSubscription":{ + "name":"CreateEventSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateEventSubscriptionMessage"}, + "output":{ + "shape":"CreateEventSubscriptionResult", + "resultWrapper":"CreateEventSubscriptionResult" + }, + "errors":[ + {"shape":"EventSubscriptionQuotaExceededFault"}, + {"shape":"SubscriptionAlreadyExistFault"}, + {"shape":"SNSInvalidTopicFault"}, + {"shape":"SNSNoAuthorizationFault"}, + {"shape":"SNSTopicArnNotFoundFault"}, + {"shape":"SubscriptionCategoryNotFoundFault"}, + {"shape":"SourceNotFoundFault"} + ] + }, + "CreateOptionGroup":{ + "name":"CreateOptionGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateOptionGroupMessage"}, + "output":{ + "shape":"CreateOptionGroupResult", + "resultWrapper":"CreateOptionGroupResult" + }, + "errors":[ + {"shape":"OptionGroupAlreadyExistsFault"}, + {"shape":"OptionGroupQuotaExceededFault"} + ] + }, + "DeleteDBInstance":{ + "name":"DeleteDBInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDBInstanceMessage"}, + "output":{ + "shape":"DeleteDBInstanceResult", + "resultWrapper":"DeleteDBInstanceResult" + }, + "errors":[ + {"shape":"DBInstanceNotFoundFault"}, + {"shape":"InvalidDBInstanceStateFault"}, + {"shape":"DBSnapshotAlreadyExistsFault"}, + {"shape":"SnapshotQuotaExceededFault"} + ] + }, + "DeleteDBParameterGroup":{ + "name":"DeleteDBParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDBParameterGroupMessage"}, + "errors":[ + {"shape":"InvalidDBParameterGroupStateFault"}, + {"shape":"DBParameterGroupNotFoundFault"} + ] + }, + "DeleteDBSecurityGroup":{ + "name":"DeleteDBSecurityGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDBSecurityGroupMessage"}, + "errors":[ + {"shape":"InvalidDBSecurityGroupStateFault"}, + {"shape":"DBSecurityGroupNotFoundFault"} + ] + }, + "DeleteDBSnapshot":{ + "name":"DeleteDBSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDBSnapshotMessage"}, + "output":{ + "shape":"DeleteDBSnapshotResult", + "resultWrapper":"DeleteDBSnapshotResult" + }, + "errors":[ + {"shape":"InvalidDBSnapshotStateFault"}, + {"shape":"DBSnapshotNotFoundFault"} + ] + }, + "DeleteDBSubnetGroup":{ + "name":"DeleteDBSubnetGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDBSubnetGroupMessage"}, + "errors":[ + {"shape":"InvalidDBSubnetGroupStateFault"}, + {"shape":"InvalidDBSubnetStateFault"}, + {"shape":"DBSubnetGroupNotFoundFault"} + ] + }, + "DeleteEventSubscription":{ + "name":"DeleteEventSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteEventSubscriptionMessage"}, + "output":{ + "shape":"DeleteEventSubscriptionResult", + "resultWrapper":"DeleteEventSubscriptionResult" + }, + "errors":[ + {"shape":"SubscriptionNotFoundFault"}, + {"shape":"InvalidEventSubscriptionStateFault"} + ] + }, + "DeleteOptionGroup":{ + "name":"DeleteOptionGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteOptionGroupMessage"}, + "errors":[ + {"shape":"OptionGroupNotFoundFault"}, + {"shape":"InvalidOptionGroupStateFault"} + ] + }, + "DescribeDBEngineVersions":{ + "name":"DescribeDBEngineVersions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBEngineVersionsMessage"}, + "output":{ + "shape":"DBEngineVersionMessage", + "resultWrapper":"DescribeDBEngineVersionsResult" + } + }, + "DescribeDBInstances":{ + "name":"DescribeDBInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBInstancesMessage"}, + "output":{ + "shape":"DBInstanceMessage", + "resultWrapper":"DescribeDBInstancesResult" + }, + "errors":[ + {"shape":"DBInstanceNotFoundFault"} + ] + }, + "DescribeDBLogFiles":{ + "name":"DescribeDBLogFiles", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBLogFilesMessage"}, + "output":{ + "shape":"DescribeDBLogFilesResponse", + "resultWrapper":"DescribeDBLogFilesResult" + }, + "errors":[ + {"shape":"DBInstanceNotFoundFault"} + ] + }, + "DescribeDBParameterGroups":{ + "name":"DescribeDBParameterGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBParameterGroupsMessage"}, + "output":{ + "shape":"DBParameterGroupsMessage", + "resultWrapper":"DescribeDBParameterGroupsResult" + }, + "errors":[ + {"shape":"DBParameterGroupNotFoundFault"} + ] + }, + "DescribeDBParameters":{ + "name":"DescribeDBParameters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBParametersMessage"}, + "output":{ + "shape":"DBParameterGroupDetails", + "resultWrapper":"DescribeDBParametersResult" + }, + "errors":[ + {"shape":"DBParameterGroupNotFoundFault"} + ] + }, + "DescribeDBSecurityGroups":{ + "name":"DescribeDBSecurityGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBSecurityGroupsMessage"}, + "output":{ + "shape":"DBSecurityGroupMessage", + "resultWrapper":"DescribeDBSecurityGroupsResult" + }, + "errors":[ + {"shape":"DBSecurityGroupNotFoundFault"} + ] + }, + "DescribeDBSnapshots":{ + "name":"DescribeDBSnapshots", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBSnapshotsMessage"}, + "output":{ + "shape":"DBSnapshotMessage", + "resultWrapper":"DescribeDBSnapshotsResult" + }, + "errors":[ + {"shape":"DBSnapshotNotFoundFault"} + ] + }, + "DescribeDBSubnetGroups":{ + "name":"DescribeDBSubnetGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBSubnetGroupsMessage"}, + "output":{ + "shape":"DBSubnetGroupMessage", + "resultWrapper":"DescribeDBSubnetGroupsResult" + }, + "errors":[ + {"shape":"DBSubnetGroupNotFoundFault"} + ] + }, + "DescribeEngineDefaultParameters":{ + "name":"DescribeEngineDefaultParameters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEngineDefaultParametersMessage"}, + "output":{ + "shape":"DescribeEngineDefaultParametersResult", + "resultWrapper":"DescribeEngineDefaultParametersResult" + } + }, + "DescribeEventCategories":{ + "name":"DescribeEventCategories", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEventCategoriesMessage"}, + "output":{ + "shape":"EventCategoriesMessage", + "resultWrapper":"DescribeEventCategoriesResult" + } + }, + "DescribeEventSubscriptions":{ + "name":"DescribeEventSubscriptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEventSubscriptionsMessage"}, + "output":{ + "shape":"EventSubscriptionsMessage", + "resultWrapper":"DescribeEventSubscriptionsResult" + }, + "errors":[ + {"shape":"SubscriptionNotFoundFault"} + ] + }, + "DescribeEvents":{ + "name":"DescribeEvents", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEventsMessage"}, + "output":{ + "shape":"EventsMessage", + "resultWrapper":"DescribeEventsResult" + } + }, + "DescribeOptionGroupOptions":{ + "name":"DescribeOptionGroupOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeOptionGroupOptionsMessage"}, + "output":{ + "shape":"OptionGroupOptionsMessage", + "resultWrapper":"DescribeOptionGroupOptionsResult" + } + }, + "DescribeOptionGroups":{ + "name":"DescribeOptionGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeOptionGroupsMessage"}, + "output":{ + "shape":"OptionGroups", + "resultWrapper":"DescribeOptionGroupsResult" + }, + "errors":[ + {"shape":"OptionGroupNotFoundFault"} + ] + }, + "DescribeOrderableDBInstanceOptions":{ + "name":"DescribeOrderableDBInstanceOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeOrderableDBInstanceOptionsMessage"}, + "output":{ + "shape":"OrderableDBInstanceOptionsMessage", + "resultWrapper":"DescribeOrderableDBInstanceOptionsResult" + } + }, + "DescribeReservedDBInstances":{ + "name":"DescribeReservedDBInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeReservedDBInstancesMessage"}, + "output":{ + "shape":"ReservedDBInstanceMessage", + "resultWrapper":"DescribeReservedDBInstancesResult" + }, + "errors":[ + {"shape":"ReservedDBInstanceNotFoundFault"} + ] + }, + "DescribeReservedDBInstancesOfferings":{ + "name":"DescribeReservedDBInstancesOfferings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeReservedDBInstancesOfferingsMessage"}, + "output":{ + "shape":"ReservedDBInstancesOfferingMessage", + "resultWrapper":"DescribeReservedDBInstancesOfferingsResult" + }, + "errors":[ + {"shape":"ReservedDBInstancesOfferingNotFoundFault"} + ] + }, + "DownloadDBLogFilePortion":{ + "name":"DownloadDBLogFilePortion", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DownloadDBLogFilePortionMessage"}, + "output":{ + "shape":"DownloadDBLogFilePortionDetails", + "resultWrapper":"DownloadDBLogFilePortionResult" + }, + "errors":[ + {"shape":"DBInstanceNotFoundFault"}, + {"shape":"DBLogFileNotFoundFault"} + ] + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForResourceMessage"}, + "output":{ + "shape":"TagListMessage", + "resultWrapper":"ListTagsForResourceResult" + }, + "errors":[ + {"shape":"DBInstanceNotFoundFault"}, + {"shape":"DBSnapshotNotFoundFault"} + ] + }, + "ModifyDBInstance":{ + "name":"ModifyDBInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyDBInstanceMessage"}, + "output":{ + "shape":"ModifyDBInstanceResult", + "resultWrapper":"ModifyDBInstanceResult" + }, + "errors":[ + {"shape":"InvalidDBInstanceStateFault"}, + {"shape":"InvalidDBSecurityGroupStateFault"}, + {"shape":"DBInstanceAlreadyExistsFault"}, + {"shape":"DBInstanceNotFoundFault"}, + {"shape":"DBSecurityGroupNotFoundFault"}, + {"shape":"DBParameterGroupNotFoundFault"}, + {"shape":"InsufficientDBInstanceCapacityFault"}, + {"shape":"StorageQuotaExceededFault"}, + {"shape":"InvalidVPCNetworkStateFault"}, + {"shape":"ProvisionedIopsNotAvailableInAZFault"}, + {"shape":"OptionGroupNotFoundFault"}, + {"shape":"DBUpgradeDependencyFailureFault"} + ] + }, + "ModifyDBParameterGroup":{ + "name":"ModifyDBParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyDBParameterGroupMessage"}, + "output":{ + "shape":"DBParameterGroupNameMessage", + "resultWrapper":"ModifyDBParameterGroupResult" + }, + "errors":[ + {"shape":"DBParameterGroupNotFoundFault"}, + {"shape":"InvalidDBParameterGroupStateFault"} + ] + }, + "ModifyDBSubnetGroup":{ + "name":"ModifyDBSubnetGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyDBSubnetGroupMessage"}, + "output":{ + "shape":"ModifyDBSubnetGroupResult", + "resultWrapper":"ModifyDBSubnetGroupResult" + }, + "errors":[ + {"shape":"DBSubnetGroupNotFoundFault"}, + {"shape":"DBSubnetQuotaExceededFault"}, + {"shape":"SubnetAlreadyInUse"}, + {"shape":"DBSubnetGroupDoesNotCoverEnoughAZs"}, + {"shape":"InvalidSubnet"} + ] + }, + "ModifyEventSubscription":{ + "name":"ModifyEventSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyEventSubscriptionMessage"}, + "output":{ + "shape":"ModifyEventSubscriptionResult", + "resultWrapper":"ModifyEventSubscriptionResult" + }, + "errors":[ + {"shape":"EventSubscriptionQuotaExceededFault"}, + {"shape":"SubscriptionNotFoundFault"}, + {"shape":"SNSInvalidTopicFault"}, + {"shape":"SNSNoAuthorizationFault"}, + {"shape":"SNSTopicArnNotFoundFault"}, + {"shape":"SubscriptionCategoryNotFoundFault"} + ] + }, + "ModifyOptionGroup":{ + "name":"ModifyOptionGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyOptionGroupMessage"}, + "output":{ + "shape":"ModifyOptionGroupResult", + "resultWrapper":"ModifyOptionGroupResult" + }, + "errors":[ + {"shape":"InvalidOptionGroupStateFault"}, + {"shape":"OptionGroupNotFoundFault"} + ] + }, + "PromoteReadReplica":{ + "name":"PromoteReadReplica", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PromoteReadReplicaMessage"}, + "output":{ + "shape":"PromoteReadReplicaResult", + "resultWrapper":"PromoteReadReplicaResult" + }, + "errors":[ + {"shape":"InvalidDBInstanceStateFault"}, + {"shape":"DBInstanceNotFoundFault"} + ] + }, + "PurchaseReservedDBInstancesOffering":{ + "name":"PurchaseReservedDBInstancesOffering", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PurchaseReservedDBInstancesOfferingMessage"}, + "output":{ + "shape":"PurchaseReservedDBInstancesOfferingResult", + "resultWrapper":"PurchaseReservedDBInstancesOfferingResult" + }, + "errors":[ + {"shape":"ReservedDBInstancesOfferingNotFoundFault"}, + {"shape":"ReservedDBInstanceAlreadyExistsFault"}, + {"shape":"ReservedDBInstanceQuotaExceededFault"} + ] + }, + "RebootDBInstance":{ + "name":"RebootDBInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RebootDBInstanceMessage"}, + "output":{ + "shape":"RebootDBInstanceResult", + "resultWrapper":"RebootDBInstanceResult" + }, + "errors":[ + {"shape":"InvalidDBInstanceStateFault"}, + {"shape":"DBInstanceNotFoundFault"} + ] + }, + "RemoveSourceIdentifierFromSubscription":{ + "name":"RemoveSourceIdentifierFromSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RemoveSourceIdentifierFromSubscriptionMessage"}, + "output":{ + "shape":"RemoveSourceIdentifierFromSubscriptionResult", + "resultWrapper":"RemoveSourceIdentifierFromSubscriptionResult" + }, + "errors":[ + {"shape":"SubscriptionNotFoundFault"}, + {"shape":"SourceNotFoundFault"} + ] + }, + "RemoveTagsFromResource":{ + "name":"RemoveTagsFromResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RemoveTagsFromResourceMessage"}, + "errors":[ + {"shape":"DBInstanceNotFoundFault"}, + {"shape":"DBSnapshotNotFoundFault"} + ] + }, + "ResetDBParameterGroup":{ + "name":"ResetDBParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResetDBParameterGroupMessage"}, + "output":{ + "shape":"DBParameterGroupNameMessage", + "resultWrapper":"ResetDBParameterGroupResult" + }, + "errors":[ + {"shape":"InvalidDBParameterGroupStateFault"}, + {"shape":"DBParameterGroupNotFoundFault"} + ] + }, + "RestoreDBInstanceFromDBSnapshot":{ + "name":"RestoreDBInstanceFromDBSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RestoreDBInstanceFromDBSnapshotMessage"}, + "output":{ + "shape":"RestoreDBInstanceFromDBSnapshotResult", + "resultWrapper":"RestoreDBInstanceFromDBSnapshotResult" + }, + "errors":[ + {"shape":"DBInstanceAlreadyExistsFault"}, + {"shape":"DBSnapshotNotFoundFault"}, + {"shape":"InstanceQuotaExceededFault"}, + {"shape":"InsufficientDBInstanceCapacityFault"}, + {"shape":"InvalidDBSnapshotStateFault"}, + {"shape":"StorageQuotaExceededFault"}, + {"shape":"InvalidVPCNetworkStateFault"}, + {"shape":"InvalidRestoreFault"}, + {"shape":"DBSubnetGroupNotFoundFault"}, + {"shape":"DBSubnetGroupDoesNotCoverEnoughAZs"}, + {"shape":"InvalidSubnet"}, + {"shape":"ProvisionedIopsNotAvailableInAZFault"}, + {"shape":"OptionGroupNotFoundFault"} + ] + }, + "RestoreDBInstanceToPointInTime":{ + "name":"RestoreDBInstanceToPointInTime", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RestoreDBInstanceToPointInTimeMessage"}, + "output":{ + "shape":"RestoreDBInstanceToPointInTimeResult", + "resultWrapper":"RestoreDBInstanceToPointInTimeResult" + }, + "errors":[ + {"shape":"DBInstanceAlreadyExistsFault"}, + {"shape":"DBInstanceNotFoundFault"}, + {"shape":"InstanceQuotaExceededFault"}, + {"shape":"InsufficientDBInstanceCapacityFault"}, + {"shape":"InvalidDBInstanceStateFault"}, + {"shape":"PointInTimeRestoreNotEnabledFault"}, + {"shape":"StorageQuotaExceededFault"}, + {"shape":"InvalidVPCNetworkStateFault"}, + {"shape":"InvalidRestoreFault"}, + {"shape":"DBSubnetGroupNotFoundFault"}, + {"shape":"DBSubnetGroupDoesNotCoverEnoughAZs"}, + {"shape":"InvalidSubnet"}, + {"shape":"ProvisionedIopsNotAvailableInAZFault"}, + {"shape":"OptionGroupNotFoundFault"} + ] + }, + "RevokeDBSecurityGroupIngress":{ + "name":"RevokeDBSecurityGroupIngress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RevokeDBSecurityGroupIngressMessage"}, + "output":{ + "shape":"RevokeDBSecurityGroupIngressResult", + "resultWrapper":"RevokeDBSecurityGroupIngressResult" + }, + "errors":[ + {"shape":"DBSecurityGroupNotFoundFault"}, + {"shape":"AuthorizationNotFoundFault"}, + {"shape":"InvalidDBSecurityGroupStateFault"} + ] + } + }, + "shapes":{ + "AddSourceIdentifierToSubscriptionMessage":{ + "type":"structure", + "required":[ + "SubscriptionName", + "SourceIdentifier" + ], + "members":{ + "SubscriptionName":{"shape":"String"}, + "SourceIdentifier":{"shape":"String"} + } + }, + "AddSourceIdentifierToSubscriptionResult":{ + "type":"structure", + "members":{ + "EventSubscription":{"shape":"EventSubscription"} + } + }, + "AddTagsToResourceMessage":{ + "type":"structure", + "required":[ + "ResourceName", + "Tags" + ], + "members":{ + "ResourceName":{"shape":"String"}, + "Tags":{"shape":"TagList"} + } + }, + "ApplyMethod":{ + "type":"string", + "enum":[ + "immediate", + "pending-reboot" + ] + }, + "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 + }, + "AuthorizationQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"AuthorizationQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "AuthorizeDBSecurityGroupIngressMessage":{ + "type":"structure", + "required":["DBSecurityGroupName"], + "members":{ + "DBSecurityGroupName":{"shape":"String"}, + "CIDRIP":{"shape":"String"}, + "EC2SecurityGroupName":{"shape":"String"}, + "EC2SecurityGroupId":{"shape":"String"}, + "EC2SecurityGroupOwnerId":{"shape":"String"} + } + }, + "AuthorizeDBSecurityGroupIngressResult":{ + "type":"structure", + "members":{ + "DBSecurityGroup":{"shape":"DBSecurityGroup"} + } + }, + "AvailabilityZone":{ + "type":"structure", + "members":{ + "Name":{"shape":"String"}, + "ProvisionedIopsCapable":{"shape":"Boolean"} + }, + "wrapper":true + }, + "AvailabilityZoneList":{ + "type":"list", + "member":{ + "shape":"AvailabilityZone", + "locationName":"AvailabilityZone" + } + }, + "Boolean":{"type":"boolean"}, + "BooleanOptional":{"type":"boolean"}, + "CharacterSet":{ + "type":"structure", + "members":{ + "CharacterSetName":{"shape":"String"}, + "CharacterSetDescription":{"shape":"String"} + } + }, + "CopyDBSnapshotMessage":{ + "type":"structure", + "required":[ + "SourceDBSnapshotIdentifier", + "TargetDBSnapshotIdentifier" + ], + "members":{ + "SourceDBSnapshotIdentifier":{"shape":"String"}, + "TargetDBSnapshotIdentifier":{"shape":"String"} + } + }, + "CopyDBSnapshotResult":{ + "type":"structure", + "members":{ + "DBSnapshot":{"shape":"DBSnapshot"} + } + }, + "CreateDBInstanceMessage":{ + "type":"structure", + "required":[ + "DBInstanceIdentifier", + "AllocatedStorage", + "DBInstanceClass", + "Engine", + "MasterUsername", + "MasterUserPassword" + ], + "members":{ + "DBName":{"shape":"String"}, + "DBInstanceIdentifier":{"shape":"String"}, + "AllocatedStorage":{"shape":"IntegerOptional"}, + "DBInstanceClass":{"shape":"String"}, + "Engine":{"shape":"String"}, + "MasterUsername":{"shape":"String"}, + "MasterUserPassword":{"shape":"String"}, + "DBSecurityGroups":{"shape":"DBSecurityGroupNameList"}, + "VpcSecurityGroupIds":{"shape":"VpcSecurityGroupIdList"}, + "AvailabilityZone":{"shape":"String"}, + "DBSubnetGroupName":{"shape":"String"}, + "PreferredMaintenanceWindow":{"shape":"String"}, + "DBParameterGroupName":{"shape":"String"}, + "BackupRetentionPeriod":{"shape":"IntegerOptional"}, + "PreferredBackupWindow":{"shape":"String"}, + "Port":{"shape":"IntegerOptional"}, + "MultiAZ":{"shape":"BooleanOptional"}, + "EngineVersion":{"shape":"String"}, + "AutoMinorVersionUpgrade":{"shape":"BooleanOptional"}, + "LicenseModel":{"shape":"String"}, + "Iops":{"shape":"IntegerOptional"}, + "OptionGroupName":{"shape":"String"}, + "CharacterSetName":{"shape":"String"}, + "PubliclyAccessible":{"shape":"BooleanOptional"} + } + }, + "CreateDBInstanceReadReplicaMessage":{ + "type":"structure", + "required":[ + "DBInstanceIdentifier", + "SourceDBInstanceIdentifier" + ], + "members":{ + "DBInstanceIdentifier":{"shape":"String"}, + "SourceDBInstanceIdentifier":{"shape":"String"}, + "DBInstanceClass":{"shape":"String"}, + "AvailabilityZone":{"shape":"String"}, + "Port":{"shape":"IntegerOptional"}, + "AutoMinorVersionUpgrade":{"shape":"BooleanOptional"}, + "Iops":{"shape":"IntegerOptional"}, + "OptionGroupName":{"shape":"String"}, + "PubliclyAccessible":{"shape":"BooleanOptional"} + } + }, + "CreateDBInstanceReadReplicaResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "CreateDBInstanceResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "CreateDBParameterGroupMessage":{ + "type":"structure", + "required":[ + "DBParameterGroupName", + "DBParameterGroupFamily", + "Description" + ], + "members":{ + "DBParameterGroupName":{"shape":"String"}, + "DBParameterGroupFamily":{"shape":"String"}, + "Description":{"shape":"String"} + } + }, + "CreateDBParameterGroupResult":{ + "type":"structure", + "members":{ + "DBParameterGroup":{"shape":"DBParameterGroup"} + } + }, + "CreateDBSecurityGroupMessage":{ + "type":"structure", + "required":[ + "DBSecurityGroupName", + "DBSecurityGroupDescription" + ], + "members":{ + "DBSecurityGroupName":{"shape":"String"}, + "DBSecurityGroupDescription":{"shape":"String"} + } + }, + "CreateDBSecurityGroupResult":{ + "type":"structure", + "members":{ + "DBSecurityGroup":{"shape":"DBSecurityGroup"} + } + }, + "CreateDBSnapshotMessage":{ + "type":"structure", + "required":[ + "DBSnapshotIdentifier", + "DBInstanceIdentifier" + ], + "members":{ + "DBSnapshotIdentifier":{"shape":"String"}, + "DBInstanceIdentifier":{"shape":"String"} + } + }, + "CreateDBSnapshotResult":{ + "type":"structure", + "members":{ + "DBSnapshot":{"shape":"DBSnapshot"} + } + }, + "CreateDBSubnetGroupMessage":{ + "type":"structure", + "required":[ + "DBSubnetGroupName", + "DBSubnetGroupDescription", + "SubnetIds" + ], + "members":{ + "DBSubnetGroupName":{"shape":"String"}, + "DBSubnetGroupDescription":{"shape":"String"}, + "SubnetIds":{"shape":"SubnetIdentifierList"} + } + }, + "CreateDBSubnetGroupResult":{ + "type":"structure", + "members":{ + "DBSubnetGroup":{"shape":"DBSubnetGroup"} + } + }, + "CreateEventSubscriptionMessage":{ + "type":"structure", + "required":[ + "SubscriptionName", + "SnsTopicArn" + ], + "members":{ + "SubscriptionName":{"shape":"String"}, + "SnsTopicArn":{"shape":"String"}, + "SourceType":{"shape":"String"}, + "EventCategories":{"shape":"EventCategoriesList"}, + "SourceIds":{"shape":"SourceIdsList"}, + "Enabled":{"shape":"BooleanOptional"} + } + }, + "CreateEventSubscriptionResult":{ + "type":"structure", + "members":{ + "EventSubscription":{"shape":"EventSubscription"} + } + }, + "CreateOptionGroupMessage":{ + "type":"structure", + "required":[ + "OptionGroupName", + "EngineName", + "MajorEngineVersion", + "OptionGroupDescription" + ], + "members":{ + "OptionGroupName":{"shape":"String"}, + "EngineName":{"shape":"String"}, + "MajorEngineVersion":{"shape":"String"}, + "OptionGroupDescription":{"shape":"String"} + } + }, + "CreateOptionGroupResult":{ + "type":"structure", + "members":{ + "OptionGroup":{"shape":"OptionGroup"} + } + }, + "DBEngineVersion":{ + "type":"structure", + "members":{ + "Engine":{"shape":"String"}, + "EngineVersion":{"shape":"String"}, + "DBParameterGroupFamily":{"shape":"String"}, + "DBEngineDescription":{"shape":"String"}, + "DBEngineVersionDescription":{"shape":"String"}, + "DefaultCharacterSet":{"shape":"CharacterSet"}, + "SupportedCharacterSets":{"shape":"SupportedCharacterSetsList"} + } + }, + "DBEngineVersionList":{ + "type":"list", + "member":{ + "shape":"DBEngineVersion", + "locationName":"DBEngineVersion" + } + }, + "DBEngineVersionMessage":{ + "type":"structure", + "members":{ + "Marker":{"shape":"String"}, + "DBEngineVersions":{"shape":"DBEngineVersionList"} + } + }, + "DBInstance":{ + "type":"structure", + "members":{ + "DBInstanceIdentifier":{"shape":"String"}, + "DBInstanceClass":{"shape":"String"}, + "Engine":{"shape":"String"}, + "DBInstanceStatus":{"shape":"String"}, + "MasterUsername":{"shape":"String"}, + "DBName":{"shape":"String"}, + "Endpoint":{"shape":"Endpoint"}, + "AllocatedStorage":{"shape":"Integer"}, + "InstanceCreateTime":{"shape":"TStamp"}, + "PreferredBackupWindow":{"shape":"String"}, + "BackupRetentionPeriod":{"shape":"Integer"}, + "DBSecurityGroups":{"shape":"DBSecurityGroupMembershipList"}, + "VpcSecurityGroups":{"shape":"VpcSecurityGroupMembershipList"}, + "DBParameterGroups":{"shape":"DBParameterGroupStatusList"}, + "AvailabilityZone":{"shape":"String"}, + "DBSubnetGroup":{"shape":"DBSubnetGroup"}, + "PreferredMaintenanceWindow":{"shape":"String"}, + "PendingModifiedValues":{"shape":"PendingModifiedValues"}, + "LatestRestorableTime":{"shape":"TStamp"}, + "MultiAZ":{"shape":"Boolean"}, + "EngineVersion":{"shape":"String"}, + "AutoMinorVersionUpgrade":{"shape":"Boolean"}, + "ReadReplicaSourceDBInstanceIdentifier":{"shape":"String"}, + "ReadReplicaDBInstanceIdentifiers":{"shape":"ReadReplicaDBInstanceIdentifierList"}, + "LicenseModel":{"shape":"String"}, + "Iops":{"shape":"IntegerOptional"}, + "OptionGroupMemberships":{"shape":"OptionGroupMembershipList"}, + "CharacterSetName":{"shape":"String"}, + "SecondaryAvailabilityZone":{"shape":"String"}, + "PubliclyAccessible":{"shape":"Boolean"} + }, + "wrapper":true + }, + "DBInstanceAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBInstanceAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBInstanceList":{ + "type":"list", + "member":{ + "shape":"DBInstance", + "locationName":"DBInstance" + } + }, + "DBInstanceMessage":{ + "type":"structure", + "members":{ + "Marker":{"shape":"String"}, + "DBInstances":{"shape":"DBInstanceList"} + } + }, + "DBInstanceNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "DBLogFileNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBLogFileNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "DBParameterGroup":{ + "type":"structure", + "members":{ + "DBParameterGroupName":{"shape":"String"}, + "DBParameterGroupFamily":{"shape":"String"}, + "Description":{"shape":"String"} + }, + "wrapper":true + }, + "DBParameterGroupAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBParameterGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBParameterGroupDetails":{ + "type":"structure", + "members":{ + "Parameters":{"shape":"ParametersList"}, + "Marker":{"shape":"String"} + } + }, + "DBParameterGroupList":{ + "type":"list", + "member":{ + "shape":"DBParameterGroup", + "locationName":"DBParameterGroup" + } + }, + "DBParameterGroupNameMessage":{ + "type":"structure", + "members":{ + "DBParameterGroupName":{"shape":"String"} + } + }, + "DBParameterGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "DBParameterGroupQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBParameterGroupQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBParameterGroupStatus":{ + "type":"structure", + "members":{ + "DBParameterGroupName":{"shape":"String"}, + "ParameterApplyStatus":{"shape":"String"} + } + }, + "DBParameterGroupStatusList":{ + "type":"list", + "member":{ + "shape":"DBParameterGroupStatus", + "locationName":"DBParameterGroup" + } + }, + "DBParameterGroupsMessage":{ + "type":"structure", + "members":{ + "Marker":{"shape":"String"}, + "DBParameterGroups":{"shape":"DBParameterGroupList"} + } + }, + "DBSecurityGroup":{ + "type":"structure", + "members":{ + "OwnerId":{"shape":"String"}, + "DBSecurityGroupName":{"shape":"String"}, + "DBSecurityGroupDescription":{"shape":"String"}, + "VpcId":{"shape":"String"}, + "EC2SecurityGroups":{"shape":"EC2SecurityGroupList"}, + "IPRanges":{"shape":"IPRangeList"} + }, + "wrapper":true + }, + "DBSecurityGroupAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSecurityGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBSecurityGroupMembership":{ + "type":"structure", + "members":{ + "DBSecurityGroupName":{"shape":"String"}, + "Status":{"shape":"String"} + } + }, + "DBSecurityGroupMembershipList":{ + "type":"list", + "member":{ + "shape":"DBSecurityGroupMembership", + "locationName":"DBSecurityGroup" + } + }, + "DBSecurityGroupMessage":{ + "type":"structure", + "members":{ + "Marker":{"shape":"String"}, + "DBSecurityGroups":{"shape":"DBSecurityGroups"} + } + }, + "DBSecurityGroupNameList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"DBSecurityGroupName" + } + }, + "DBSecurityGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSecurityGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "DBSecurityGroupNotSupportedFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSecurityGroupNotSupported", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBSecurityGroupQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"QuotaExceeded.DBSecurityGroup", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBSecurityGroups":{ + "type":"list", + "member":{ + "shape":"DBSecurityGroup", + "locationName":"DBSecurityGroup" + } + }, + "DBSnapshot":{ + "type":"structure", + "members":{ + "DBSnapshotIdentifier":{"shape":"String"}, + "DBInstanceIdentifier":{"shape":"String"}, + "SnapshotCreateTime":{"shape":"TStamp"}, + "Engine":{"shape":"String"}, + "AllocatedStorage":{"shape":"Integer"}, + "Status":{"shape":"String"}, + "Port":{"shape":"Integer"}, + "AvailabilityZone":{"shape":"String"}, + "VpcId":{"shape":"String"}, + "InstanceCreateTime":{"shape":"TStamp"}, + "MasterUsername":{"shape":"String"}, + "EngineVersion":{"shape":"String"}, + "LicenseModel":{"shape":"String"}, + "SnapshotType":{"shape":"String"}, + "Iops":{"shape":"IntegerOptional"}, + "OptionGroupName":{"shape":"String"} + }, + "wrapper":true + }, + "DBSnapshotAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSnapshotAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBSnapshotList":{ + "type":"list", + "member":{ + "shape":"DBSnapshot", + "locationName":"DBSnapshot" + } + }, + "DBSnapshotMessage":{ + "type":"structure", + "members":{ + "Marker":{"shape":"String"}, + "DBSnapshots":{"shape":"DBSnapshotList"} + } + }, + "DBSnapshotNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSnapshotNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "DBSubnetGroup":{ + "type":"structure", + "members":{ + "DBSubnetGroupName":{"shape":"String"}, + "DBSubnetGroupDescription":{"shape":"String"}, + "VpcId":{"shape":"String"}, + "SubnetGroupStatus":{"shape":"String"}, + "Subnets":{"shape":"SubnetList"} + }, + "wrapper":true + }, + "DBSubnetGroupAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSubnetGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBSubnetGroupDoesNotCoverEnoughAZs":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSubnetGroupDoesNotCoverEnoughAZs", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBSubnetGroupMessage":{ + "type":"structure", + "members":{ + "Marker":{"shape":"String"}, + "DBSubnetGroups":{"shape":"DBSubnetGroups"} + } + }, + "DBSubnetGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSubnetGroupNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "DBSubnetGroupQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSubnetGroupQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBSubnetGroups":{ + "type":"list", + "member":{ + "shape":"DBSubnetGroup", + "locationName":"DBSubnetGroup" + } + }, + "DBSubnetQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSubnetQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBUpgradeDependencyFailureFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBUpgradeDependencyFailure", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DeleteDBInstanceMessage":{ + "type":"structure", + "required":["DBInstanceIdentifier"], + "members":{ + "DBInstanceIdentifier":{"shape":"String"}, + "SkipFinalSnapshot":{"shape":"Boolean"}, + "FinalDBSnapshotIdentifier":{"shape":"String"} + } + }, + "DeleteDBInstanceResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "DeleteDBParameterGroupMessage":{ + "type":"structure", + "required":["DBParameterGroupName"], + "members":{ + "DBParameterGroupName":{"shape":"String"} + } + }, + "DeleteDBSecurityGroupMessage":{ + "type":"structure", + "required":["DBSecurityGroupName"], + "members":{ + "DBSecurityGroupName":{"shape":"String"} + } + }, + "DeleteDBSnapshotMessage":{ + "type":"structure", + "required":["DBSnapshotIdentifier"], + "members":{ + "DBSnapshotIdentifier":{"shape":"String"} + } + }, + "DeleteDBSnapshotResult":{ + "type":"structure", + "members":{ + "DBSnapshot":{"shape":"DBSnapshot"} + } + }, + "DeleteDBSubnetGroupMessage":{ + "type":"structure", + "required":["DBSubnetGroupName"], + "members":{ + "DBSubnetGroupName":{"shape":"String"} + } + }, + "DeleteEventSubscriptionMessage":{ + "type":"structure", + "required":["SubscriptionName"], + "members":{ + "SubscriptionName":{"shape":"String"} + } + }, + "DeleteEventSubscriptionResult":{ + "type":"structure", + "members":{ + "EventSubscription":{"shape":"EventSubscription"} + } + }, + "DeleteOptionGroupMessage":{ + "type":"structure", + "required":["OptionGroupName"], + "members":{ + "OptionGroupName":{"shape":"String"} + } + }, + "DescribeDBEngineVersionsMessage":{ + "type":"structure", + "members":{ + "Engine":{"shape":"String"}, + "EngineVersion":{"shape":"String"}, + "DBParameterGroupFamily":{"shape":"String"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"}, + "DefaultOnly":{"shape":"Boolean"}, + "ListSupportedCharacterSets":{"shape":"BooleanOptional"} + } + }, + "DescribeDBInstancesMessage":{ + "type":"structure", + "members":{ + "DBInstanceIdentifier":{"shape":"String"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "DescribeDBLogFilesDetails":{ + "type":"structure", + "members":{ + "LogFileName":{"shape":"String"}, + "LastWritten":{"shape":"Long"}, + "Size":{"shape":"Long"} + } + }, + "DescribeDBLogFilesList":{ + "type":"list", + "member":{ + "shape":"DescribeDBLogFilesDetails", + "locationName":"DescribeDBLogFilesDetails" + } + }, + "DescribeDBLogFilesMessage":{ + "type":"structure", + "required":["DBInstanceIdentifier"], + "members":{ + "DBInstanceIdentifier":{"shape":"String"}, + "FilenameContains":{"shape":"String"}, + "FileLastWritten":{"shape":"Long"}, + "FileSize":{"shape":"Long"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "DescribeDBLogFilesResponse":{ + "type":"structure", + "members":{ + "DescribeDBLogFiles":{"shape":"DescribeDBLogFilesList"}, + "Marker":{"shape":"String"} + } + }, + "DescribeDBParameterGroupsMessage":{ + "type":"structure", + "members":{ + "DBParameterGroupName":{"shape":"String"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "DescribeDBParametersMessage":{ + "type":"structure", + "required":["DBParameterGroupName"], + "members":{ + "DBParameterGroupName":{"shape":"String"}, + "Source":{"shape":"String"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "DescribeDBSecurityGroupsMessage":{ + "type":"structure", + "members":{ + "DBSecurityGroupName":{"shape":"String"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "DescribeDBSnapshotsMessage":{ + "type":"structure", + "members":{ + "DBInstanceIdentifier":{"shape":"String"}, + "DBSnapshotIdentifier":{"shape":"String"}, + "SnapshotType":{"shape":"String"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "DescribeDBSubnetGroupsMessage":{ + "type":"structure", + "members":{ + "DBSubnetGroupName":{"shape":"String"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "DescribeEngineDefaultParametersMessage":{ + "type":"structure", + "required":["DBParameterGroupFamily"], + "members":{ + "DBParameterGroupFamily":{"shape":"String"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "DescribeEngineDefaultParametersResult":{ + "type":"structure", + "members":{ + "EngineDefaults":{"shape":"EngineDefaults"} + } + }, + "DescribeEventCategoriesMessage":{ + "type":"structure", + "members":{ + "SourceType":{"shape":"String"} + } + }, + "DescribeEventSubscriptionsMessage":{ + "type":"structure", + "members":{ + "SubscriptionName":{"shape":"String"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "DescribeEventsMessage":{ + "type":"structure", + "members":{ + "SourceIdentifier":{"shape":"String"}, + "SourceType":{"shape":"SourceType"}, + "StartTime":{"shape":"TStamp"}, + "EndTime":{"shape":"TStamp"}, + "Duration":{"shape":"IntegerOptional"}, + "EventCategories":{"shape":"EventCategoriesList"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "DescribeOptionGroupOptionsMessage":{ + "type":"structure", + "required":["EngineName"], + "members":{ + "EngineName":{"shape":"String"}, + "MajorEngineVersion":{"shape":"String"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "DescribeOptionGroupsMessage":{ + "type":"structure", + "members":{ + "OptionGroupName":{"shape":"String"}, + "Marker":{"shape":"String"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "EngineName":{"shape":"String"}, + "MajorEngineVersion":{"shape":"String"} + } + }, + "DescribeOrderableDBInstanceOptionsMessage":{ + "type":"structure", + "required":["Engine"], + "members":{ + "Engine":{"shape":"String"}, + "EngineVersion":{"shape":"String"}, + "DBInstanceClass":{"shape":"String"}, + "LicenseModel":{"shape":"String"}, + "Vpc":{"shape":"BooleanOptional"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "DescribeReservedDBInstancesMessage":{ + "type":"structure", + "members":{ + "ReservedDBInstanceId":{"shape":"String"}, + "ReservedDBInstancesOfferingId":{"shape":"String"}, + "DBInstanceClass":{"shape":"String"}, + "Duration":{"shape":"String"}, + "ProductDescription":{"shape":"String"}, + "OfferingType":{"shape":"String"}, + "MultiAZ":{"shape":"BooleanOptional"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "DescribeReservedDBInstancesOfferingsMessage":{ + "type":"structure", + "members":{ + "ReservedDBInstancesOfferingId":{"shape":"String"}, + "DBInstanceClass":{"shape":"String"}, + "Duration":{"shape":"String"}, + "ProductDescription":{"shape":"String"}, + "OfferingType":{"shape":"String"}, + "MultiAZ":{"shape":"BooleanOptional"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "Double":{"type":"double"}, + "DownloadDBLogFilePortionDetails":{ + "type":"structure", + "members":{ + "LogFileData":{"shape":"String"}, + "Marker":{"shape":"String"}, + "AdditionalDataPending":{"shape":"Boolean"} + } + }, + "DownloadDBLogFilePortionMessage":{ + "type":"structure", + "required":[ + "DBInstanceIdentifier", + "LogFileName" + ], + "members":{ + "DBInstanceIdentifier":{"shape":"String"}, + "LogFileName":{"shape":"String"}, + "Marker":{"shape":"String"}, + "NumberOfLines":{"shape":"Integer"} + } + }, + "EC2SecurityGroup":{ + "type":"structure", + "members":{ + "Status":{"shape":"String"}, + "EC2SecurityGroupName":{"shape":"String"}, + "EC2SecurityGroupId":{"shape":"String"}, + "EC2SecurityGroupOwnerId":{"shape":"String"} + } + }, + "EC2SecurityGroupList":{ + "type":"list", + "member":{ + "shape":"EC2SecurityGroup", + "locationName":"EC2SecurityGroup" + } + }, + "Endpoint":{ + "type":"structure", + "members":{ + "Address":{"shape":"String"}, + "Port":{"shape":"Integer"} + } + }, + "EngineDefaults":{ + "type":"structure", + "members":{ + "DBParameterGroupFamily":{"shape":"String"}, + "Marker":{"shape":"String"}, + "Parameters":{"shape":"ParametersList"} + }, + "wrapper":true + }, + "Event":{ + "type":"structure", + "members":{ + "SourceIdentifier":{"shape":"String"}, + "SourceType":{"shape":"SourceType"}, + "Message":{"shape":"String"}, + "EventCategories":{"shape":"EventCategoriesList"}, + "Date":{"shape":"TStamp"} + } + }, + "EventCategoriesList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"EventCategory" + } + }, + "EventCategoriesMap":{ + "type":"structure", + "members":{ + "SourceType":{"shape":"String"}, + "EventCategories":{"shape":"EventCategoriesList"} + }, + "wrapper":true + }, + "EventCategoriesMapList":{ + "type":"list", + "member":{ + "shape":"EventCategoriesMap", + "locationName":"EventCategoriesMap" + } + }, + "EventCategoriesMessage":{ + "type":"structure", + "members":{ + "EventCategoriesMapList":{"shape":"EventCategoriesMapList"} + } + }, + "EventList":{ + "type":"list", + "member":{ + "shape":"Event", + "locationName":"Event" + } + }, + "EventSubscription":{ + "type":"structure", + "members":{ + "CustomerAwsId":{"shape":"String"}, + "CustSubscriptionId":{"shape":"String"}, + "SnsTopicArn":{"shape":"String"}, + "Status":{"shape":"String"}, + "SubscriptionCreationTime":{"shape":"String"}, + "SourceType":{"shape":"String"}, + "SourceIdsList":{"shape":"SourceIdsList"}, + "EventCategoriesList":{"shape":"EventCategoriesList"}, + "Enabled":{"shape":"Boolean"} + }, + "wrapper":true + }, + "EventSubscriptionQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"EventSubscriptionQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "EventSubscriptionsList":{ + "type":"list", + "member":{ + "shape":"EventSubscription", + "locationName":"EventSubscription" + } + }, + "EventSubscriptionsMessage":{ + "type":"structure", + "members":{ + "Marker":{"shape":"String"}, + "EventSubscriptionsList":{"shape":"EventSubscriptionsList"} + } + }, + "EventsMessage":{ + "type":"structure", + "members":{ + "Marker":{"shape":"String"}, + "Events":{"shape":"EventList"} + } + }, + "IPRange":{ + "type":"structure", + "members":{ + "Status":{"shape":"String"}, + "CIDRIP":{"shape":"String"} + } + }, + "IPRangeList":{ + "type":"list", + "member":{ + "shape":"IPRange", + "locationName":"IPRange" + } + }, + "InstanceQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InstanceQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InsufficientDBInstanceCapacityFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InsufficientDBInstanceCapacity", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "Integer":{"type":"integer"}, + "IntegerOptional":{"type":"integer"}, + "InvalidDBInstanceStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidDBInstanceState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidDBParameterGroupStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidDBParameterGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidDBSecurityGroupStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidDBSecurityGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidDBSnapshotStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidDBSnapshotState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidDBSubnetGroupStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidDBSubnetGroupStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidDBSubnetStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidDBSubnetStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidEventSubscriptionStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidEventSubscriptionState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidOptionGroupStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidOptionGroupStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidRestoreFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidRestoreFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidSubnet":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidSubnet", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidVPCNetworkStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidVPCNetworkStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "KeyList":{ + "type":"list", + "member":{"shape":"String"} + }, + "ListTagsForResourceMessage":{ + "type":"structure", + "required":["ResourceName"], + "members":{ + "ResourceName":{"shape":"String"} + } + }, + "Long":{"type":"long"}, + "ModifyDBInstanceMessage":{ + "type":"structure", + "required":["DBInstanceIdentifier"], + "members":{ + "DBInstanceIdentifier":{"shape":"String"}, + "AllocatedStorage":{"shape":"IntegerOptional"}, + "DBInstanceClass":{"shape":"String"}, + "DBSecurityGroups":{"shape":"DBSecurityGroupNameList"}, + "VpcSecurityGroupIds":{"shape":"VpcSecurityGroupIdList"}, + "ApplyImmediately":{"shape":"Boolean"}, + "MasterUserPassword":{"shape":"String"}, + "DBParameterGroupName":{"shape":"String"}, + "BackupRetentionPeriod":{"shape":"IntegerOptional"}, + "PreferredBackupWindow":{"shape":"String"}, + "PreferredMaintenanceWindow":{"shape":"String"}, + "MultiAZ":{"shape":"BooleanOptional"}, + "EngineVersion":{"shape":"String"}, + "AllowMajorVersionUpgrade":{"shape":"Boolean"}, + "AutoMinorVersionUpgrade":{"shape":"BooleanOptional"}, + "Iops":{"shape":"IntegerOptional"}, + "OptionGroupName":{"shape":"String"}, + "NewDBInstanceIdentifier":{"shape":"String"} + } + }, + "ModifyDBInstanceResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "ModifyDBParameterGroupMessage":{ + "type":"structure", + "required":[ + "DBParameterGroupName", + "Parameters" + ], + "members":{ + "DBParameterGroupName":{"shape":"String"}, + "Parameters":{"shape":"ParametersList"} + } + }, + "ModifyDBSubnetGroupMessage":{ + "type":"structure", + "required":[ + "DBSubnetGroupName", + "SubnetIds" + ], + "members":{ + "DBSubnetGroupName":{"shape":"String"}, + "DBSubnetGroupDescription":{"shape":"String"}, + "SubnetIds":{"shape":"SubnetIdentifierList"} + } + }, + "ModifyDBSubnetGroupResult":{ + "type":"structure", + "members":{ + "DBSubnetGroup":{"shape":"DBSubnetGroup"} + } + }, + "ModifyEventSubscriptionMessage":{ + "type":"structure", + "required":["SubscriptionName"], + "members":{ + "SubscriptionName":{"shape":"String"}, + "SnsTopicArn":{"shape":"String"}, + "SourceType":{"shape":"String"}, + "EventCategories":{"shape":"EventCategoriesList"}, + "Enabled":{"shape":"BooleanOptional"} + } + }, + "ModifyEventSubscriptionResult":{ + "type":"structure", + "members":{ + "EventSubscription":{"shape":"EventSubscription"} + } + }, + "ModifyOptionGroupMessage":{ + "type":"structure", + "required":["OptionGroupName"], + "members":{ + "OptionGroupName":{"shape":"String"}, + "OptionsToInclude":{"shape":"OptionConfigurationList"}, + "OptionsToRemove":{"shape":"OptionNamesList"}, + "ApplyImmediately":{"shape":"Boolean"} + } + }, + "ModifyOptionGroupResult":{ + "type":"structure", + "members":{ + "OptionGroup":{"shape":"OptionGroup"} + } + }, + "Option":{ + "type":"structure", + "members":{ + "OptionName":{"shape":"String"}, + "OptionDescription":{"shape":"String"}, + "Persistent":{"shape":"Boolean"}, + "Port":{"shape":"IntegerOptional"}, + "OptionSettings":{"shape":"OptionSettingConfigurationList"}, + "DBSecurityGroupMemberships":{"shape":"DBSecurityGroupMembershipList"}, + "VpcSecurityGroupMemberships":{"shape":"VpcSecurityGroupMembershipList"} + } + }, + "OptionConfiguration":{ + "type":"structure", + "required":["OptionName"], + "members":{ + "OptionName":{"shape":"String"}, + "Port":{"shape":"IntegerOptional"}, + "DBSecurityGroupMemberships":{"shape":"DBSecurityGroupNameList"}, + "VpcSecurityGroupMemberships":{"shape":"VpcSecurityGroupIdList"}, + "OptionSettings":{"shape":"OptionSettingsList"} + } + }, + "OptionConfigurationList":{ + "type":"list", + "member":{ + "shape":"OptionConfiguration", + "locationName":"OptionConfiguration" + } + }, + "OptionGroup":{ + "type":"structure", + "members":{ + "OptionGroupName":{"shape":"String"}, + "OptionGroupDescription":{"shape":"String"}, + "EngineName":{"shape":"String"}, + "MajorEngineVersion":{"shape":"String"}, + "Options":{"shape":"OptionsList"}, + "AllowsVpcAndNonVpcInstanceMemberships":{"shape":"Boolean"}, + "VpcId":{"shape":"String"} + }, + "wrapper":true + }, + "OptionGroupAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"OptionGroupAlreadyExistsFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "OptionGroupMembership":{ + "type":"structure", + "members":{ + "OptionGroupName":{"shape":"String"}, + "Status":{"shape":"String"} + } + }, + "OptionGroupMembershipList":{ + "type":"list", + "member":{ + "shape":"OptionGroupMembership", + "locationName":"OptionGroupMembership" + } + }, + "OptionGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"OptionGroupNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "OptionGroupOption":{ + "type":"structure", + "members":{ + "Name":{"shape":"String"}, + "Description":{"shape":"String"}, + "EngineName":{"shape":"String"}, + "MajorEngineVersion":{"shape":"String"}, + "MinimumRequiredMinorEngineVersion":{"shape":"String"}, + "PortRequired":{"shape":"Boolean"}, + "DefaultPort":{"shape":"IntegerOptional"}, + "OptionsDependedOn":{"shape":"OptionsDependedOn"}, + "Persistent":{"shape":"Boolean"}, + "OptionGroupOptionSettings":{"shape":"OptionGroupOptionSettingsList"} + } + }, + "OptionGroupOptionSetting":{ + "type":"structure", + "members":{ + "SettingName":{"shape":"String"}, + "SettingDescription":{"shape":"String"}, + "DefaultValue":{"shape":"String"}, + "ApplyType":{"shape":"String"}, + "AllowedValues":{"shape":"String"}, + "IsModifiable":{"shape":"Boolean"} + } + }, + "OptionGroupOptionSettingsList":{ + "type":"list", + "member":{ + "shape":"OptionGroupOptionSetting", + "locationName":"OptionGroupOptionSetting" + } + }, + "OptionGroupOptionsList":{ + "type":"list", + "member":{ + "shape":"OptionGroupOption", + "locationName":"OptionGroupOption" + } + }, + "OptionGroupOptionsMessage":{ + "type":"structure", + "members":{ + "OptionGroupOptions":{"shape":"OptionGroupOptionsList"}, + "Marker":{"shape":"String"} + } + }, + "OptionGroupQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"OptionGroupQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "OptionGroups":{ + "type":"structure", + "members":{ + "OptionGroupsList":{"shape":"OptionGroupsList"}, + "Marker":{"shape":"String"} + } + }, + "OptionGroupsList":{ + "type":"list", + "member":{ + "shape":"OptionGroup", + "locationName":"OptionGroup" + } + }, + "OptionNamesList":{ + "type":"list", + "member":{"shape":"String"} + }, + "OptionSetting":{ + "type":"structure", + "members":{ + "Name":{"shape":"String"}, + "Value":{"shape":"String"}, + "DefaultValue":{"shape":"String"}, + "Description":{"shape":"String"}, + "ApplyType":{"shape":"String"}, + "DataType":{"shape":"String"}, + "AllowedValues":{"shape":"String"}, + "IsModifiable":{"shape":"Boolean"}, + "IsCollection":{"shape":"Boolean"} + } + }, + "OptionSettingConfigurationList":{ + "type":"list", + "member":{ + "shape":"OptionSetting", + "locationName":"OptionSetting" + } + }, + "OptionSettingsList":{ + "type":"list", + "member":{ + "shape":"OptionSetting", + "locationName":"OptionSetting" + } + }, + "OptionsDependedOn":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"OptionName" + } + }, + "OptionsList":{ + "type":"list", + "member":{ + "shape":"Option", + "locationName":"Option" + } + }, + "OrderableDBInstanceOption":{ + "type":"structure", + "members":{ + "Engine":{"shape":"String"}, + "EngineVersion":{"shape":"String"}, + "DBInstanceClass":{"shape":"String"}, + "LicenseModel":{"shape":"String"}, + "AvailabilityZones":{"shape":"AvailabilityZoneList"}, + "MultiAZCapable":{"shape":"Boolean"}, + "ReadReplicaCapable":{"shape":"Boolean"}, + "Vpc":{"shape":"Boolean"} + }, + "wrapper":true + }, + "OrderableDBInstanceOptionsList":{ + "type":"list", + "member":{ + "shape":"OrderableDBInstanceOption", + "locationName":"OrderableDBInstanceOption" + } + }, + "OrderableDBInstanceOptionsMessage":{ + "type":"structure", + "members":{ + "OrderableDBInstanceOptions":{"shape":"OrderableDBInstanceOptionsList"}, + "Marker":{"shape":"String"} + } + }, + "Parameter":{ + "type":"structure", + "members":{ + "ParameterName":{"shape":"String"}, + "ParameterValue":{"shape":"String"}, + "Description":{"shape":"String"}, + "Source":{"shape":"String"}, + "ApplyType":{"shape":"String"}, + "DataType":{"shape":"String"}, + "AllowedValues":{"shape":"String"}, + "IsModifiable":{"shape":"Boolean"}, + "MinimumEngineVersion":{"shape":"String"}, + "ApplyMethod":{"shape":"ApplyMethod"} + } + }, + "ParametersList":{ + "type":"list", + "member":{ + "shape":"Parameter", + "locationName":"Parameter" + } + }, + "PendingModifiedValues":{ + "type":"structure", + "members":{ + "DBInstanceClass":{"shape":"String"}, + "AllocatedStorage":{"shape":"IntegerOptional"}, + "MasterUserPassword":{"shape":"String"}, + "Port":{"shape":"IntegerOptional"}, + "BackupRetentionPeriod":{"shape":"IntegerOptional"}, + "MultiAZ":{"shape":"BooleanOptional"}, + "EngineVersion":{"shape":"String"}, + "Iops":{"shape":"IntegerOptional"}, + "DBInstanceIdentifier":{"shape":"String"} + } + }, + "PointInTimeRestoreNotEnabledFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"PointInTimeRestoreNotEnabled", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "PromoteReadReplicaMessage":{ + "type":"structure", + "required":["DBInstanceIdentifier"], + "members":{ + "DBInstanceIdentifier":{"shape":"String"}, + "BackupRetentionPeriod":{"shape":"IntegerOptional"}, + "PreferredBackupWindow":{"shape":"String"} + } + }, + "PromoteReadReplicaResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "ProvisionedIopsNotAvailableInAZFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ProvisionedIopsNotAvailableInAZFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "PurchaseReservedDBInstancesOfferingMessage":{ + "type":"structure", + "required":["ReservedDBInstancesOfferingId"], + "members":{ + "ReservedDBInstancesOfferingId":{"shape":"String"}, + "ReservedDBInstanceId":{"shape":"String"}, + "DBInstanceCount":{"shape":"IntegerOptional"} + } + }, + "PurchaseReservedDBInstancesOfferingResult":{ + "type":"structure", + "members":{ + "ReservedDBInstance":{"shape":"ReservedDBInstance"} + } + }, + "ReadReplicaDBInstanceIdentifierList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ReadReplicaDBInstanceIdentifier" + } + }, + "RebootDBInstanceMessage":{ + "type":"structure", + "required":["DBInstanceIdentifier"], + "members":{ + "DBInstanceIdentifier":{"shape":"String"}, + "ForceFailover":{"shape":"BooleanOptional"} + } + }, + "RebootDBInstanceResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "RecurringCharge":{ + "type":"structure", + "members":{ + "RecurringChargeAmount":{"shape":"Double"}, + "RecurringChargeFrequency":{"shape":"String"} + }, + "wrapper":true + }, + "RecurringChargeList":{ + "type":"list", + "member":{ + "shape":"RecurringCharge", + "locationName":"RecurringCharge" + } + }, + "RemoveSourceIdentifierFromSubscriptionMessage":{ + "type":"structure", + "required":[ + "SubscriptionName", + "SourceIdentifier" + ], + "members":{ + "SubscriptionName":{"shape":"String"}, + "SourceIdentifier":{"shape":"String"} + } + }, + "RemoveSourceIdentifierFromSubscriptionResult":{ + "type":"structure", + "members":{ + "EventSubscription":{"shape":"EventSubscription"} + } + }, + "RemoveTagsFromResourceMessage":{ + "type":"structure", + "required":[ + "ResourceName", + "TagKeys" + ], + "members":{ + "ResourceName":{"shape":"String"}, + "TagKeys":{"shape":"KeyList"} + } + }, + "ReservedDBInstance":{ + "type":"structure", + "members":{ + "ReservedDBInstanceId":{"shape":"String"}, + "ReservedDBInstancesOfferingId":{"shape":"String"}, + "DBInstanceClass":{"shape":"String"}, + "StartTime":{"shape":"TStamp"}, + "Duration":{"shape":"Integer"}, + "FixedPrice":{"shape":"Double"}, + "UsagePrice":{"shape":"Double"}, + "CurrencyCode":{"shape":"String"}, + "DBInstanceCount":{"shape":"Integer"}, + "ProductDescription":{"shape":"String"}, + "OfferingType":{"shape":"String"}, + "MultiAZ":{"shape":"Boolean"}, + "State":{"shape":"String"}, + "RecurringCharges":{"shape":"RecurringChargeList"} + }, + "wrapper":true + }, + "ReservedDBInstanceAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ReservedDBInstanceAlreadyExists", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ReservedDBInstanceList":{ + "type":"list", + "member":{ + "shape":"ReservedDBInstance", + "locationName":"ReservedDBInstance" + } + }, + "ReservedDBInstanceMessage":{ + "type":"structure", + "members":{ + "Marker":{"shape":"String"}, + "ReservedDBInstances":{"shape":"ReservedDBInstanceList"} + } + }, + "ReservedDBInstanceNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ReservedDBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ReservedDBInstanceQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ReservedDBInstanceQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ReservedDBInstancesOffering":{ + "type":"structure", + "members":{ + "ReservedDBInstancesOfferingId":{"shape":"String"}, + "DBInstanceClass":{"shape":"String"}, + "Duration":{"shape":"Integer"}, + "FixedPrice":{"shape":"Double"}, + "UsagePrice":{"shape":"Double"}, + "CurrencyCode":{"shape":"String"}, + "ProductDescription":{"shape":"String"}, + "OfferingType":{"shape":"String"}, + "MultiAZ":{"shape":"Boolean"}, + "RecurringCharges":{"shape":"RecurringChargeList"} + }, + "wrapper":true + }, + "ReservedDBInstancesOfferingList":{ + "type":"list", + "member":{ + "shape":"ReservedDBInstancesOffering", + "locationName":"ReservedDBInstancesOffering" + } + }, + "ReservedDBInstancesOfferingMessage":{ + "type":"structure", + "members":{ + "Marker":{"shape":"String"}, + "ReservedDBInstancesOfferings":{"shape":"ReservedDBInstancesOfferingList"} + } + }, + "ReservedDBInstancesOfferingNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ReservedDBInstancesOfferingNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ResetDBParameterGroupMessage":{ + "type":"structure", + "required":["DBParameterGroupName"], + "members":{ + "DBParameterGroupName":{"shape":"String"}, + "ResetAllParameters":{"shape":"Boolean"}, + "Parameters":{"shape":"ParametersList"} + } + }, + "RestoreDBInstanceFromDBSnapshotMessage":{ + "type":"structure", + "required":[ + "DBInstanceIdentifier", + "DBSnapshotIdentifier" + ], + "members":{ + "DBInstanceIdentifier":{"shape":"String"}, + "DBSnapshotIdentifier":{"shape":"String"}, + "DBInstanceClass":{"shape":"String"}, + "Port":{"shape":"IntegerOptional"}, + "AvailabilityZone":{"shape":"String"}, + "DBSubnetGroupName":{"shape":"String"}, + "MultiAZ":{"shape":"BooleanOptional"}, + "PubliclyAccessible":{"shape":"BooleanOptional"}, + "AutoMinorVersionUpgrade":{"shape":"BooleanOptional"}, + "LicenseModel":{"shape":"String"}, + "DBName":{"shape":"String"}, + "Engine":{"shape":"String"}, + "Iops":{"shape":"IntegerOptional"}, + "OptionGroupName":{"shape":"String"} + } + }, + "RestoreDBInstanceFromDBSnapshotResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "RestoreDBInstanceToPointInTimeMessage":{ + "type":"structure", + "required":[ + "SourceDBInstanceIdentifier", + "TargetDBInstanceIdentifier" + ], + "members":{ + "SourceDBInstanceIdentifier":{"shape":"String"}, + "TargetDBInstanceIdentifier":{"shape":"String"}, + "RestoreTime":{"shape":"TStamp"}, + "UseLatestRestorableTime":{"shape":"Boolean"}, + "DBInstanceClass":{"shape":"String"}, + "Port":{"shape":"IntegerOptional"}, + "AvailabilityZone":{"shape":"String"}, + "DBSubnetGroupName":{"shape":"String"}, + "MultiAZ":{"shape":"BooleanOptional"}, + "PubliclyAccessible":{"shape":"BooleanOptional"}, + "AutoMinorVersionUpgrade":{"shape":"BooleanOptional"}, + "LicenseModel":{"shape":"String"}, + "DBName":{"shape":"String"}, + "Engine":{"shape":"String"}, + "Iops":{"shape":"IntegerOptional"}, + "OptionGroupName":{"shape":"String"} + } + }, + "RestoreDBInstanceToPointInTimeResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "RevokeDBSecurityGroupIngressMessage":{ + "type":"structure", + "required":["DBSecurityGroupName"], + "members":{ + "DBSecurityGroupName":{"shape":"String"}, + "CIDRIP":{"shape":"String"}, + "EC2SecurityGroupName":{"shape":"String"}, + "EC2SecurityGroupId":{"shape":"String"}, + "EC2SecurityGroupOwnerId":{"shape":"String"} + } + }, + "RevokeDBSecurityGroupIngressResult":{ + "type":"structure", + "members":{ + "DBSecurityGroup":{"shape":"DBSecurityGroup"} + } + }, + "SNSInvalidTopicFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SNSInvalidTopic", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "SNSNoAuthorizationFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SNSNoAuthorization", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "SNSTopicArnNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SNSTopicArnNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "SnapshotQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SnapshotQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "SourceIdsList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SourceId" + } + }, + "SourceNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SourceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "SourceType":{ + "type":"string", + "enum":[ + "db-instance", + "db-parameter-group", + "db-security-group", + "db-snapshot" + ] + }, + "StorageQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"StorageQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "String":{"type":"string"}, + "Subnet":{ + "type":"structure", + "members":{ + "SubnetIdentifier":{"shape":"String"}, + "SubnetAvailabilityZone":{"shape":"AvailabilityZone"}, + "SubnetStatus":{"shape":"String"} + } + }, + "SubnetAlreadyInUse":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SubnetAlreadyInUse", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "SubnetIdentifierList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SubnetIdentifier" + } + }, + "SubnetList":{ + "type":"list", + "member":{ + "shape":"Subnet", + "locationName":"Subnet" + } + }, + "SubscriptionAlreadyExistFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SubscriptionAlreadyExist", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "SubscriptionCategoryNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SubscriptionCategoryNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "SubscriptionNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SubscriptionNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "SupportedCharacterSetsList":{ + "type":"list", + "member":{ + "shape":"CharacterSet", + "locationName":"CharacterSet" + } + }, + "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"} + } + }, + "VpcSecurityGroupIdList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"VpcSecurityGroupId" + } + }, + "VpcSecurityGroupMembership":{ + "type":"structure", + "members":{ + "VpcSecurityGroupId":{"shape":"String"}, + "Status":{"shape":"String"} + } + }, + "VpcSecurityGroupMembershipList":{ + "type":"list", + "member":{ + "shape":"VpcSecurityGroupMembership", + "locationName":"VpcSecurityGroupMembership" + } + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/rds/2013-02-12/docs-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/rds/2013-02-12/docs-2.json new file mode 100644 index 000000000..31661545e --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/rds/2013-02-12/docs-2.json @@ -0,0 +1,1796 @@ +{ + "version": "2.0", + "service": "Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and scale a relational database in the cloud. It provides cost-efficient, resizable capacity for an industry-standard relational database and manages common database administration tasks, freeing up developers to focus on what makes their applications and businesses unique.
Amazon RDS gives you access to the capabilities of a familiar MySQL or Oracle database server. This means the code, applications, and tools you already use today with your existing MySQL or Oracle databases work with Amazon RDS without modification. Amazon RDS automatically backs up your database and maintains the database software that powers your DB Instance. Amazon RDS is flexible: you can scale your database instance's compute resources and storage capacity to meet your application's demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for the resources you use.
This is the Amazon RDS API Reference. It contains a comprehensive description of all Amazon RDS Query APIs and data types. Note that this API is asynchronous and some actions may require polling to determine when an action has been applied. See the parameter description to determine if a change is applied immediately or on the next instance reboot or during the maintenance window. For more information on Amazon RDS concepts and usage scenarios, see the Amazon RDS User Guide.
", + "operations": { + "AddSourceIdentifierToSubscription": "Adds a source identifier to an existing RDS event notification subscription.
", + "AddTagsToResource": "Adds metadata tags to a DB Instance. These tags can also be used with cost allocation reporting to track cost associated with a DB Instance.
", + "AuthorizeDBSecurityGroupIngress": "Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC Security Groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC instances. Second, IP ranges are available if the application accessing your database is running on the Internet. Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).
For an overview of CIDR ranges, go to the Wikipedia Tutorial.
", + "CopyDBSnapshot": "Copies the specified DBSnapshot. The source DBSnapshot must be in the \"available\" state.
", + "CreateDBInstance": "Creates a new DB instance.
", + "CreateDBInstanceReadReplica": "Creates a DB Instance that acts as a Read Replica of a source DB Instance.
All Read Replica DB Instances are created as Single-AZ deployments with backups disabled. All other DB Instance attributes (including DB Security Groups and DB Parameter Groups) are inherited from the source DB Instance, except as specified below.
The source DB Instance must have backup retention enabled.
Creates a new DB Parameter Group.
A DB Parameter Group is initially created with the default parameters for the database engine used by the DB Instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup. Once you've created a DB Parameter Group, you need to associate it with your DB Instance using ModifyDBInstance. When you associate a new DB Parameter Group with a running DB Instance, you need to reboot the DB Instance for the new DB Parameter Group and associated settings to take effect.
", + "CreateDBSecurityGroup": "Creates a new DB Security Group. DB Security Groups control access to a DB Instance.
", + "CreateDBSnapshot": "Creates a DBSnapshot. The source DBInstance must be in \"available\" state.
", + "CreateDBSubnetGroup": "Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the region.
", + "CreateEventSubscription": "Creates an RDS event notification subscription. This action requires a topic ARN (Amazon Resource Name) created by either the RDS console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.
You can specify the type of source (SourceType) you want to be notified of, provide a list of RDS sources (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.
If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIdentifier = myDBInstance1, you will be notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you will receive notice of the events for that source type for all your RDS sources. If you do not specify either the SourceType nor the SourceIdentifier, you will be notified of events generated from all RDS sources belonging to your customer account.
", + "CreateOptionGroup": "Creates a new Option Group. You can create up to 20 option groups.
", + "DeleteDBInstance": "The DeleteDBInstance action deletes a previously provisioned DB instance. A successful response from the web service indicates the request was received correctly. When you delete a DB instance, all automated backups for that instance are deleted and cannot be recovered. Manual DB Snapshots of the DB instance to be deleted are not deleted.
If a final DBSnapshot is requested the status of the RDS instance will be \"deleting\" until the DBSnapshot is created. DescribeDBInstance is used to monitor the status of this operation. This cannot be canceled or reverted once submitted.
", + "DeleteDBParameterGroup": "Deletes a specified DBParameterGroup. The DBParameterGroup cannot be associated with any RDS instances to be deleted.
Deletes a DB Security Group.
Deletes a DBSnapshot.
available state to be deleted.Deletes a DB subnet group.
Deletes an RDS event notification subscription.
", + "DeleteOptionGroup": "Deletes an existing Option Group.
", + "DescribeDBEngineVersions": "Returns a list of the available DB engines.
", + "DescribeDBInstances": "Returns information about provisioned RDS instances. This API supports pagination.
", + "DescribeDBLogFiles": "Returns a list of DB log files for the DB instance.
", + "DescribeDBParameterGroups": "Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DBParameterGroup.
", + "DescribeDBParameters": "Returns the detailed parameter list for a particular DBParameterGroup.
", + "DescribeDBSecurityGroups": "Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified, the list will contain only the descriptions of the specified DBSecurityGroup.
For an overview of CIDR ranges, go to the Wikipedia Tutorial.
", + "DescribeDBSnapshots": "Returns information about DBSnapshots. This API supports pagination.
", + "DescribeDBSubnetGroups": "Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.
For an overview of CIDR ranges, go to the Wikipedia Tutorial.
", + "DescribeEngineDefaultParameters": "Returns the default engine and system parameter information for the specified database engine.
", + "DescribeEventCategories": "Displays a list of categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in the Events topic in the Amazon RDS User Guide.
", + "DescribeEventSubscriptions": "Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.
If you specify a SubscriptionName, lists the description for that subscription.
", + "DescribeEvents": "Returns events related to DB Instances, DB Security Groups, DB Snapshots and DB Parameter Groups for the past 14 days. Events specific to a particular DB Instance, DB Security Group, database snapshot or DB Parameter Group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.
", + "DescribeOptionGroupOptions": "Describes all available options.
", + "DescribeOptionGroups": "Describes the available option groups.
", + "DescribeOrderableDBInstanceOptions": "Returns a list of orderable DB Instance options for the specified engine.
", + "DescribeReservedDBInstances": "Returns information about reserved DB Instances for this account, or about a specified reserved DB Instance.
", + "DescribeReservedDBInstancesOfferings": "Lists available reserved DB Instance offerings.
", + "DownloadDBLogFilePortion": "Downloads the last line of the specified log file.
", + "ListTagsForResource": "Lists all tags on a DB Instance.
", + "ModifyDBInstance": "Modify settings for a DB Instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.
", + "ModifyDBParameterGroup": "Modifies the parameters of a DBParameterGroup. To modify more than one parameter submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.
The apply-immediate method can be used only for dynamic parameters; the pending-reboot method can be used with MySQL and Oracle DB Instances for either dynamic or static parameters. For Microsoft SQL Server DB Instances, the pending-reboot method can be used only for static parameters.
Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the region.
", + "ModifyEventSubscription": "Modifies an existing RDS event notification subscription. Note that you cannot modify the source identifiers using this call; to change source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.
You can see a list of the event categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.
", + "ModifyOptionGroup": "Modifies an existing Option Group.
", + "PromoteReadReplica": "Promotes a Read Replica DB Instance to a standalone DB Instance.
", + "PurchaseReservedDBInstancesOffering": "Purchases a reserved DB Instance offering.
", + "RebootDBInstance": "Reboots a previously provisioned RDS instance. This API results in the application of modified DBParameterGroup parameters with ApplyStatus of pending-reboot to the RDS instance. This action is taken as soon as possible, and results in a momentary outage to the RDS instance during which the RDS instance status is set to rebooting. If the RDS instance is configured for MultiAZ, it is possible that the reboot will be conducted through a failover. A DBInstance event is created when the reboot is completed.
", + "RemoveSourceIdentifierFromSubscription": "Removes a source identifier from an existing RDS event notification subscription.
", + "RemoveTagsFromResource": "Removes metadata tags from a DB Instance.
", + "ResetDBParameterGroup": "Modifies the parameters of a DBParameterGroup to the engine/system default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DBParameterGroup specify the DBParameterGroup name and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request.
", + "RestoreDBInstanceFromDBSnapshot": "Creates a new DB Instance from a DB snapshot. The target database is created from the source database restore point with the same configuration as the original source database, except that the new RDS instance is created with the default security group.
", + "RestoreDBInstanceToPointInTime": "Restores a DB Instance to an arbitrary point-in-time. Users can restore to any point in time before the latestRestorableTime for up to backupRetentionPeriod days. The target database is created from the source database with the same configuration as the original database except that the DB instance is created with the default DB security group.
", + "RevokeDBSecurityGroupIngress": "Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC Security Groups. Required parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId).
" + }, + "shapes": { + "AddSourceIdentifierToSubscriptionMessage": { + "base": "", + "refs": { + } + }, + "AddSourceIdentifierToSubscriptionResult": { + "base": null, + "refs": { + } + }, + "AddTagsToResourceMessage": { + "base": "", + "refs": { + } + }, + "ApplyMethod": { + "base": null, + "refs": { + "Parameter$ApplyMethod": "Indicates when to apply parameter updates.
" + } + }, + "AuthorizationAlreadyExistsFault": { + "base": "The specified CIDRIP or EC2 security group is already authorized for the specified DB security group.
", + "refs": { + } + }, + "AuthorizationNotFoundFault": { + "base": "Specified CIDRIP or EC2 security group is not authorized for the specified DB security group.
RDS may not also be authorized via IAM to perform necessary actions on your behalf.
", + "refs": { + } + }, + "AuthorizationQuotaExceededFault": { + "base": "DB security group authorization quota has been reached.
", + "refs": { + } + }, + "AuthorizeDBSecurityGroupIngressMessage": { + "base": "", + "refs": { + } + }, + "AuthorizeDBSecurityGroupIngressResult": { + "base": null, + "refs": { + } + }, + "AvailabilityZone": { + "base": "
Contains Availability Zone information.
This data type is used as an element in the following data type:
", + "refs": { + "AvailabilityZoneList$member": null, + "Subnet$SubnetAvailabilityZone": null + } + }, + "AvailabilityZoneList": { + "base": null, + "refs": { + "OrderableDBInstanceOption$AvailabilityZones": "A list of availability zones for the orderable DB Instance.
" + } + }, + "Boolean": { + "base": null, + "refs": { + "AvailabilityZone$ProvisionedIopsCapable": "True indicates the availability zone is capable of provisioned IOPs.
", + "DBInstance$MultiAZ": "Specifies if the DB Instance is a Multi-AZ deployment.
", + "DBInstance$AutoMinorVersionUpgrade": "Indicates that minor version patches are applied automatically.
", + "DBInstance$PubliclyAccessible": "Specifies the accessibility options for the DB Instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.
", + "DeleteDBInstanceMessage$SkipFinalSnapshot": " Determines whether a final DB Snapshot is created before the DB Instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB Snapshot is created before the DB Instance is deleted.
false.Default: false
Indicates that only the default version of the specified engine or engine and major version combination is returned.
", + "DownloadDBLogFilePortionDetails$AdditionalDataPending": "Boolean value that if true, indicates there is more data to be downloaded.
", + "EventSubscription$Enabled": "A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.
", + "ModifyDBInstanceMessage$ApplyImmediately": " Specifies whether or not the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB Instance.
If this parameter is passed as false, changes to the DB Instance are applied on the next call to RebootDBInstance, the next maintenance reboot, or the next failure reboot, whichever occurs first. See each parameter to determine when a change is applied.
Default: false
Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.
Constraints: This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB Instance's current version.
", + "ModifyOptionGroupMessage$ApplyImmediately": "Indicates whether the changes should be applied immediately, or during the next maintenance window for each instance associated with the Option Group.
", + "Option$Persistent": "Indicate if this option is persistent.
", + "OptionGroup$AllowsVpcAndNonVpcInstanceMemberships": "Indicates whether this option group can be applied to both VPC and non-VPC instances. The value 'true' indicates the option group can be applied to both VPC and non-VPC instances.
", + "OptionGroupOption$PortRequired": "Specifies whether the option requires a port.
", + "OptionGroupOption$Persistent": "Specifies whether the option is persistent in an option group.
", + "OptionGroupOptionSetting$IsModifiable": "Boolean value where true indicates that this option group option can be changed from the default value.
", + "OptionSetting$IsModifiable": "A Boolean value that, when true, indicates the option setting can be modified from the default.
", + "OptionSetting$IsCollection": "Indicates if the option setting is part of a collection.
", + "OrderableDBInstanceOption$MultiAZCapable": "Indicates whether this orderable DB Instance is multi-AZ capable.
", + "OrderableDBInstanceOption$ReadReplicaCapable": "Indicates whether this orderable DB Instance can have a read replica.
", + "OrderableDBInstanceOption$Vpc": "Indicates whether this is a VPC orderable DB Instance.
", + "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.
Indicates if the reservation applies to Multi-AZ deployments.
", + "ReservedDBInstancesOffering$MultiAZ": "Indicates if the offering applies to Multi-AZ deployments.
", + "ResetDBParameterGroupMessage$ResetAllParameters": " Specifies whether (true) or not (false) to reset all parameters in the DB Parameter Group to default values.
Default: true
Specifies whether (true) or not (false) the DB Instance is restored from the latest backup time.
Default: false
Constraints: Cannot be specified if RestoreTime parameter is provided.
" + } + }, + "BooleanOptional": { + "base": null, + "refs": { + "CreateDBInstanceMessage$MultiAZ": "Specifies if the DB Instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the MultiAZ parameter is set to true.
", + "CreateDBInstanceMessage$AutoMinorVersionUpgrade": "Indicates that minor engine upgrades will be applied automatically to the DB Instance during the maintenance window.
Default: true
Specifies the accessibility options for the DB Instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.
", + "CreateDBInstanceReadReplicaMessage$AutoMinorVersionUpgrade": "Indicates that minor engine upgrades will be applied automatically to the Read Replica during the maintenance window.
Default: Inherits from the source DB Instance
", + "CreateDBInstanceReadReplicaMessage$PubliclyAccessible": "Specifies the accessibility options for the DB Instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.
", + "CreateEventSubscriptionMessage$Enabled": "A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.
", + "DescribeDBEngineVersionsMessage$ListSupportedCharacterSets": "If this parameter is specified, and if the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.
", + "DescribeOrderableDBInstanceOptionsMessage$Vpc": "The VPC filter value. Specify this parameter to show only the available VPC or non-VPC offerings.
", + "DescribeReservedDBInstancesMessage$MultiAZ": "The Multi-AZ filter value. Specify this parameter to show only those reservations matching the specified Multi-AZ parameter.
", + "DescribeReservedDBInstancesOfferingsMessage$MultiAZ": "The Multi-AZ filter value. Specify this parameter to show only the available offerings matching the specified Multi-AZ parameter.
", + "ModifyDBInstanceMessage$MultiAZ": " Specifies if the DB Instance is a Multi-AZ deployment. Changing this parameter does not result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.
Constraints: Cannot be specified if the DB Instance is a read replica.
", + "ModifyDBInstanceMessage$AutoMinorVersionUpgrade": " Indicates that minor version upgrades will be applied automatically to the DB Instance during the maintenance window. Changing this parameter does not result in an outage except in the following case and the change is asynchronously applied as soon as possible. An outage will result if this parameter is set to true during the maintenance window, and a newer minor version is available, and RDS has enabled auto patching for that engine version.
A Boolean value; set to true to activate the subscription.
", + "PendingModifiedValues$MultiAZ": "Indicates that the Single-AZ DB Instance is to change to a Multi-AZ deployment.
", + "RebootDBInstanceMessage$ForceFailover": " When true, the reboot will be conducted through a MultiAZ failover.
Constraint: You cannot specify true if the instance is not configured for MultiAZ.
Specifies if the DB Instance is a Multi-AZ deployment.
Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.
Specifies the accessibility options for the DB Instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.
", + "RestoreDBInstanceFromDBSnapshotMessage$AutoMinorVersionUpgrade": "Indicates that minor version upgrades will be applied automatically to the DB Instance during the maintenance window.
", + "RestoreDBInstanceToPointInTimeMessage$MultiAZ": "Specifies if the DB Instance is a Multi-AZ deployment.
Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.
Specifies the accessibility options for the DB Instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.
", + "RestoreDBInstanceToPointInTimeMessage$AutoMinorVersionUpgrade": "Indicates that minor version upgrades will be applied automatically to the DB Instance during the maintenance window.
" + } + }, + "CharacterSet": { + "base": "This data type is used as a response element in the action DescribeDBEngineVersions.
", + "refs": { + "DBEngineVersion$DefaultCharacterSet": " The default character set for new instances of this engine version, if the CharacterSetName parameter of the CreateDBInstance API is not specified.
", + "refs": { + } + }, + "CopyDBSnapshotResult": { + "base": null, + "refs": { + } + }, + "CreateDBInstanceMessage": { + "base": "
", + "refs": { + } + }, + "CreateDBInstanceReadReplicaMessage": { + "base": null, + "refs": { + } + }, + "CreateDBInstanceReadReplicaResult": { + "base": null, + "refs": { + } + }, + "CreateDBInstanceResult": { + "base": null, + "refs": { + } + }, + "CreateDBParameterGroupMessage": { + "base": "
", + "refs": { + } + }, + "CreateDBParameterGroupResult": { + "base": null, + "refs": { + } + }, + "CreateDBSecurityGroupMessage": { + "base": "
", + "refs": { + } + }, + "CreateDBSecurityGroupResult": { + "base": null, + "refs": { + } + }, + "CreateDBSnapshotMessage": { + "base": "
", + "refs": { + } + }, + "CreateDBSnapshotResult": { + "base": null, + "refs": { + } + }, + "CreateDBSubnetGroupMessage": { + "base": "
", + "refs": { + } + }, + "CreateDBSubnetGroupResult": { + "base": null, + "refs": { + } + }, + "CreateEventSubscriptionMessage": { + "base": "", + "refs": { + } + }, + "CreateEventSubscriptionResult": { + "base": null, + "refs": { + } + }, + "CreateOptionGroupMessage": { + "base": "", + "refs": { + } + }, + "CreateOptionGroupResult": { + "base": null, + "refs": { + } + }, + "DBEngineVersion": { + "base": "
This data type is used as a response element in the action DescribeDBEngineVersions.
", + "refs": { + "DBEngineVersionList$member": null + } + }, + "DBEngineVersionList": { + "base": null, + "refs": { + "DBEngineVersionMessage$DBEngineVersions": " A list of DBEngineVersion elements.
Contains the result of a successful invocation of the DescribeDBEngineVersions action.
", + "refs": { + } + }, + "DBInstance": { + "base": "Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBInstances action.
", + "refs": { + "CreateDBInstanceReadReplicaResult$DBInstance": null, + "CreateDBInstanceResult$DBInstance": null, + "DBInstanceList$member": null, + "DeleteDBInstanceResult$DBInstance": null, + "ModifyDBInstanceResult$DBInstance": null, + "PromoteReadReplicaResult$DBInstance": null, + "RebootDBInstanceResult$DBInstance": null, + "RestoreDBInstanceFromDBSnapshotResult$DBInstance": null, + "RestoreDBInstanceToPointInTimeResult$DBInstance": null + } + }, + "DBInstanceAlreadyExistsFault": { + "base": "User already has a DB instance with the given identifier.
", + "refs": { + } + }, + "DBInstanceList": { + "base": null, + "refs": { + "DBInstanceMessage$DBInstances": "A list of DBInstance instances.
" + } + }, + "DBInstanceMessage": { + "base": "Contains the result of a successful invocation of the DescribeDBInstances action.
", + "refs": { + } + }, + "DBInstanceNotFoundFault": { + "base": "DBInstanceIdentifier does not refer to an existing DB instance.
", + "refs": { + } + }, + "DBLogFileNotFoundFault": { + "base": "LogFileName does not refer to an existing DB log file.
", + "refs": { + } + }, + "DBParameterGroup": { + "base": "Contains the result of a successful invocation of the CreateDBParameterGroup action.
This data type is used as a request parameter in the DeleteDBParameterGroup action, and as a response element in the DescribeDBParameterGroups action.
", + "refs": { + "CreateDBParameterGroupResult$DBParameterGroup": null, + "DBParameterGroupList$member": null + } + }, + "DBParameterGroupAlreadyExistsFault": { + "base": "A DB parameter group with the same name exists.
", + "refs": { + } + }, + "DBParameterGroupDetails": { + "base": "Contains the result of a successful invocation of the DescribeDBParameters action.
", + "refs": { + } + }, + "DBParameterGroupList": { + "base": null, + "refs": { + "DBParameterGroupsMessage$DBParameterGroups": "A list of DBParameterGroup instances.
" + } + }, + "DBParameterGroupNameMessage": { + "base": "Contains the result of a successful invocation of the ModifyDBParameterGroup or ResetDBParameterGroup action.
", + "refs": { + } + }, + "DBParameterGroupNotFoundFault": { + "base": "DBParameterGroupName does not refer to an existing DB parameter group.
", + "refs": { + } + }, + "DBParameterGroupQuotaExceededFault": { + "base": "Request would result in user exceeding the allowed number of DB parameter groups.
", + "refs": { + } + }, + "DBParameterGroupStatus": { + "base": "The status of the DB Parameter Group.
This data type is used as a response element in the following actions:
Provides the list of DB Parameter Groups applied to this DB Instance.
" + } + }, + "DBParameterGroupsMessage": { + "base": "Contains the result of a successful invocation of the DescribeDBParameterGroups action.
", + "refs": { + } + }, + "DBSecurityGroup": { + "base": "Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBSecurityGroups action.
", + "refs": { + "AuthorizeDBSecurityGroupIngressResult$DBSecurityGroup": null, + "CreateDBSecurityGroupResult$DBSecurityGroup": null, + "DBSecurityGroups$member": null, + "RevokeDBSecurityGroupIngressResult$DBSecurityGroup": null + } + }, + "DBSecurityGroupAlreadyExistsFault": { + "base": "A DB security group with the name specified in DBSecurityGroupName already exists.
", + "refs": { + } + }, + "DBSecurityGroupMembership": { + "base": "This data type is used as a response element in the following actions:
", + "refs": { + "DBSecurityGroupMembershipList$member": null + } + }, + "DBSecurityGroupMembershipList": { + "base": null, + "refs": { + "DBInstance$DBSecurityGroups": " Provides List of DB Security Group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.
If the option requires access to a port, then this DB Security Group allows access to the port.
" + } + }, + "DBSecurityGroupMessage": { + "base": "Contains the result of a successful invocation of the DescribeDBSecurityGroups action.
", + "refs": { + } + }, + "DBSecurityGroupNameList": { + "base": null, + "refs": { + "CreateDBInstanceMessage$DBSecurityGroups": "A list of DB Security Groups to associate with this DB Instance.
Default: The default DB Security Group for the database engine.
", + "ModifyDBInstanceMessage$DBSecurityGroups": "A list of DB Security Groups to authorize on this DB Instance. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.
Constraints:
A list of DBSecurityGroupMemebrship name strings used for this option.
" + } + }, + "DBSecurityGroupNotFoundFault": { + "base": "DBSecurityGroupName does not refer to an existing DB security group.
", + "refs": { + } + }, + "DBSecurityGroupNotSupportedFault": { + "base": "A DB security group is not allowed for this action.
", + "refs": { + } + }, + "DBSecurityGroupQuotaExceededFault": { + "base": "Request would result in user exceeding the allowed number of DB security groups.
", + "refs": { + } + }, + "DBSecurityGroups": { + "base": null, + "refs": { + "DBSecurityGroupMessage$DBSecurityGroups": "A list of DBSecurityGroup instances.
" + } + }, + "DBSnapshot": { + "base": "Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBSnapshots action.
", + "refs": { + "CopyDBSnapshotResult$DBSnapshot": null, + "CreateDBSnapshotResult$DBSnapshot": null, + "DBSnapshotList$member": null, + "DeleteDBSnapshotResult$DBSnapshot": null + } + }, + "DBSnapshotAlreadyExistsFault": { + "base": "DBSnapshotIdentifier is already used by an existing snapshot.
", + "refs": { + } + }, + "DBSnapshotList": { + "base": null, + "refs": { + "DBSnapshotMessage$DBSnapshots": "A list of DBSnapshot instances.
" + } + }, + "DBSnapshotMessage": { + "base": "Contains the result of a successful invocation of the DescribeDBSnapshots action.
", + "refs": { + } + }, + "DBSnapshotNotFoundFault": { + "base": "DBSnapshotIdentifier does not refer to an existing DB snapshot.
", + "refs": { + } + }, + "DBSubnetGroup": { + "base": "Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBSubnetGroups action.
", + "refs": { + "CreateDBSubnetGroupResult$DBSubnetGroup": null, + "DBInstance$DBSubnetGroup": "Provides the inforamtion of the subnet group associated with the DB instance, including the name, descrption and subnets in the subnet group.
", + "DBSubnetGroups$member": null, + "ModifyDBSubnetGroupResult$DBSubnetGroup": null + } + }, + "DBSubnetGroupAlreadyExistsFault": { + "base": "DBSubnetGroupName is already used by an existing DB subnet group.
", + "refs": { + } + }, + "DBSubnetGroupDoesNotCoverEnoughAZs": { + "base": "Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
", + "refs": { + } + }, + "DBSubnetGroupMessage": { + "base": "Contains the result of a successful invocation of the DescribeDBSubnetGroups action.
", + "refs": { + } + }, + "DBSubnetGroupNotFoundFault": { + "base": "DBSubnetGroupName does not refer to an existing DB subnet group.
", + "refs": { + } + }, + "DBSubnetGroupQuotaExceededFault": { + "base": "Request would result in user exceeding the allowed number of DB subnet groups.
", + "refs": { + } + }, + "DBSubnetGroups": { + "base": null, + "refs": { + "DBSubnetGroupMessage$DBSubnetGroups": "A list of DBSubnetGroup instances.
" + } + }, + "DBSubnetQuotaExceededFault": { + "base": "Request would result in user exceeding the allowed number of subnets in a DB subnet groups.
", + "refs": { + } + }, + "DBUpgradeDependencyFailureFault": { + "base": "The DB upgrade failed because a resource the DB depends on could not be modified.
", + "refs": { + } + }, + "DeleteDBInstanceMessage": { + "base": "", + "refs": { + } + }, + "DeleteDBInstanceResult": { + "base": null, + "refs": { + } + }, + "DeleteDBParameterGroupMessage": { + "base": "
", + "refs": { + } + }, + "DeleteDBSecurityGroupMessage": { + "base": "
", + "refs": { + } + }, + "DeleteDBSnapshotMessage": { + "base": "
", + "refs": { + } + }, + "DeleteDBSnapshotResult": { + "base": null, + "refs": { + } + }, + "DeleteDBSubnetGroupMessage": { + "base": "
", + "refs": { + } + }, + "DeleteEventSubscriptionMessage": { + "base": "", + "refs": { + } + }, + "DeleteEventSubscriptionResult": { + "base": null, + "refs": { + } + }, + "DeleteOptionGroupMessage": { + "base": "
", + "refs": { + } + }, + "DescribeDBEngineVersionsMessage": { + "base": null, + "refs": { + } + }, + "DescribeDBInstancesMessage": { + "base": "
", + "refs": { + } + }, + "DescribeDBLogFilesDetails": { + "base": "
This data type is used as a response element to DescribeDBLogFiles.
", + "refs": { + "DescribeDBLogFilesList$member": null + } + }, + "DescribeDBLogFilesList": { + "base": null, + "refs": { + "DescribeDBLogFilesResponse$DescribeDBLogFiles": "The DB log files returned.
" + } + }, + "DescribeDBLogFilesMessage": { + "base": "", + "refs": { + } + }, + "DescribeDBLogFilesResponse": { + "base": "
The response from a call to DescribeDBLogFiles.
", + "refs": { + } + }, + "DescribeDBParameterGroupsMessage": { + "base": "", + "refs": { + } + }, + "DescribeDBParametersMessage": { + "base": null, + "refs": { + } + }, + "DescribeDBSecurityGroupsMessage": { + "base": "
", + "refs": { + } + }, + "DescribeDBSnapshotsMessage": { + "base": "
", + "refs": { + } + }, + "DescribeDBSubnetGroupsMessage": { + "base": "
", + "refs": { + } + }, + "DescribeEngineDefaultParametersMessage": { + "base": "
", + "refs": { + } + }, + "DescribeEngineDefaultParametersResult": { + "base": null, + "refs": { + } + }, + "DescribeEventCategoriesMessage": { + "base": "", + "refs": { + } + }, + "DescribeEventSubscriptionsMessage": { + "base": "", + "refs": { + } + }, + "DescribeEventsMessage": { + "base": "
", + "refs": { + } + }, + "DescribeOptionGroupOptionsMessage": { + "base": "
", + "refs": { + } + }, + "DescribeOptionGroupsMessage": { + "base": "
", + "refs": { + } + }, + "DescribeOrderableDBInstanceOptionsMessage": { + "base": "
", + "refs": { + } + }, + "DescribeReservedDBInstancesMessage": { + "base": "
", + "refs": { + } + }, + "DescribeReservedDBInstancesOfferingsMessage": { + "base": "
", + "refs": { + } + }, + "Double": { + "base": null, + "refs": { + "RecurringCharge$RecurringChargeAmount": "
The amount of the recurring charge.
", + "ReservedDBInstance$FixedPrice": "The fixed price charged for this reserved DB Instance.
", + "ReservedDBInstance$UsagePrice": "The hourly price charged for this reserved DB Instance.
", + "ReservedDBInstancesOffering$FixedPrice": "The fixed price charged for this offering.
", + "ReservedDBInstancesOffering$UsagePrice": "The hourly price charged for this offering.
" + } + }, + "DownloadDBLogFilePortionDetails": { + "base": "This data type is used as a response element to DownloadDBLogFilePortion.
", + "refs": { + } + }, + "DownloadDBLogFilePortionMessage": { + "base": "", + "refs": { + } + }, + "EC2SecurityGroup": { + "base": "
This data type is used as a response element in the following actions:
", + "refs": { + "EC2SecurityGroupList$member": null + } + }, + "EC2SecurityGroupList": { + "base": null, + "refs": { + "DBSecurityGroup$EC2SecurityGroups": "Contains a list of EC2SecurityGroup elements.
" + } + }, + "Endpoint": { + "base": "This data type is used as a response element in the following actions:
", + "refs": { + "DBInstance$Endpoint": "Specifies the connection endpoint.
" + } + }, + "EngineDefaults": { + "base": "Contains the result of a successful invocation of the DescribeEngineDefaultParameters action.
", + "refs": { + "DescribeEngineDefaultParametersResult$EngineDefaults": null + } + }, + "Event": { + "base": "This data type is used as a response element in the DescribeEvents action.
", + "refs": { + "EventList$member": null + } + }, + "EventCategoriesList": { + "base": null, + "refs": { + "CreateEventSubscriptionMessage$EventCategories": "A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.
", + "DescribeEventsMessage$EventCategories": "A list of event categories that trigger notifications for a event notification subscription.
", + "Event$EventCategories": "Specifies the category for the event.
", + "EventCategoriesMap$EventCategories": "The event categories for the specified source type
", + "EventSubscription$EventCategoriesList": "A list of event categories for the RDS event notification subscription.
", + "ModifyEventSubscriptionMessage$EventCategories": "A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.
" + } + }, + "EventCategoriesMap": { + "base": "Contains the results of a successful invocation of the DescribeEventCategories action.
", + "refs": { + "EventCategoriesMapList$member": null + } + }, + "EventCategoriesMapList": { + "base": null, + "refs": { + "EventCategoriesMessage$EventCategoriesMapList": "A list of EventCategoriesMap data types.
" + } + }, + "EventCategoriesMessage": { + "base": "Data returned from the DescribeEventCategories action.
", + "refs": { + } + }, + "EventList": { + "base": null, + "refs": { + "EventsMessage$Events": "A list of Event instances.
" + } + }, + "EventSubscription": { + "base": "Contains the results of a successful invocation of the DescribeEventSubscriptions action.
", + "refs": { + "AddSourceIdentifierToSubscriptionResult$EventSubscription": null, + "CreateEventSubscriptionResult$EventSubscription": null, + "DeleteEventSubscriptionResult$EventSubscription": null, + "EventSubscriptionsList$member": null, + "ModifyEventSubscriptionResult$EventSubscription": null, + "RemoveSourceIdentifierFromSubscriptionResult$EventSubscription": null + } + }, + "EventSubscriptionQuotaExceededFault": { + "base": "You have reached the maximum number of event subscriptions.
", + "refs": { + } + }, + "EventSubscriptionsList": { + "base": null, + "refs": { + "EventSubscriptionsMessage$EventSubscriptionsList": "A list of EventSubscriptions data types.
" + } + }, + "EventSubscriptionsMessage": { + "base": "Data returned by the DescribeEventSubscriptions action.
", + "refs": { + } + }, + "EventsMessage": { + "base": "Contains the result of a successful invocation of the DescribeEvents action.
", + "refs": { + } + }, + "IPRange": { + "base": "This data type is used as a response element in the DescribeDBSecurityGroups action.
", + "refs": { + "IPRangeList$member": null + } + }, + "IPRangeList": { + "base": null, + "refs": { + "DBSecurityGroup$IPRanges": "Contains a list of IPRange elements.
" + } + }, + "InstanceQuotaExceededFault": { + "base": "Request would result in user exceeding the allowed number of DB instances.
", + "refs": { + } + }, + "InsufficientDBInstanceCapacityFault": { + "base": "Specified DB instance class is not available in the specified Availability Zone.
", + "refs": { + } + }, + "Integer": { + "base": null, + "refs": { + "DBInstance$AllocatedStorage": "Specifies the allocated storage size specified in gigabytes.
", + "DBInstance$BackupRetentionPeriod": "Specifies the number of days for which automatic DB Snapshots are retained.
", + "DBSnapshot$AllocatedStorage": "Specifies the allocated storage size in gigabytes (GB).
", + "DBSnapshot$Port": "Specifies the port that the database engine was listening on at the time of the snapshot.
", + "DownloadDBLogFilePortionMessage$NumberOfLines": "The number of lines remaining to be downloaded.
", + "Endpoint$Port": "Specifies the port that the database engine is listening on.
", + "ReservedDBInstance$Duration": "The duration of the reservation in seconds.
", + "ReservedDBInstance$DBInstanceCount": "The number of reserved DB Instances.
", + "ReservedDBInstancesOffering$Duration": "The duration of the offering in seconds.
" + } + }, + "IntegerOptional": { + "base": null, + "refs": { + "CreateDBInstanceMessage$AllocatedStorage": "The amount of storage (in gigabytes) to be initially allocated for the database instance.
MySQL
Constraints: Must be an integer from 5 to 1024.
Type: Integer
Oracle
Constraints: Must be an integer from 10 to 1024.
SQL Server
Constraints: Must be an integer from 200 to 1024 (Standard Edition and Enterprise Edition) or from 30 to 1024 (Express Edition and Web Edition)
", + "CreateDBInstanceMessage$BackupRetentionPeriod": "The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
Default: 1
Constraints:
The port number on which the database accepts connections.
MySQL
Default: 3306
Valid Values: 1150-65535
Type: Integer
Oracle
Default: 1521
Valid Values: 1150-65535
SQL Server
Default: 1433
Valid Values: 1150-65535 except for 1434 and 3389.
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB Instance.
Constraints: Must be an integer greater than 1000.
", + "CreateDBInstanceReadReplicaMessage$Port": "The port number that the DB Instance uses for connections.
Default: Inherits from the source DB Instance
Valid Values: 1150-65535
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB Instance.
", + "DBInstance$Iops": "Specifies the Provisioned IOPS (I/O operations per second) value.
", + "DBSnapshot$Iops": "Specifies the Provisioned IOPS (I/O operations per second) value of the DB Instance at the time of the snapshot.
", + "DescribeDBEngineVersionsMessage$MaxRecords": " The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
", + "DescribeDBInstancesMessage$MaxRecords": " The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
", + "DescribeDBLogFilesMessage$MaxRecords": "The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
", + "DescribeDBParameterGroupsMessage$MaxRecords": " The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
", + "DescribeDBParametersMessage$MaxRecords": " The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
", + "DescribeDBSecurityGroupsMessage$MaxRecords": " The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
", + "DescribeDBSnapshotsMessage$MaxRecords": " The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
", + "DescribeDBSubnetGroupsMessage$MaxRecords": " The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may 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 pagination token called a marker is included in the response so that the remaining results may be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
", + "DescribeEventSubscriptionsMessage$MaxRecords": " The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called 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 to retrieve events for.
Default: 60
", + "DescribeEventsMessage$MaxRecords": " The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
", + "DescribeOptionGroupOptionsMessage$MaxRecords": " The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
", + "DescribeOptionGroupsMessage$MaxRecords": " The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
", + "DescribeOrderableDBInstanceOptionsMessage$MaxRecords": " The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
", + "DescribeReservedDBInstancesMessage$MaxRecords": " The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
", + "DescribeReservedDBInstancesOfferingsMessage$MaxRecords": " The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
", + "ModifyDBInstanceMessage$AllocatedStorage": " The new storage capacity of the RDS instance. Changing this parameter does not result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.
MySQL
Default: Uses existing setting
Valid Values: 5-1024
Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
Type: Integer
Oracle
Default: Uses existing setting
Valid Values: 10-1024
Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
SQL Server
Cannot be modified.
If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance will be available for use, but may experience performance degradation. While the migration takes place, nightly backups for the instance will be suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and creating a DB snapshot of the instance.
", + "ModifyDBInstanceMessage$BackupRetentionPeriod": "The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
Changing this parameter can result in an outage if you change from 0 to a non-zero value or from a non-zero value to 0. These changes are applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously applied as soon as possible.
Default: Uses existing setting
Constraints:
The new Provisioned IOPS (I/O operations per second) value for the RDS instance. Changing this parameter does not result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.
Default: Uses existing setting
Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
Type: Integer
If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance will be available for use, but may experience performance degradation. While the migration takes place, nightly backups for the instance will be suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and creating a DB snapshot of the instance.
", + "Option$Port": "If required, the port configured for this option to use.
", + "OptionConfiguration$Port": "The optional port for the option.
", + "OptionGroupOption$DefaultPort": "If the option requires a port, specifies the default port for the option.
", + "PendingModifiedValues$AllocatedStorage": " Contains the new AllocatedStorage size for the DB Instance that will be applied or is in progress.
Specifies the pending port for the DB Instance.
", + "PendingModifiedValues$BackupRetentionPeriod": "Specifies the pending number of days for which automated backups are retained.
", + "PendingModifiedValues$Iops": "Specifies the new Provisioned IOPS value for the DB Instance that will be applied or is being applied.
", + "PromoteReadReplicaMessage$BackupRetentionPeriod": "The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
Default: 1
Constraints:
The number of instances to reserve.
Default: 1
The port number on which the database accepts connections.
Default: The same port as the original DB Instance
Constraints: Value must be 1150-65535
Specifies the amount of provisioned IOPS for the DB Instance, expressed in I/O operations per second. If this parameter is not specified, the IOPS value will be taken from the backup. If this parameter is set to 0, the new instance will be converted to a non-PIOPS instance, which will take additional time, though your DB instance will be available for connections before the conversion starts.
Constraints: Must be an integer greater than 1000.
", + "RestoreDBInstanceToPointInTimeMessage$Port": "The port number on which the database accepts connections.
Constraints: Value must be 1150-65535
Default: The same port as the original DB Instance.
", + "RestoreDBInstanceToPointInTimeMessage$Iops": "The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB Instance.
Constraints: Must be an integer greater than 1000.
" + } + }, + "InvalidDBInstanceStateFault": { + "base": "The specified DB instance is not in the available state.
", + "refs": { + } + }, + "InvalidDBParameterGroupStateFault": { + "base": "The DB parameter group cannot be deleted because it is in use.
", + "refs": { + } + }, + "InvalidDBSecurityGroupStateFault": { + "base": "The state of the DB security group does not allow deletion.
", + "refs": { + } + }, + "InvalidDBSnapshotStateFault": { + "base": "The state of the DB snapshot does not allow deletion.
", + "refs": { + } + }, + "InvalidDBSubnetGroupStateFault": { + "base": "The DB subnet group cannot be deleted because it is in use.
", + "refs": { + } + }, + "InvalidDBSubnetStateFault": { + "base": "The DB subnet is not in the available state.
", + "refs": { + } + }, + "InvalidEventSubscriptionStateFault": { + "base": "This error can occur if someone else is modifying a subscription. You should retry the action.
", + "refs": { + } + }, + "InvalidOptionGroupStateFault": { + "base": "The option group is not in the available state.
", + "refs": { + } + }, + "InvalidRestoreFault": { + "base": "Cannot restore from vpc backup to non-vpc DB instance.
", + "refs": { + } + }, + "InvalidSubnet": { + "base": "The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
", + "refs": { + } + }, + "InvalidVPCNetworkStateFault": { + "base": "DB subnet group does not cover all Availability Zones after it is created because users' change.
", + "refs": { + } + }, + "KeyList": { + "base": null, + "refs": { + "RemoveTagsFromResourceMessage$TagKeys": "The tag key (name) of the tag to be removed.
" + } + }, + "ListTagsForResourceMessage": { + "base": "", + "refs": { + } + }, + "Long": { + "base": null, + "refs": { + "DescribeDBLogFilesDetails$LastWritten": "The date and time that the last log entry was written.
", + "DescribeDBLogFilesDetails$Size": "The size, in bytes, of the log file for the specified DB instance.
", + "DescribeDBLogFilesMessage$FileLastWritten": "Filters the available log files for files written since the specified date.
", + "DescribeDBLogFilesMessage$FileSize": "Filters the available log files for files larger than the specified size.
" + } + }, + "ModifyDBInstanceMessage": { + "base": "", + "refs": { + } + }, + "ModifyDBInstanceResult": { + "base": null, + "refs": { + } + }, + "ModifyDBParameterGroupMessage": { + "base": "
", + "refs": { + } + }, + "ModifyDBSubnetGroupMessage": { + "base": "
", + "refs": { + } + }, + "ModifyDBSubnetGroupResult": { + "base": null, + "refs": { + } + }, + "ModifyEventSubscriptionMessage": { + "base": "", + "refs": { + } + }, + "ModifyEventSubscriptionResult": { + "base": null, + "refs": { + } + }, + "ModifyOptionGroupMessage": { + "base": "
", + "refs": { + } + }, + "ModifyOptionGroupResult": { + "base": null, + "refs": { + } + }, + "Option": { + "base": "
Option details.
", + "refs": { + "OptionsList$member": null + } + }, + "OptionConfiguration": { + "base": "A list of all available options
", + "refs": { + "OptionConfigurationList$member": null + } + }, + "OptionConfigurationList": { + "base": null, + "refs": { + "ModifyOptionGroupMessage$OptionsToInclude": "Options in this list are added to the Option Group or, if already present, the specified configuration is used to update the existing configuration.
" + } + }, + "OptionGroup": { + "base": "", + "refs": { + "CreateOptionGroupResult$OptionGroup": null, + "ModifyOptionGroupResult$OptionGroup": null, + "OptionGroupsList$member": null + } + }, + "OptionGroupAlreadyExistsFault": { + "base": "
The option group you are trying to create already exists.
", + "refs": { + } + }, + "OptionGroupMembership": { + "base": "Provides information on the option groups the DB instance is a member of.
", + "refs": { + "OptionGroupMembershipList$member": null + } + }, + "OptionGroupMembershipList": { + "base": null, + "refs": { + "DBInstance$OptionGroupMemberships": "Provides the list of option group memberships for this DB Instance.
" + } + }, + "OptionGroupNotFoundFault": { + "base": "The specified option group could not be found.
", + "refs": { + } + }, + "OptionGroupOption": { + "base": "Available option.
", + "refs": { + "OptionGroupOptionsList$member": null + } + }, + "OptionGroupOptionSetting": { + "base": "Option Group option settings are used to display settings available for each option with their default values and other information. These values are used with the DescribeOptionGroupOptions action.
", + "refs": { + "OptionGroupOptionSettingsList$member": null + } + }, + "OptionGroupOptionSettingsList": { + "base": null, + "refs": { + "OptionGroupOption$OptionGroupOptionSettings": "Specifies the option settings that are available (and the default value) for each option in an option group.
" + } + }, + "OptionGroupOptionsList": { + "base": "List of available option group options.
", + "refs": { + "OptionGroupOptionsMessage$OptionGroupOptions": null + } + }, + "OptionGroupOptionsMessage": { + "base": "", + "refs": { + } + }, + "OptionGroupQuotaExceededFault": { + "base": "
The quota of 20 option groups was exceeded for this AWS account.
", + "refs": { + } + }, + "OptionGroups": { + "base": "List of option groups.
", + "refs": { + } + }, + "OptionGroupsList": { + "base": null, + "refs": { + "OptionGroups$OptionGroupsList": "List of option groups.
" + } + }, + "OptionNamesList": { + "base": null, + "refs": { + "ModifyOptionGroupMessage$OptionsToRemove": "Options in this list are removed from the Option Group.
" + } + }, + "OptionSetting": { + "base": "Option settings are the actual settings being applied or configured for that option. It is used when you modify an option group or describe option groups. For example, the NATIVE_NETWORK_ENCRYPTION option has a setting called SQLNET.ENCRYPTION_SERVER that can have several different values.
", + "refs": { + "OptionSettingConfigurationList$member": null, + "OptionSettingsList$member": null + } + }, + "OptionSettingConfigurationList": { + "base": null, + "refs": { + "Option$OptionSettings": "The option settings for this option.
" + } + }, + "OptionSettingsList": { + "base": null, + "refs": { + "OptionConfiguration$OptionSettings": "The option settings to include in an option group.
" + } + }, + "OptionsDependedOn": { + "base": null, + "refs": { + "OptionGroupOption$OptionsDependedOn": "List of all options that are prerequisites for this option.
" + } + }, + "OptionsList": { + "base": null, + "refs": { + "OptionGroup$Options": "Indicates what options are available in the option group.
" + } + }, + "OrderableDBInstanceOption": { + "base": "Contains a list of available options for a DB Instance
This data type is used as a response element in the DescribeOrderableDBInstanceOptions action.
", + "refs": { + "OrderableDBInstanceOptionsList$member": null + } + }, + "OrderableDBInstanceOptionsList": { + "base": null, + "refs": { + "OrderableDBInstanceOptionsMessage$OrderableDBInstanceOptions": "An OrderableDBInstanceOption structure containing information about orderable options for the DB Instance.
" + } + }, + "OrderableDBInstanceOptionsMessage": { + "base": "Contains the result of a successful invocation of the DescribeOrderableDBInstanceOptions action.
", + "refs": { + } + }, + "Parameter": { + "base": "This data type is used as a request parameter in the ModifyDBParameterGroup and ResetDBParameterGroup actions.
This data type is used as a response element in the DescribeEngineDefaultParameters and DescribeDBParameters actions.
", + "refs": { + "ParametersList$member": null + } + }, + "ParametersList": { + "base": null, + "refs": { + "DBParameterGroupDetails$Parameters": "A list of Parameter instances.
", + "EngineDefaults$Parameters": "Contains a list of engine default parameters.
", + "ModifyDBParameterGroupMessage$Parameters": "An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters may be modified in a single request.
Valid Values (for the application method): immediate | pending-reboot
An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters may be modified in a single request.
MySQL
Valid Values (for Apply method): immediate | pending-reboot
You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when DB Instance reboots.
Oracle
Valid Values (for Apply method): pending-reboot
This data type is used as a response element in the ModifyDBInstance action.
", + "refs": { + "DBInstance$PendingModifiedValues": "Specifies that changes to the DB Instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
" + } + }, + "PointInTimeRestoreNotEnabledFault": { + "base": "SourceDBInstanceIdentifier refers to a DB instance with BackupRetentionPeriod equal to 0.
", + "refs": { + } + }, + "PromoteReadReplicaMessage": { + "base": "", + "refs": { + } + }, + "PromoteReadReplicaResult": { + "base": null, + "refs": { + } + }, + "ProvisionedIopsNotAvailableInAZFault": { + "base": "
Provisioned IOPS not available in the specified Availability Zone.
", + "refs": { + } + }, + "PurchaseReservedDBInstancesOfferingMessage": { + "base": "", + "refs": { + } + }, + "PurchaseReservedDBInstancesOfferingResult": { + "base": null, + "refs": { + } + }, + "ReadReplicaDBInstanceIdentifierList": { + "base": null, + "refs": { + "DBInstance$ReadReplicaDBInstanceIdentifiers": "
Contains one or more identifiers of the Read Replicas associated with this DB Instance.
" + } + }, + "RebootDBInstanceMessage": { + "base": "", + "refs": { + } + }, + "RebootDBInstanceResult": { + "base": null, + "refs": { + } + }, + "RecurringCharge": { + "base": "
This data type is used as a response element in the DescribeReservedDBInstances and DescribeReservedDBInstancesOfferings actions.
", + "refs": { + "RecurringChargeList$member": null + } + }, + "RecurringChargeList": { + "base": null, + "refs": { + "ReservedDBInstance$RecurringCharges": "The recurring price charged to run this reserved DB Instance.
", + "ReservedDBInstancesOffering$RecurringCharges": "The recurring price charged to run this reserved DB Instance.
" + } + }, + "RemoveSourceIdentifierFromSubscriptionMessage": { + "base": "", + "refs": { + } + }, + "RemoveSourceIdentifierFromSubscriptionResult": { + "base": null, + "refs": { + } + }, + "RemoveTagsFromResourceMessage": { + "base": "", + "refs": { + } + }, + "ReservedDBInstance": { + "base": "This data type is used as a response element in the DescribeReservedDBInstances and PurchaseReservedDBInstancesOffering actions.
", + "refs": { + "PurchaseReservedDBInstancesOfferingResult$ReservedDBInstance": null, + "ReservedDBInstanceList$member": null + } + }, + "ReservedDBInstanceAlreadyExistsFault": { + "base": "User already has a reservation with the given identifier.
", + "refs": { + } + }, + "ReservedDBInstanceList": { + "base": null, + "refs": { + "ReservedDBInstanceMessage$ReservedDBInstances": "A list of of reserved DB Instances.
" + } + }, + "ReservedDBInstanceMessage": { + "base": "Contains the result of a successful invocation of the DescribeReservedDBInstances action.
", + "refs": { + } + }, + "ReservedDBInstanceNotFoundFault": { + "base": "The specified reserved DB Instance not found.
", + "refs": { + } + }, + "ReservedDBInstanceQuotaExceededFault": { + "base": "Request would exceed the user's DB Instance quota.
", + "refs": { + } + }, + "ReservedDBInstancesOffering": { + "base": "This data type is used as a response element in the DescribeReservedDBInstancesOfferings action.
", + "refs": { + "ReservedDBInstancesOfferingList$member": null + } + }, + "ReservedDBInstancesOfferingList": { + "base": null, + "refs": { + "ReservedDBInstancesOfferingMessage$ReservedDBInstancesOfferings": "A list of reserved DB Instance offerings.
" + } + }, + "ReservedDBInstancesOfferingMessage": { + "base": "Contains the result of a successful invocation of the DescribeReservedDBInstancesOfferings action.
", + "refs": { + } + }, + "ReservedDBInstancesOfferingNotFoundFault": { + "base": "Specified offering does not exist.
", + "refs": { + } + }, + "ResetDBParameterGroupMessage": { + "base": "", + "refs": { + } + }, + "RestoreDBInstanceFromDBSnapshotMessage": { + "base": "
", + "refs": { + } + }, + "RestoreDBInstanceFromDBSnapshotResult": { + "base": null, + "refs": { + } + }, + "RestoreDBInstanceToPointInTimeMessage": { + "base": "
", + "refs": { + } + }, + "RestoreDBInstanceToPointInTimeResult": { + "base": null, + "refs": { + } + }, + "RevokeDBSecurityGroupIngressMessage": { + "base": "
", + "refs": { + } + }, + "RevokeDBSecurityGroupIngressResult": { + "base": null, + "refs": { + } + }, + "SNSInvalidTopicFault": { + "base": "
SNS has responded that there is a problem with the SND topic specified.
", + "refs": { + } + }, + "SNSNoAuthorizationFault": { + "base": "You do not have permission to publish to the SNS topic ARN.
", + "refs": { + } + }, + "SNSTopicArnNotFoundFault": { + "base": "The SNS topic ARN does not exist.
", + "refs": { + } + }, + "SnapshotQuotaExceededFault": { + "base": "Request would result in user exceeding the allowed number of DB snapshots.
", + "refs": { + } + }, + "SourceIdsList": { + "base": null, + "refs": { + "CreateEventSubscriptionMessage$SourceIds": "The list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens.
Constraints:
A list of source Ids for the RDS event notification subscription.
" + } + }, + "SourceNotFoundFault": { + "base": "The requested source could not be found.
", + "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 source type for this event.
" + } + }, + "StorageQuotaExceededFault": { + "base": "Request would result in user exceeding the allowed amount of storage available across all DB instances.
", + "refs": { + } + }, + "String": { + "base": null, + "refs": { + "AddSourceIdentifierToSubscriptionMessage$SubscriptionName": "The name of the RDS event notification subscription you want to add a source identifier to.
", + "AddSourceIdentifierToSubscriptionMessage$SourceIdentifier": "The identifier of the event source to be added. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens.
Constraints:
The DB Instance the tags will be added to. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).
", + "AuthorizeDBSecurityGroupIngressMessage$DBSecurityGroupName": "The name of the DB Security Group to add authorization to.
", + "AuthorizeDBSecurityGroupIngressMessage$CIDRIP": "The IP range to authorize.
", + "AuthorizeDBSecurityGroupIngressMessage$EC2SecurityGroupName": " Name of the EC2 Security Group to authorize. For VPC DB Security Groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
Id of the EC2 Security Group to authorize. For VPC DB Security Groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
AWS Account Number of the owner of the EC2 Security Group specified in the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value. For VPC DB Security Groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
The name of the availability zone.
", + "CharacterSet$CharacterSetName": "The name of the character set.
", + "CharacterSet$CharacterSetDescription": "The description of the character set.
", + "CopyDBSnapshotMessage$SourceDBSnapshotIdentifier": "The identifier for the source DB snapshot.
Constraints:
Example: rds:mydb-2012-04-02-00-01
The identifier for the copied snapshot.
Constraints:
Example: my-db-snapshot
The meaning of this parameter differs according to the database engine you use.
MySQL
The name of the database to create when the DB Instance is created. If this parameter is not specified, no database is created in the DB Instance.
Constraints:
Type: String
Oracle
The Oracle System ID (SID) of the created DB Instance.
Default: ORCL
Constraints:
SQL Server
Not applicable. Must be null.
", + "CreateDBInstanceMessage$DBInstanceIdentifier": "The DB Instance identifier. This parameter is stored as a lowercase string.
Constraints:
Example: mydbinstance
The compute and memory capacity of the DB Instance.
Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge
The name of the database engine to be used for this instance.
Valid Values: MySQL | oracle-se1 | oracle-se | oracle-ee | sqlserver-ee | sqlserver-se | sqlserver-ex | sqlserver-web
The name of master user for the client DB Instance.
MySQL
Constraints:
Type: String
Oracle
Constraints:
SQL Server
Constraints:
The password for the master database user. Can be any printable ASCII character except \"/\", \"\\\", or \"@\".
Type: String
MySQL
Constraints: Must contain from 8 to 41 alphanumeric characters.
Oracle
Constraints: Must contain from 8 to 30 alphanumeric characters.
SQL Server
Constraints: Must contain from 8 to 128 alphanumeric characters.
", + "CreateDBInstanceMessage$AvailabilityZone": "The EC2 Availability Zone that the database instance will be created in.
Default: A random, system-chosen Availability Zone in the endpoint's region.
Example: us-east-1d
Constraint: The AvailabilityZone parameter cannot be specified if the MultiAZ parameter is set to true. The specified Availability Zone must be in the same region as the current endpoint.
A DB Subnet Group to associate with this DB Instance.
If there is no DB Subnet Group, then it is a non-VPC DB instance.
", + "CreateDBInstanceMessage$PreferredMaintenanceWindow": "The weekly time range (in UTC) during which system maintenance can occur.
Format: ddd:hh24:mi-ddd:hh24:mi
Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
", + "CreateDBInstanceMessage$DBParameterGroupName": "The name of the DB Parameter Group to associate with this DB instance. If this argument is omitted, the default DBParameterGroup for the specified engine will be used.
Constraints:
The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.
Default: A 30-minute window selected at random from an 8-hour block of time per region. The following list shows the time blocks for each region from which the default backup windows are assigned.
Constraints: Must be in the format hh24:mi-hh24:mi. Times should be Universal Time Coordinated (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes.
The version number of the database engine to use.
MySQL
Example: 5.1.42
Type: String
Oracle
Example: 11.2.0.2.v2
Type: String
SQL Server
Example: 10.50.2789.0.v1
License model information for this DB Instance.
Valid values: license-included | bring-your-own-license | general-public-license
Indicates that the DB Instance should be associated with the specified option group.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
", + "CreateDBInstanceMessage$CharacterSetName": "For supported engines, indicates that the DB Instance should be associated with the specified CharacterSet.
", + "CreateDBInstanceReadReplicaMessage$DBInstanceIdentifier": "The DB Instance identifier of the Read Replica. This is the unique key that identifies a DB Instance. This parameter is stored as a lowercase string.
", + "CreateDBInstanceReadReplicaMessage$SourceDBInstanceIdentifier": "The identifier of the DB Instance that will act as the source for the Read Replica. Each DB Instance can have up to five Read Replicas.
Constraints: Must be the identifier of an existing DB Instance that is not already a Read Replica DB Instance.
", + "CreateDBInstanceReadReplicaMessage$DBInstanceClass": "The compute and memory capacity of the Read Replica.
Valid Values: db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge
Default: Inherits from the source DB Instance.
", + "CreateDBInstanceReadReplicaMessage$AvailabilityZone": "The Amazon EC2 Availability Zone that the Read Replica will be created in.
Default: A random, system-chosen Availability Zone in the endpoint's region.
Example: us-east-1d
The option group the DB instance will be associated with. If omitted, the default Option Group for the engine specified will be used.
", + "CreateDBParameterGroupMessage$DBParameterGroupName": "The name of the DB Parameter Group.
Constraints:
The DB Parameter Group Family name. A DB Parameter Group can be associated with one and only one DB Parameter Group Family, and can be applied only to a DB Instance running a database engine and engine version compatible with that DB Parameter Group Family.
", + "CreateDBParameterGroupMessage$Description": "The description for the DB Parameter Group.
", + "CreateDBSecurityGroupMessage$DBSecurityGroupName": "The name for the DB Security Group. This value is stored as a lowercase string.
Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Must not be \"Default\".
Example: mysecuritygroup
The description for the DB Security Group.
", + "CreateDBSnapshotMessage$DBSnapshotIdentifier": "The identifier for the DB Snapshot.
Constraints:
Example: my-snapshot-id
The DB Instance identifier. This is the unique key that identifies a DB Instance. This parameter isn't case sensitive.
Constraints:
The name for the DB Subnet Group. This value is stored as a lowercase string.
Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Must not be \"Default\".
Example: mySubnetgroup
The description for the DB Subnet Group.
", + "CreateEventSubscriptionMessage$SubscriptionName": "The name of the subscription.
Constraints: The name must be less than 255 characters.
", + "CreateEventSubscriptionMessage$SnsTopicArn": "The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.
", + "CreateEventSubscriptionMessage$SourceType": "The type of source that will be generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned.
Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot
", + "CreateOptionGroupMessage$OptionGroupName": "Specifies the name of the option group to be created.
Constraints:
Example: myOptiongroup
Specifies the name of the engine that this option group should be associated with.
", + "CreateOptionGroupMessage$MajorEngineVersion": "Specifies the major version of the engine that this option group should be associated with.
", + "CreateOptionGroupMessage$OptionGroupDescription": "The description of the option group.
", + "DBEngineVersion$Engine": "The name of the database engine.
", + "DBEngineVersion$EngineVersion": "The version number of the database engine.
", + "DBEngineVersion$DBParameterGroupFamily": "The name of the DBParameterGroupFamily for the database engine.
", + "DBEngineVersion$DBEngineDescription": "The description of the database engine.
", + "DBEngineVersion$DBEngineVersionDescription": "The description of the database engine version.
", + "DBEngineVersionMessage$Marker": " An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
Contains a user-supplied database identifier. This is the unique key that identifies a DB Instance.
", + "DBInstance$DBInstanceClass": "Contains the name of the compute and memory capacity class of the DB Instance.
", + "DBInstance$Engine": "Provides the name of the database engine to be used for this DB Instance.
", + "DBInstance$DBInstanceStatus": "Specifies the current state of this database.
", + "DBInstance$MasterUsername": "Contains the master username for the DB Instance.
", + "DBInstance$DBName": "The meaning of this parameter differs according to the database engine you use.
MySQL
Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB Instance was created. This same name is returned for the life of the DB Instance.
Type: String
Oracle
Contains the Oracle System ID (SID) of the created DB Instance.
", + "DBInstance$PreferredBackupWindow": " Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
Specifies the name of the Availability Zone the DB Instance is located in.
", + "DBInstance$PreferredMaintenanceWindow": "Specifies the weekly time range (in UTC) during which system maintenance can occur.
", + "DBInstance$EngineVersion": "Indicates the database engine version.
", + "DBInstance$ReadReplicaSourceDBInstanceIdentifier": "Contains the identifier of the source DB Instance if this DB Instance is a Read Replica.
", + "DBInstance$LicenseModel": "License model information for this DB Instance.
", + "DBInstance$CharacterSetName": "If present, specifies the name of the character set that this instance is associated with.
", + "DBInstance$SecondaryAvailabilityZone": "If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
", + "DBInstanceMessage$Marker": " An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
Provides the name of the DB Parameter Group.
", + "DBParameterGroup$DBParameterGroupFamily": "Provides the name of the DB Parameter Group Family that this DB Parameter Group is compatible with.
", + "DBParameterGroup$Description": "Provides the customer-specified description for this DB Parameter Group.
", + "DBParameterGroupDetails$Marker": " An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of the DB Parameter Group.
", + "DBParameterGroupStatus$DBParameterGroupName": "The name of the DP Parameter Group.
", + "DBParameterGroupStatus$ParameterApplyStatus": "The status of parameter updates.
", + "DBParameterGroupsMessage$Marker": " An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
Provides the AWS ID of the owner of a specific DB Security Group.
", + "DBSecurityGroup$DBSecurityGroupName": "Specifies the name of the DB Security Group.
", + "DBSecurityGroup$DBSecurityGroupDescription": "Provides the description of the DB Security Group.
", + "DBSecurityGroup$VpcId": "Provides the VpcId of the DB Security Group.
", + "DBSecurityGroupMembership$DBSecurityGroupName": "The name of the DB Security Group.
", + "DBSecurityGroupMembership$Status": "The status of the DB Security Group.
", + "DBSecurityGroupMessage$Marker": " An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
Specifies the identifier for the DB Snapshot.
", + "DBSnapshot$DBInstanceIdentifier": "Specifies the the DBInstanceIdentifier of the DB Instance this DB Snapshot was created from.
", + "DBSnapshot$Engine": "Specifies the name of the database engine.
", + "DBSnapshot$Status": "Specifies the status of this DB Snapshot.
", + "DBSnapshot$AvailabilityZone": "Specifies the name of the Availability Zone the DB Instance was located in at the time of the DB Snapshot.
", + "DBSnapshot$VpcId": "Provides the Vpc Id associated with the DB Snapshot.
", + "DBSnapshot$MasterUsername": "Provides the master username for the DB Snapshot.
", + "DBSnapshot$EngineVersion": "Specifies the version of the database engine.
", + "DBSnapshot$LicenseModel": "License model information for the restored DB Instance.
", + "DBSnapshot$SnapshotType": "Provides the type of the DB Snapshot.
", + "DBSnapshot$OptionGroupName": "Provides the option group name for the DB Snapshot.
", + "DBSnapshotMessage$Marker": " An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
Specifies the name of the DB Subnet Group.
", + "DBSubnetGroup$DBSubnetGroupDescription": "Provides the description of the DB Subnet Group.
", + "DBSubnetGroup$VpcId": "Provides the VpcId of the DB Subnet Group.
", + "DBSubnetGroup$SubnetGroupStatus": "Provides the status of the DB Subnet Group.
", + "DBSubnetGroupMessage$Marker": " An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The DB Instance identifier for the DB Instance to be deleted. This parameter isn't case sensitive.
Constraints:
The DBSnapshotIdentifier of the new DBSnapshot created when SkipFinalSnapshot is set to false.
Constraints:
The name of the DB Parameter Group.
Constraints:
The name of the DB Security Group to delete.
Constraints:
The DBSnapshot identifier.
Constraints: Must be the name of an existing DB Snapshot in the available state.
The name of the database subnet group to delete.
Constraints:
The name of the RDS event notification subscription you want to delete.
", + "DeleteOptionGroupMessage$OptionGroupName": "The name of the option group to be deleted.
The database engine to return.
", + "DescribeDBEngineVersionsMessage$EngineVersion": "The database engine version to return.
Example: 5.1.49
The name of a specific DB Parameter Group family to return details for.
Constraints:
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The user-supplied instance identifier. If this parameter is specified, information from only the specific DB Instance is returned. This parameter isn't case sensitive.
Constraints:
An optional pagination token provided by a previous DescribeDBInstances request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
The name of the log file for the specified DB instance.
", + "DescribeDBLogFilesMessage$DBInstanceIdentifier": "The customer-assigned name of the DB Instance that contains the log files you want to list.
Constraints:
Filters the available log files for log file names that contain the specified string.
", + "DescribeDBLogFilesMessage$Marker": "The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.
", + "DescribeDBLogFilesResponse$Marker": "An optional paging token.
", + "DescribeDBParameterGroupsMessage$DBParameterGroupName": "The name of a specific DB Parameter Group to return details for.
Constraints:
An optional pagination token provided by a previous DescribeDBParameterGroups request. 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 DB Parameter Group to return details for.
Constraints:
The parameter types to return.
Default: All parameter types returned
Valid Values: user | system | engine-default
An optional pagination token provided by a previous DescribeDBParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of the DB Security Group to return details for.
", + "DescribeDBSecurityGroupsMessage$Marker": " An optional pagination token provided by a previous DescribeDBSecurityGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
A DB Instance Identifier to retrieve the list of DB Snapshots for. Cannot be used in conjunction with DBSnapshotIdentifier. This parameter isn't case sensitive.
Constraints:
A specific DB Snapshot Identifier to describe. Cannot be used in conjunction with DBInstanceIdentifier. This value is stored as a lowercase string.
Constraints:
SnapshotType parameter must also be specified.An optional snapshot type for which snapshots will be returned. If not specified, the returned results will include snapshots of all types.
", + "DescribeDBSnapshotsMessage$Marker": " An optional pagination token provided by a previous DescribeDBSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of the DB Subnet Group to return details for.
", + "DescribeDBSubnetGroupsMessage$Marker": " An optional pagination token provided by a previous DescribeDBSubnetGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of the DB Parameter Group Family.
", + "DescribeEngineDefaultParametersMessage$Marker": " An optional pagination token provided by a previous DescribeEngineDefaultParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The type of source that will be generating the events.
Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot
", + "DescribeEventSubscriptionsMessage$SubscriptionName": "The name of the RDS event notification subscription you want to describe.
", + "DescribeEventSubscriptionsMessage$Marker": " An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. 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 will be returned. If not specified, then all sources are included in the response.
Constraints:
An optional pagination token provided by a previous DescribeEvents request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
A required parameter. Options available for the given Engine name will be described.
", + "DescribeOptionGroupOptionsMessage$MajorEngineVersion": "If specified, filters the results to include only options for the specified major engine version.
", + "DescribeOptionGroupOptionsMessage$Marker": "An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of the option group to describe. Cannot be supplied together with EngineName or MajorEngineVersion.
", + "DescribeOptionGroupsMessage$Marker": " An optional pagination token provided by a previous DescribeOptionGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
Filters the list of option groups to only include groups associated with a specific database engine.
", + "DescribeOptionGroupsMessage$MajorEngineVersion": "Filters the list of option groups to only include groups associated with a specific database engine version. If specified, then EngineName must also be specified.
", + "DescribeOrderableDBInstanceOptionsMessage$Engine": "The name of the engine to retrieve DB Instance options for.
", + "DescribeOrderableDBInstanceOptionsMessage$EngineVersion": "The engine version filter value. Specify this parameter to show only the available offerings matching the specified engine version.
", + "DescribeOrderableDBInstanceOptionsMessage$DBInstanceClass": "The DB Instance class filter value. Specify this parameter to show only the available offerings matching the specified DB Instance class.
", + "DescribeOrderableDBInstanceOptionsMessage$LicenseModel": "The license model filter value. Specify this parameter to show only the available offerings matching the specified license model.
", + "DescribeOrderableDBInstanceOptionsMessage$Marker": " An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
The reserved DB Instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID.
", + "DescribeReservedDBInstancesMessage$ReservedDBInstancesOfferingId": "The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.
", + "DescribeReservedDBInstancesMessage$DBInstanceClass": "The DB Instance class filter value. Specify this parameter to show only those reservations matching the specified DB Instances class.
", + "DescribeReservedDBInstancesMessage$Duration": "The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.
Valid Values: 1 | 3 | 31536000 | 94608000
The product description filter value. Specify this parameter to show only those reservations matching the specified product description.
", + "DescribeReservedDBInstancesMessage$OfferingType": "The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.
Valid Values: \"Light Utilization\" | \"Medium Utilization\" | \"Heavy Utilization\"
An optional pagination token provided by a previous request. 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. Specify this parameter to show only the available offering that matches the specified reservation identifier.
Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
The DB Instance class filter value. Specify this parameter to show only the available offerings matching the specified DB Instance class.
", + "DescribeReservedDBInstancesOfferingsMessage$Duration": "Duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.
Valid Values: 1 | 3 | 31536000 | 94608000
Product description filter value. Specify this parameter to show only the available offerings matching the specified product description.
", + "DescribeReservedDBInstancesOfferingsMessage$OfferingType": "The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.
Valid Values: \"Light Utilization\" | \"Medium Utilization\" | \"Heavy Utilization\"
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
Entries from the specified log file.
", + "DownloadDBLogFilePortionDetails$Marker": "An optional pagination token provided by a previous DownloadDBLogFilePortion request.
", + "DownloadDBLogFilePortionMessage$DBInstanceIdentifier": "The customer-assigned name of the DB Instance that contains the log files you want to list.
Constraints:
The name of the log file to be downloaded.
", + "DownloadDBLogFilePortionMessage$Marker": "The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.
", + "EC2SecurityGroup$Status": "Provides the status of the EC2 security group. Status can be \"authorizing\", \"authorized\", \"revoking\", and \"revoked\".
", + "EC2SecurityGroup$EC2SecurityGroupName": "Specifies the name of the EC2 Security Group.
", + "EC2SecurityGroup$EC2SecurityGroupId": "Specifies the id of the EC2 Security Group.
", + "EC2SecurityGroup$EC2SecurityGroupOwnerId": " Specifies the AWS ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field.
Specifies the DNS address of the DB Instance.
", + "EngineDefaults$DBParameterGroupFamily": "Specifies the name of the DB Parameter Group Family which the engine default parameters apply to.
", + "EngineDefaults$Marker": " An optional pagination token provided by a previous EngineDefaults request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
Provides the identifier for the source of the event.
", + "Event$Message": "Provides the text of this event.
", + "EventCategoriesList$member": null, + "EventCategoriesMap$SourceType": "The source type that the returned categories belong to
", + "EventSubscription$CustomerAwsId": "The AWS customer account associated with the RDS event notification subscription.
", + "EventSubscription$CustSubscriptionId": "The RDS event notification subscription Id.
", + "EventSubscription$SnsTopicArn": "The topic ARN of the RDS event notification subscription.
", + "EventSubscription$Status": "The status of the RDS event notification subscription.
Constraints:
Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist
The status \"no-permission\" indicates that RDS no longer has permission to post to the SNS topic. The status \"topic-not-exist\" indicates that the topic was deleted after the subscription was created.
", + "EventSubscription$SubscriptionCreationTime": "The time the RDS event notification subscription was created.
", + "EventSubscription$SourceType": "The source type for the RDS event notification subscription.
", + "EventSubscriptionsMessage$Marker": " An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
An optional pagination token provided by a previous Events request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
Specifies the status of the IP range. Status can be \"authorizing\", \"authorized\", \"revoking\", and \"revoked\".
", + "IPRange$CIDRIP": "Specifies the IP range.
", + "KeyList$member": null, + "ListTagsForResourceMessage$ResourceName": "The DB Instance with tags to be listed. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).
", + "ModifyDBInstanceMessage$DBInstanceIdentifier": "The DB Instance identifier. This value is stored as a lowercase string.
Constraints:
The new compute and memory capacity of the DB Instance. To determine the instance classes that are available for a particular DB engine, use the DescribeOrderableDBInstanceOptions action.
Passing a value for this parameter causes an outage during the change and is applied during the next maintenance window, unless the ApplyImmediately parameter is specified as true for this request.
Default: Uses existing setting
Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge | db.m2.2xlarge | db.m2.4xlarge
The new password for the DB Instance master user. Can be any printable ASCII character except \"/\", \"\\\", or \"@\".
Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.
Default: Uses existing setting
Constraints: Must be 8 to 41 alphanumeric characters (MySQL), 8 to 30 alphanumeric characters (Oracle), or 8 to 128 alphanumeric characters (SQL Server).
The name of the DB Parameter Group to apply to this DB Instance. Changing this parameter does not result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.
Default: Uses existing setting
Constraints: The DB Parameter Group must be in the same DB Parameter Group family as this DB Instance.
", + "ModifyDBInstanceMessage$PreferredBackupWindow": " The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.
Constraints:
The weekly time range (in UTC) during which system maintenance can occur, which may result in an outage. Changing this parameter does not result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, then changing this parameter will cause a reboot of the DB Instance. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied.
Default: Uses existing setting
Format: ddd:hh24:mi-ddd:hh24:mi
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Must be at least 30 minutes
", + "ModifyDBInstanceMessage$EngineVersion": " The version number of the database engine to upgrade to. Changing this parameter results in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.
For major version upgrades, if a nondefault DB Parameter Group is currently in use, a new DB Parameter Group in the DB Parameter Group Family for the new engine version must be specified. The new DB Parameter Group can be the default for that DB Parameter Group Family.
Example: 5.1.42
Indicates that the DB Instance should be associated with the specified option group. Changing this parameter does not result in an outage except in the following case and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
", + "ModifyDBInstanceMessage$NewDBInstanceIdentifier": "The new DB Instance identifier for the DB Instance when renaming a DB Instance. This value is stored as a lowercase string.
Constraints:
The name of the DB Parameter Group.
Constraints:
The name for the DB Subnet Group. This value is stored as a lowercase string.
Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Must not be \"Default\".
Example: mySubnetgroup
The description for the DB Subnet Group.
", + "ModifyEventSubscriptionMessage$SubscriptionName": "The name of the RDS event notification subscription.
", + "ModifyEventSubscriptionMessage$SnsTopicArn": "The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.
", + "ModifyEventSubscriptionMessage$SourceType": "The type of source that will be generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned.
Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot
", + "ModifyOptionGroupMessage$OptionGroupName": "The name of the option group to be modified.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
", + "Option$OptionName": "The name of the option.
", + "Option$OptionDescription": "The description of the option.
", + "OptionConfiguration$OptionName": "The configuration of options to include in a group.
", + "OptionGroup$OptionGroupName": "Specifies the name of the option group.
", + "OptionGroup$OptionGroupDescription": "Provides the description of the option group.
", + "OptionGroup$EngineName": "Engine name that this option group can be applied to.
", + "OptionGroup$MajorEngineVersion": "Indicates the major engine version associated with this option group.
", + "OptionGroup$VpcId": "If AllowsVpcAndNonVpcInstanceMemberships is 'false', this field is blank. If AllowsVpcAndNonVpcInstanceMemberships is 'true' and this field is blank, then this option group can be applied to both VPC and non-VPC instances. If this field contains a value, then this option group can only be applied to instances that are in the VPC indicated by this field.
", + "OptionGroupMembership$OptionGroupName": "The name of the option group that the instance belongs to.
", + "OptionGroupMembership$Status": "The status of the DB Instance's option group membership (e.g. in-sync, pending, pending-maintenance, applying).
", + "OptionGroupOption$Name": "The name of the option.
", + "OptionGroupOption$Description": "The description of the option.
", + "OptionGroupOption$EngineName": "Engine name that this option can be applied to.
", + "OptionGroupOption$MajorEngineVersion": "Indicates the major engine version that the option is available for.
", + "OptionGroupOption$MinimumRequiredMinorEngineVersion": "The minimum required engine version for the option to be applied.
", + "OptionGroupOptionSetting$SettingName": "The name of the option group option.
", + "OptionGroupOptionSetting$SettingDescription": "The description of the option group option.
", + "OptionGroupOptionSetting$DefaultValue": "The default value for the option group option.
", + "OptionGroupOptionSetting$ApplyType": "The DB engine specific parameter type for the option group option.
", + "OptionGroupOptionSetting$AllowedValues": "Indicates the acceptable values for the option group option.
", + "OptionGroupOptionsMessage$Marker": "An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of the option that has settings that you can set.
", + "OptionSetting$Value": "The current value of the option setting.
", + "OptionSetting$DefaultValue": "The default value of the option setting.
", + "OptionSetting$Description": "The description of the option setting.
", + "OptionSetting$ApplyType": "The DB engine specific parameter type.
", + "OptionSetting$DataType": "The data type of the option setting.
", + "OptionSetting$AllowedValues": "The allowed values of the option setting.
", + "OptionsDependedOn$member": null, + "OrderableDBInstanceOption$Engine": "The engine type of the orderable DB Instance.
", + "OrderableDBInstanceOption$EngineVersion": "The engine version of the orderable DB Instance.
", + "OrderableDBInstanceOption$DBInstanceClass": "The DB Instance Class for the orderable DB Instance
", + "OrderableDBInstanceOption$LicenseModel": "The license model for the orderable DB Instance.
", + "OrderableDBInstanceOptionsMessage$Marker": " An optional pagination token provided by a previous OrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
Specifies the name of the parameter.
", + "Parameter$ParameterValue": "Specifies the value of the parameter.
", + "Parameter$Description": "Provides a description of the parameter.
", + "Parameter$Source": "Indicates the source of the parameter value.
", + "Parameter$ApplyType": "Specifies the engine specific parameters type.
", + "Parameter$DataType": "Specifies the valid data type for the parameter.
", + "Parameter$AllowedValues": "Specifies the valid range of values for the parameter.
", + "Parameter$MinimumEngineVersion": "The earliest engine version to which the parameter can apply.
", + "PendingModifiedValues$DBInstanceClass": " Contains the new DBInstanceClass for the DB Instance that will be applied or is in progress.
Contains the pending or in-progress change of the master credentials for the DB Instance.
", + "PendingModifiedValues$EngineVersion": "Indicates the database engine version.
", + "PendingModifiedValues$DBInstanceIdentifier": " Contains the new DBInstanceIdentifier for the DB Instance that will be applied or is in progress.
The DB Instance identifier. This value is stored as a lowercase string.
Constraints:
Example:
The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.
Default: A 30-minute window selected at random from an 8-hour block of time per region. The following list shows the time blocks for each region from which the default backup windows are assigned.
Constraints: Must be in the format hh24:mi-hh24:mi. Times should be Universal Time Coordinated (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes.
The ID of the Reserved DB Instance offering to purchase.
Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
", + "PurchaseReservedDBInstancesOfferingMessage$ReservedDBInstanceId": "Customer-specified identifier to track this reservation.
Example: myreservationID
", + "ReadReplicaDBInstanceIdentifierList$member": null, + "RebootDBInstanceMessage$DBInstanceIdentifier": "The DB Instance identifier. This parameter is stored as a lowercase string.
Constraints:
The frequency of the recurring charge.
", + "RemoveSourceIdentifierFromSubscriptionMessage$SubscriptionName": "The name of the RDS event notification subscription you want to remove a source identifier from.
", + "RemoveSourceIdentifierFromSubscriptionMessage$SourceIdentifier": "The source identifier to be removed from the subscription, such as the DB instance identifier for a DB instance or the name of a security group.
", + "RemoveTagsFromResourceMessage$ResourceName": "The DB Instance the tags will be removed from. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).
", + "ReservedDBInstance$ReservedDBInstanceId": "The unique identifier for the reservation.
", + "ReservedDBInstance$ReservedDBInstancesOfferingId": "The offering identifier.
", + "ReservedDBInstance$DBInstanceClass": "The DB instance class for the reserved DB Instance.
", + "ReservedDBInstance$CurrencyCode": "The currency code for the reserved DB Instance.
", + "ReservedDBInstance$ProductDescription": "The description of the reserved DB Instance.
", + "ReservedDBInstance$OfferingType": "The offering type of this reserved DB Instance.
", + "ReservedDBInstance$State": "The state of the reserved DB Instance.
", + "ReservedDBInstanceMessage$Marker": " An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The offering identifier.
", + "ReservedDBInstancesOffering$DBInstanceClass": "The DB instance class for the reserved DB Instance.
", + "ReservedDBInstancesOffering$CurrencyCode": "The currency code for the reserved DB Instance offering.
", + "ReservedDBInstancesOffering$ProductDescription": "The database engine used by the offering.
", + "ReservedDBInstancesOffering$OfferingType": "The offering type.
", + "ReservedDBInstancesOfferingMessage$Marker": " An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of the DB Parameter Group.
Constraints:
The identifier for the DB Snapshot to restore from.
Constraints:
Name of the DB Instance to create from the DB Snapshot. This parameter isn't case sensitive.
Constraints:
Example: my-snapshot-id
The compute and memory capacity of the Amazon RDS DB instance.
Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge
The EC2 Availability Zone that the database instance will be created in.
Default: A random, system-chosen Availability Zone.
Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.
Example: us-east-1a
The DB Subnet Group name to use for the new instance.
", + "RestoreDBInstanceFromDBSnapshotMessage$LicenseModel": "License model information for the restored DB Instance.
Default: Same as source.
Valid values: license-included | bring-your-own-license | general-public-license
The database name for the restored DB Instance.
This parameter doesn't apply to the MySQL engine.
The database engine to use for the new instance.
Default: The same as source
Constraint: Must be compatible with the engine of the source
Example: oracle-ee
The name of the option group to be used for the restored DB instance.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
", + "RestoreDBInstanceToPointInTimeMessage$SourceDBInstanceIdentifier": "The identifier of the source DB Instance from which to restore.
Constraints:
The name of the new database instance to be created.
Constraints:
The compute and memory capacity of the Amazon RDS DB instance.
Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge
Default: The same DBInstanceClass as the original DB Instance.
", + "RestoreDBInstanceToPointInTimeMessage$AvailabilityZone": "The EC2 Availability Zone that the database instance will be created in.
Default: A random, system-chosen Availability Zone.
Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.
Example: us-east-1a
The DB subnet group name to use for the new instance.
", + "RestoreDBInstanceToPointInTimeMessage$LicenseModel": "License model information for the restored DB Instance.
Default: Same as source.
Valid values: license-included | bring-your-own-license | general-public-license
The database name for the restored DB Instance.
This parameter is not used for the MySQL engine.
The database engine to use for the new instance.
Default: The same as source
Constraint: Must be compatible with the engine of the source
Example: oracle-ee
The name of the option group to be used for the restored DB instance.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
", + "RevokeDBSecurityGroupIngressMessage$DBSecurityGroupName": "The name of the DB Security Group to revoke ingress from.
", + "RevokeDBSecurityGroupIngressMessage$CIDRIP": " The IP range to revoke access from. Must be a valid CIDR range. If CIDRIP is specified, EC2SecurityGroupName, EC2SecurityGroupId and EC2SecurityGroupOwnerId cannot be provided.
The name of the EC2 Security Group to revoke access from. For VPC DB Security Groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
The id of the EC2 Security Group to revoke access from. For VPC DB Security Groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
The AWS Account Number of the owner of the EC2 security group specified in the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value. For VPC DB Security Groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
Specifies the identifier of the subnet.
", + "Subnet$SubnetStatus": "Specifies the status of the subnet.
", + "SubnetIdentifierList$member": null, + "Tag$Key": "A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and cannot be prefixed with \"aws:\". The string may only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").
", + "Tag$Value": "A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and cannot be prefixed with \"aws:\". The string may only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").
", + "VpcSecurityGroupIdList$member": null, + "VpcSecurityGroupMembership$VpcSecurityGroupId": "The name of the VPC security group.
", + "VpcSecurityGroupMembership$Status": "The status of the VPC Security Group.
" + } + }, + "Subnet": { + "base": "This data type is used as a response element in the DescribeDBSubnetGroups action.
", + "refs": { + "SubnetList$member": null + } + }, + "SubnetAlreadyInUse": { + "base": "The DB subnet is already in use in the Availability Zone.
", + "refs": { + } + }, + "SubnetIdentifierList": { + "base": null, + "refs": { + "CreateDBSubnetGroupMessage$SubnetIds": "The EC2 Subnet IDs for the DB Subnet Group.
", + "ModifyDBSubnetGroupMessage$SubnetIds": "The EC2 Subnet IDs for the DB Subnet Group.
" + } + }, + "SubnetList": { + "base": null, + "refs": { + "DBSubnetGroup$Subnets": "Contains a list of Subnet elements.
" + } + }, + "SubscriptionAlreadyExistFault": { + "base": "The supplied subscription name already exists.
", + "refs": { + } + }, + "SubscriptionCategoryNotFoundFault": { + "base": "The supplied category does not exist.
", + "refs": { + } + }, + "SubscriptionNotFoundFault": { + "base": "The subscription name does not exist.
", + "refs": { + } + }, + "SupportedCharacterSetsList": { + "base": null, + "refs": { + "DBEngineVersion$SupportedCharacterSets": " A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance API.
Provides the date and time the DB Instance was created.
", + "DBInstance$LatestRestorableTime": "Specifies the latest time to which a database can be restored with point-in-time restore.
", + "DBSnapshot$SnapshotCreateTime": "Provides the time (UTC) when the snapshot was taken.
", + "DBSnapshot$InstanceCreateTime": "Specifies the time (UTC) when the snapshot was taken.
", + "DescribeEventsMessage$StartTime": "The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2009-07-08T18:00Z
", + "DescribeEventsMessage$EndTime": "The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2009-07-08T18:00Z
", + "Event$Date": "Specifies the date and time of the event.
", + "ReservedDBInstance$StartTime": "The time the reservation started.
", + "RestoreDBInstanceToPointInTimeMessage$RestoreTime": "The date and time to restore from.
Valid Values: Value must be a UTC time
Constraints:
Example: 2009-09-07T23:45:00Z
Metadata assigned to a DB Instance consisting of a key-value pair.
", + "refs": { + "TagList$member": null + } + }, + "TagList": { + "base": "A list of tags.
", + "refs": { + "AddTagsToResourceMessage$Tags": "The tags to be assigned to the DB Instance.
", + "TagListMessage$TagList": "List of tags returned by the ListTagsForResource operation.
" + } + }, + "TagListMessage": { + "base": "", + "refs": { + } + }, + "VpcSecurityGroupIdList": { + "base": null, + "refs": { + "CreateDBInstanceMessage$VpcSecurityGroupIds": "A list of EC2 VPC Security Groups to associate with this DB Instance.
Default: The default EC2 VPC Security Group for the DB Subnet group's VPC.
", + "ModifyDBInstanceMessage$VpcSecurityGroupIds": "A list of EC2 VPC Security Groups to authorize on this DB Instance. This change is asynchronously applied as soon as possible.
Constraints:
A list of VpcSecurityGroupMemebrship name strings used for this option.
" + } + }, + "VpcSecurityGroupMembership": { + "base": "This data type is used as a response element for queries on VPC security group membership.
", + "refs": { + "VpcSecurityGroupMembershipList$member": null + } + }, + "VpcSecurityGroupMembershipList": { + "base": null, + "refs": { + "DBInstance$VpcSecurityGroups": "Provides List of VPC security group elements that the DB Instance belongs to.
", + "Option$VpcSecurityGroupMemberships": "If the option requires access to a port, then this VPC Security Group allows access to the port.
" + } + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/rds/2013-02-12/examples-1.json b/vendor/github.com/aws/aws-sdk-go/models/apis/rds/2013-02-12/examples-1.json new file mode 100644 index 000000000..0ea7e3b0b --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/rds/2013-02-12/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/rds/2013-02-12/paginators-1.json b/vendor/github.com/aws/aws-sdk-go/models/apis/rds/2013-02-12/paginators-1.json new file mode 100644 index 000000000..662845c12 --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/rds/2013-02-12/paginators-1.json @@ -0,0 +1,110 @@ +{ + "pagination": { + "DescribeDBEngineVersions": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "DBEngineVersions" + }, + "DescribeDBInstances": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "DBInstances" + }, + "DescribeDBLogFiles": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "DescribeDBLogFiles" + }, + "DescribeDBParameterGroups": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "DBParameterGroups" + }, + "DescribeDBParameters": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "Parameters" + }, + "DescribeDBSecurityGroups": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "DBSecurityGroups" + }, + "DescribeDBSnapshots": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "DBSnapshots" + }, + "DescribeDBSubnetGroups": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "DBSubnetGroups" + }, + "DescribeEngineDefaultParameters": { + "input_token": "Marker", + "output_token": "EngineDefaults.Marker", + "limit_key": "MaxRecords", + "result_key": "EngineDefaults.Parameters" + }, + "DescribeEventSubscriptions": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "EventSubscriptionsList" + }, + "DescribeEvents": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "Events" + }, + "DescribeOptionGroupOptions": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "OptionGroupOptions" + }, + "DescribeOptionGroups": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "OptionGroupsList" + }, + "DescribeOrderableDBInstanceOptions": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "OrderableDBInstanceOptions" + }, + "DescribeReservedDBInstances": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "ReservedDBInstances" + }, + "DescribeReservedDBInstancesOfferings": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "ReservedDBInstancesOfferings" + }, + "DownloadDBLogFilePortion": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "NumberOfLines", + "more_results": "AdditionalDataPending", + "result_key": "LogFileData" + }, + "ListTagsForResource": { + "result_key": "TagList" + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/rds/2013-09-09/api-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/rds/2013-09-09/api-2.json new file mode 100644 index 000000000..264239184 --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/rds/2013-09-09/api-2.json @@ -0,0 +1,3158 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2013-09-09", + "endpointPrefix":"rds", + "protocol":"query", + "serviceAbbreviation":"Amazon RDS", + "serviceFullName":"Amazon Relational Database Service", + "signatureVersion":"v4", + "xmlNamespace":"http://rds.amazonaws.com/doc/2013-09-09/" + }, + "operations":{ + "AddSourceIdentifierToSubscription":{ + "name":"AddSourceIdentifierToSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddSourceIdentifierToSubscriptionMessage"}, + "output":{ + "shape":"AddSourceIdentifierToSubscriptionResult", + "resultWrapper":"AddSourceIdentifierToSubscriptionResult" + }, + "errors":[ + {"shape":"SubscriptionNotFoundFault"}, + {"shape":"SourceNotFoundFault"} + ] + }, + "AddTagsToResource":{ + "name":"AddTagsToResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddTagsToResourceMessage"}, + "errors":[ + {"shape":"DBInstanceNotFoundFault"}, + {"shape":"DBSnapshotNotFoundFault"} + ] + }, + "AuthorizeDBSecurityGroupIngress":{ + "name":"AuthorizeDBSecurityGroupIngress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AuthorizeDBSecurityGroupIngressMessage"}, + "output":{ + "shape":"AuthorizeDBSecurityGroupIngressResult", + "resultWrapper":"AuthorizeDBSecurityGroupIngressResult" + }, + "errors":[ + {"shape":"DBSecurityGroupNotFoundFault"}, + {"shape":"InvalidDBSecurityGroupStateFault"}, + {"shape":"AuthorizationAlreadyExistsFault"}, + {"shape":"AuthorizationQuotaExceededFault"} + ] + }, + "CopyDBSnapshot":{ + "name":"CopyDBSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CopyDBSnapshotMessage"}, + "output":{ + "shape":"CopyDBSnapshotResult", + "resultWrapper":"CopyDBSnapshotResult" + }, + "errors":[ + {"shape":"DBSnapshotAlreadyExistsFault"}, + {"shape":"DBSnapshotNotFoundFault"}, + {"shape":"InvalidDBSnapshotStateFault"}, + {"shape":"SnapshotQuotaExceededFault"} + ] + }, + "CreateDBInstance":{ + "name":"CreateDBInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDBInstanceMessage"}, + "output":{ + "shape":"CreateDBInstanceResult", + "resultWrapper":"CreateDBInstanceResult" + }, + "errors":[ + {"shape":"DBInstanceAlreadyExistsFault"}, + {"shape":"InsufficientDBInstanceCapacityFault"}, + {"shape":"DBParameterGroupNotFoundFault"}, + {"shape":"DBSecurityGroupNotFoundFault"}, + {"shape":"InstanceQuotaExceededFault"}, + {"shape":"StorageQuotaExceededFault"}, + {"shape":"DBSubnetGroupNotFoundFault"}, + {"shape":"DBSubnetGroupDoesNotCoverEnoughAZs"}, + {"shape":"InvalidSubnet"}, + {"shape":"InvalidVPCNetworkStateFault"}, + {"shape":"ProvisionedIopsNotAvailableInAZFault"}, + {"shape":"OptionGroupNotFoundFault"} + ] + }, + "CreateDBInstanceReadReplica":{ + "name":"CreateDBInstanceReadReplica", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDBInstanceReadReplicaMessage"}, + "output":{ + "shape":"CreateDBInstanceReadReplicaResult", + "resultWrapper":"CreateDBInstanceReadReplicaResult" + }, + "errors":[ + {"shape":"DBInstanceAlreadyExistsFault"}, + {"shape":"InsufficientDBInstanceCapacityFault"}, + {"shape":"DBParameterGroupNotFoundFault"}, + {"shape":"DBSecurityGroupNotFoundFault"}, + {"shape":"InstanceQuotaExceededFault"}, + {"shape":"StorageQuotaExceededFault"}, + {"shape":"DBInstanceNotFoundFault"}, + {"shape":"InvalidDBInstanceStateFault"}, + {"shape":"DBSubnetGroupNotFoundFault"}, + {"shape":"DBSubnetGroupDoesNotCoverEnoughAZs"}, + {"shape":"InvalidSubnet"}, + {"shape":"InvalidVPCNetworkStateFault"}, + {"shape":"ProvisionedIopsNotAvailableInAZFault"}, + {"shape":"OptionGroupNotFoundFault"}, + {"shape":"DBSubnetGroupNotAllowedFault"}, + {"shape":"InvalidDBSubnetGroupFault"} + ] + }, + "CreateDBParameterGroup":{ + "name":"CreateDBParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDBParameterGroupMessage"}, + "output":{ + "shape":"CreateDBParameterGroupResult", + "resultWrapper":"CreateDBParameterGroupResult" + }, + "errors":[ + {"shape":"DBParameterGroupQuotaExceededFault"}, + {"shape":"DBParameterGroupAlreadyExistsFault"} + ] + }, + "CreateDBSecurityGroup":{ + "name":"CreateDBSecurityGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDBSecurityGroupMessage"}, + "output":{ + "shape":"CreateDBSecurityGroupResult", + "resultWrapper":"CreateDBSecurityGroupResult" + }, + "errors":[ + {"shape":"DBSecurityGroupAlreadyExistsFault"}, + {"shape":"DBSecurityGroupQuotaExceededFault"}, + {"shape":"DBSecurityGroupNotSupportedFault"} + ] + }, + "CreateDBSnapshot":{ + "name":"CreateDBSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDBSnapshotMessage"}, + "output":{ + "shape":"CreateDBSnapshotResult", + "resultWrapper":"CreateDBSnapshotResult" + }, + "errors":[ + {"shape":"DBSnapshotAlreadyExistsFault"}, + {"shape":"InvalidDBInstanceStateFault"}, + {"shape":"DBInstanceNotFoundFault"}, + {"shape":"SnapshotQuotaExceededFault"} + ] + }, + "CreateDBSubnetGroup":{ + "name":"CreateDBSubnetGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDBSubnetGroupMessage"}, + "output":{ + "shape":"CreateDBSubnetGroupResult", + "resultWrapper":"CreateDBSubnetGroupResult" + }, + "errors":[ + {"shape":"DBSubnetGroupAlreadyExistsFault"}, + {"shape":"DBSubnetGroupQuotaExceededFault"}, + {"shape":"DBSubnetQuotaExceededFault"}, + {"shape":"DBSubnetGroupDoesNotCoverEnoughAZs"}, + {"shape":"InvalidSubnet"} + ] + }, + "CreateEventSubscription":{ + "name":"CreateEventSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateEventSubscriptionMessage"}, + "output":{ + "shape":"CreateEventSubscriptionResult", + "resultWrapper":"CreateEventSubscriptionResult" + }, + "errors":[ + {"shape":"EventSubscriptionQuotaExceededFault"}, + {"shape":"SubscriptionAlreadyExistFault"}, + {"shape":"SNSInvalidTopicFault"}, + {"shape":"SNSNoAuthorizationFault"}, + {"shape":"SNSTopicArnNotFoundFault"}, + {"shape":"SubscriptionCategoryNotFoundFault"}, + {"shape":"SourceNotFoundFault"} + ] + }, + "CreateOptionGroup":{ + "name":"CreateOptionGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateOptionGroupMessage"}, + "output":{ + "shape":"CreateOptionGroupResult", + "resultWrapper":"CreateOptionGroupResult" + }, + "errors":[ + {"shape":"OptionGroupAlreadyExistsFault"}, + {"shape":"OptionGroupQuotaExceededFault"} + ] + }, + "DeleteDBInstance":{ + "name":"DeleteDBInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDBInstanceMessage"}, + "output":{ + "shape":"DeleteDBInstanceResult", + "resultWrapper":"DeleteDBInstanceResult" + }, + "errors":[ + {"shape":"DBInstanceNotFoundFault"}, + {"shape":"InvalidDBInstanceStateFault"}, + {"shape":"DBSnapshotAlreadyExistsFault"}, + {"shape":"SnapshotQuotaExceededFault"} + ] + }, + "DeleteDBParameterGroup":{ + "name":"DeleteDBParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDBParameterGroupMessage"}, + "errors":[ + {"shape":"InvalidDBParameterGroupStateFault"}, + {"shape":"DBParameterGroupNotFoundFault"} + ] + }, + "DeleteDBSecurityGroup":{ + "name":"DeleteDBSecurityGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDBSecurityGroupMessage"}, + "errors":[ + {"shape":"InvalidDBSecurityGroupStateFault"}, + {"shape":"DBSecurityGroupNotFoundFault"} + ] + }, + "DeleteDBSnapshot":{ + "name":"DeleteDBSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDBSnapshotMessage"}, + "output":{ + "shape":"DeleteDBSnapshotResult", + "resultWrapper":"DeleteDBSnapshotResult" + }, + "errors":[ + {"shape":"InvalidDBSnapshotStateFault"}, + {"shape":"DBSnapshotNotFoundFault"} + ] + }, + "DeleteDBSubnetGroup":{ + "name":"DeleteDBSubnetGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDBSubnetGroupMessage"}, + "errors":[ + {"shape":"InvalidDBSubnetGroupStateFault"}, + {"shape":"InvalidDBSubnetStateFault"}, + {"shape":"DBSubnetGroupNotFoundFault"} + ] + }, + "DeleteEventSubscription":{ + "name":"DeleteEventSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteEventSubscriptionMessage"}, + "output":{ + "shape":"DeleteEventSubscriptionResult", + "resultWrapper":"DeleteEventSubscriptionResult" + }, + "errors":[ + {"shape":"SubscriptionNotFoundFault"}, + {"shape":"InvalidEventSubscriptionStateFault"} + ] + }, + "DeleteOptionGroup":{ + "name":"DeleteOptionGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteOptionGroupMessage"}, + "errors":[ + {"shape":"OptionGroupNotFoundFault"}, + {"shape":"InvalidOptionGroupStateFault"} + ] + }, + "DescribeDBEngineVersions":{ + "name":"DescribeDBEngineVersions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBEngineVersionsMessage"}, + "output":{ + "shape":"DBEngineVersionMessage", + "resultWrapper":"DescribeDBEngineVersionsResult" + } + }, + "DescribeDBInstances":{ + "name":"DescribeDBInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBInstancesMessage"}, + "output":{ + "shape":"DBInstanceMessage", + "resultWrapper":"DescribeDBInstancesResult" + }, + "errors":[ + {"shape":"DBInstanceNotFoundFault"} + ] + }, + "DescribeDBLogFiles":{ + "name":"DescribeDBLogFiles", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBLogFilesMessage"}, + "output":{ + "shape":"DescribeDBLogFilesResponse", + "resultWrapper":"DescribeDBLogFilesResult" + }, + "errors":[ + {"shape":"DBInstanceNotFoundFault"} + ] + }, + "DescribeDBParameterGroups":{ + "name":"DescribeDBParameterGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBParameterGroupsMessage"}, + "output":{ + "shape":"DBParameterGroupsMessage", + "resultWrapper":"DescribeDBParameterGroupsResult" + }, + "errors":[ + {"shape":"DBParameterGroupNotFoundFault"} + ] + }, + "DescribeDBParameters":{ + "name":"DescribeDBParameters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBParametersMessage"}, + "output":{ + "shape":"DBParameterGroupDetails", + "resultWrapper":"DescribeDBParametersResult" + }, + "errors":[ + {"shape":"DBParameterGroupNotFoundFault"} + ] + }, + "DescribeDBSecurityGroups":{ + "name":"DescribeDBSecurityGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBSecurityGroupsMessage"}, + "output":{ + "shape":"DBSecurityGroupMessage", + "resultWrapper":"DescribeDBSecurityGroupsResult" + }, + "errors":[ + {"shape":"DBSecurityGroupNotFoundFault"} + ] + }, + "DescribeDBSnapshots":{ + "name":"DescribeDBSnapshots", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBSnapshotsMessage"}, + "output":{ + "shape":"DBSnapshotMessage", + "resultWrapper":"DescribeDBSnapshotsResult" + }, + "errors":[ + {"shape":"DBSnapshotNotFoundFault"} + ] + }, + "DescribeDBSubnetGroups":{ + "name":"DescribeDBSubnetGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBSubnetGroupsMessage"}, + "output":{ + "shape":"DBSubnetGroupMessage", + "resultWrapper":"DescribeDBSubnetGroupsResult" + }, + "errors":[ + {"shape":"DBSubnetGroupNotFoundFault"} + ] + }, + "DescribeEngineDefaultParameters":{ + "name":"DescribeEngineDefaultParameters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEngineDefaultParametersMessage"}, + "output":{ + "shape":"DescribeEngineDefaultParametersResult", + "resultWrapper":"DescribeEngineDefaultParametersResult" + } + }, + "DescribeEventCategories":{ + "name":"DescribeEventCategories", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEventCategoriesMessage"}, + "output":{ + "shape":"EventCategoriesMessage", + "resultWrapper":"DescribeEventCategoriesResult" + } + }, + "DescribeEventSubscriptions":{ + "name":"DescribeEventSubscriptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEventSubscriptionsMessage"}, + "output":{ + "shape":"EventSubscriptionsMessage", + "resultWrapper":"DescribeEventSubscriptionsResult" + }, + "errors":[ + {"shape":"SubscriptionNotFoundFault"} + ] + }, + "DescribeEvents":{ + "name":"DescribeEvents", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEventsMessage"}, + "output":{ + "shape":"EventsMessage", + "resultWrapper":"DescribeEventsResult" + } + }, + "DescribeOptionGroupOptions":{ + "name":"DescribeOptionGroupOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeOptionGroupOptionsMessage"}, + "output":{ + "shape":"OptionGroupOptionsMessage", + "resultWrapper":"DescribeOptionGroupOptionsResult" + } + }, + "DescribeOptionGroups":{ + "name":"DescribeOptionGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeOptionGroupsMessage"}, + "output":{ + "shape":"OptionGroups", + "resultWrapper":"DescribeOptionGroupsResult" + }, + "errors":[ + {"shape":"OptionGroupNotFoundFault"} + ] + }, + "DescribeOrderableDBInstanceOptions":{ + "name":"DescribeOrderableDBInstanceOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeOrderableDBInstanceOptionsMessage"}, + "output":{ + "shape":"OrderableDBInstanceOptionsMessage", + "resultWrapper":"DescribeOrderableDBInstanceOptionsResult" + } + }, + "DescribeReservedDBInstances":{ + "name":"DescribeReservedDBInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeReservedDBInstancesMessage"}, + "output":{ + "shape":"ReservedDBInstanceMessage", + "resultWrapper":"DescribeReservedDBInstancesResult" + }, + "errors":[ + {"shape":"ReservedDBInstanceNotFoundFault"} + ] + }, + "DescribeReservedDBInstancesOfferings":{ + "name":"DescribeReservedDBInstancesOfferings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeReservedDBInstancesOfferingsMessage"}, + "output":{ + "shape":"ReservedDBInstancesOfferingMessage", + "resultWrapper":"DescribeReservedDBInstancesOfferingsResult" + }, + "errors":[ + {"shape":"ReservedDBInstancesOfferingNotFoundFault"} + ] + }, + "DownloadDBLogFilePortion":{ + "name":"DownloadDBLogFilePortion", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DownloadDBLogFilePortionMessage"}, + "output":{ + "shape":"DownloadDBLogFilePortionDetails", + "resultWrapper":"DownloadDBLogFilePortionResult" + }, + "errors":[ + {"shape":"DBInstanceNotFoundFault"}, + {"shape":"DBLogFileNotFoundFault"} + ] + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForResourceMessage"}, + "output":{ + "shape":"TagListMessage", + "resultWrapper":"ListTagsForResourceResult" + }, + "errors":[ + {"shape":"DBInstanceNotFoundFault"}, + {"shape":"DBSnapshotNotFoundFault"} + ] + }, + "ModifyDBInstance":{ + "name":"ModifyDBInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyDBInstanceMessage"}, + "output":{ + "shape":"ModifyDBInstanceResult", + "resultWrapper":"ModifyDBInstanceResult" + }, + "errors":[ + {"shape":"InvalidDBInstanceStateFault"}, + {"shape":"InvalidDBSecurityGroupStateFault"}, + {"shape":"DBInstanceAlreadyExistsFault"}, + {"shape":"DBInstanceNotFoundFault"}, + {"shape":"DBSecurityGroupNotFoundFault"}, + {"shape":"DBParameterGroupNotFoundFault"}, + {"shape":"InsufficientDBInstanceCapacityFault"}, + {"shape":"StorageQuotaExceededFault"}, + {"shape":"InvalidVPCNetworkStateFault"}, + {"shape":"ProvisionedIopsNotAvailableInAZFault"}, + {"shape":"OptionGroupNotFoundFault"}, + {"shape":"DBUpgradeDependencyFailureFault"} + ] + }, + "ModifyDBParameterGroup":{ + "name":"ModifyDBParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyDBParameterGroupMessage"}, + "output":{ + "shape":"DBParameterGroupNameMessage", + "resultWrapper":"ModifyDBParameterGroupResult" + }, + "errors":[ + {"shape":"DBParameterGroupNotFoundFault"}, + {"shape":"InvalidDBParameterGroupStateFault"} + ] + }, + "ModifyDBSubnetGroup":{ + "name":"ModifyDBSubnetGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyDBSubnetGroupMessage"}, + "output":{ + "shape":"ModifyDBSubnetGroupResult", + "resultWrapper":"ModifyDBSubnetGroupResult" + }, + "errors":[ + {"shape":"DBSubnetGroupNotFoundFault"}, + {"shape":"DBSubnetQuotaExceededFault"}, + {"shape":"SubnetAlreadyInUse"}, + {"shape":"DBSubnetGroupDoesNotCoverEnoughAZs"}, + {"shape":"InvalidSubnet"} + ] + }, + "ModifyEventSubscription":{ + "name":"ModifyEventSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyEventSubscriptionMessage"}, + "output":{ + "shape":"ModifyEventSubscriptionResult", + "resultWrapper":"ModifyEventSubscriptionResult" + }, + "errors":[ + {"shape":"EventSubscriptionQuotaExceededFault"}, + {"shape":"SubscriptionNotFoundFault"}, + {"shape":"SNSInvalidTopicFault"}, + {"shape":"SNSNoAuthorizationFault"}, + {"shape":"SNSTopicArnNotFoundFault"}, + {"shape":"SubscriptionCategoryNotFoundFault"} + ] + }, + "ModifyOptionGroup":{ + "name":"ModifyOptionGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyOptionGroupMessage"}, + "output":{ + "shape":"ModifyOptionGroupResult", + "resultWrapper":"ModifyOptionGroupResult" + }, + "errors":[ + {"shape":"InvalidOptionGroupStateFault"}, + {"shape":"OptionGroupNotFoundFault"} + ] + }, + "PromoteReadReplica":{ + "name":"PromoteReadReplica", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PromoteReadReplicaMessage"}, + "output":{ + "shape":"PromoteReadReplicaResult", + "resultWrapper":"PromoteReadReplicaResult" + }, + "errors":[ + {"shape":"InvalidDBInstanceStateFault"}, + {"shape":"DBInstanceNotFoundFault"} + ] + }, + "PurchaseReservedDBInstancesOffering":{ + "name":"PurchaseReservedDBInstancesOffering", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PurchaseReservedDBInstancesOfferingMessage"}, + "output":{ + "shape":"PurchaseReservedDBInstancesOfferingResult", + "resultWrapper":"PurchaseReservedDBInstancesOfferingResult" + }, + "errors":[ + {"shape":"ReservedDBInstancesOfferingNotFoundFault"}, + {"shape":"ReservedDBInstanceAlreadyExistsFault"}, + {"shape":"ReservedDBInstanceQuotaExceededFault"} + ] + }, + "RebootDBInstance":{ + "name":"RebootDBInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RebootDBInstanceMessage"}, + "output":{ + "shape":"RebootDBInstanceResult", + "resultWrapper":"RebootDBInstanceResult" + }, + "errors":[ + {"shape":"InvalidDBInstanceStateFault"}, + {"shape":"DBInstanceNotFoundFault"} + ] + }, + "RemoveSourceIdentifierFromSubscription":{ + "name":"RemoveSourceIdentifierFromSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RemoveSourceIdentifierFromSubscriptionMessage"}, + "output":{ + "shape":"RemoveSourceIdentifierFromSubscriptionResult", + "resultWrapper":"RemoveSourceIdentifierFromSubscriptionResult" + }, + "errors":[ + {"shape":"SubscriptionNotFoundFault"}, + {"shape":"SourceNotFoundFault"} + ] + }, + "RemoveTagsFromResource":{ + "name":"RemoveTagsFromResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RemoveTagsFromResourceMessage"}, + "errors":[ + {"shape":"DBInstanceNotFoundFault"}, + {"shape":"DBSnapshotNotFoundFault"} + ] + }, + "ResetDBParameterGroup":{ + "name":"ResetDBParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResetDBParameterGroupMessage"}, + "output":{ + "shape":"DBParameterGroupNameMessage", + "resultWrapper":"ResetDBParameterGroupResult" + }, + "errors":[ + {"shape":"InvalidDBParameterGroupStateFault"}, + {"shape":"DBParameterGroupNotFoundFault"} + ] + }, + "RestoreDBInstanceFromDBSnapshot":{ + "name":"RestoreDBInstanceFromDBSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RestoreDBInstanceFromDBSnapshotMessage"}, + "output":{ + "shape":"RestoreDBInstanceFromDBSnapshotResult", + "resultWrapper":"RestoreDBInstanceFromDBSnapshotResult" + }, + "errors":[ + {"shape":"DBInstanceAlreadyExistsFault"}, + {"shape":"DBSnapshotNotFoundFault"}, + {"shape":"InstanceQuotaExceededFault"}, + {"shape":"InsufficientDBInstanceCapacityFault"}, + {"shape":"InvalidDBSnapshotStateFault"}, + {"shape":"StorageQuotaExceededFault"}, + {"shape":"InvalidVPCNetworkStateFault"}, + {"shape":"InvalidRestoreFault"}, + {"shape":"DBSubnetGroupNotFoundFault"}, + {"shape":"DBSubnetGroupDoesNotCoverEnoughAZs"}, + {"shape":"InvalidSubnet"}, + {"shape":"ProvisionedIopsNotAvailableInAZFault"}, + {"shape":"OptionGroupNotFoundFault"} + ] + }, + "RestoreDBInstanceToPointInTime":{ + "name":"RestoreDBInstanceToPointInTime", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RestoreDBInstanceToPointInTimeMessage"}, + "output":{ + "shape":"RestoreDBInstanceToPointInTimeResult", + "resultWrapper":"RestoreDBInstanceToPointInTimeResult" + }, + "errors":[ + {"shape":"DBInstanceAlreadyExistsFault"}, + {"shape":"DBInstanceNotFoundFault"}, + {"shape":"InstanceQuotaExceededFault"}, + {"shape":"InsufficientDBInstanceCapacityFault"}, + {"shape":"InvalidDBInstanceStateFault"}, + {"shape":"PointInTimeRestoreNotEnabledFault"}, + {"shape":"StorageQuotaExceededFault"}, + {"shape":"InvalidVPCNetworkStateFault"}, + {"shape":"InvalidRestoreFault"}, + {"shape":"DBSubnetGroupNotFoundFault"}, + {"shape":"DBSubnetGroupDoesNotCoverEnoughAZs"}, + {"shape":"InvalidSubnet"}, + {"shape":"ProvisionedIopsNotAvailableInAZFault"}, + {"shape":"OptionGroupNotFoundFault"} + ] + }, + "RevokeDBSecurityGroupIngress":{ + "name":"RevokeDBSecurityGroupIngress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RevokeDBSecurityGroupIngressMessage"}, + "output":{ + "shape":"RevokeDBSecurityGroupIngressResult", + "resultWrapper":"RevokeDBSecurityGroupIngressResult" + }, + "errors":[ + {"shape":"DBSecurityGroupNotFoundFault"}, + {"shape":"AuthorizationNotFoundFault"}, + {"shape":"InvalidDBSecurityGroupStateFault"} + ] + } + }, + "shapes":{ + "AddSourceIdentifierToSubscriptionMessage":{ + "type":"structure", + "required":[ + "SubscriptionName", + "SourceIdentifier" + ], + "members":{ + "SubscriptionName":{"shape":"String"}, + "SourceIdentifier":{"shape":"String"} + } + }, + "AddSourceIdentifierToSubscriptionResult":{ + "type":"structure", + "members":{ + "EventSubscription":{"shape":"EventSubscription"} + } + }, + "AddTagsToResourceMessage":{ + "type":"structure", + "required":[ + "ResourceName", + "Tags" + ], + "members":{ + "ResourceName":{"shape":"String"}, + "Tags":{"shape":"TagList"} + } + }, + "ApplyMethod":{ + "type":"string", + "enum":[ + "immediate", + "pending-reboot" + ] + }, + "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 + }, + "AuthorizationQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"AuthorizationQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "AuthorizeDBSecurityGroupIngressMessage":{ + "type":"structure", + "required":["DBSecurityGroupName"], + "members":{ + "DBSecurityGroupName":{"shape":"String"}, + "CIDRIP":{"shape":"String"}, + "EC2SecurityGroupName":{"shape":"String"}, + "EC2SecurityGroupId":{"shape":"String"}, + "EC2SecurityGroupOwnerId":{"shape":"String"} + } + }, + "AuthorizeDBSecurityGroupIngressResult":{ + "type":"structure", + "members":{ + "DBSecurityGroup":{"shape":"DBSecurityGroup"} + } + }, + "AvailabilityZone":{ + "type":"structure", + "members":{ + "Name":{"shape":"String"}, + "ProvisionedIopsCapable":{"shape":"Boolean"} + }, + "wrapper":true + }, + "AvailabilityZoneList":{ + "type":"list", + "member":{ + "shape":"AvailabilityZone", + "locationName":"AvailabilityZone" + } + }, + "Boolean":{"type":"boolean"}, + "BooleanOptional":{"type":"boolean"}, + "CharacterSet":{ + "type":"structure", + "members":{ + "CharacterSetName":{"shape":"String"}, + "CharacterSetDescription":{"shape":"String"} + } + }, + "CopyDBSnapshotMessage":{ + "type":"structure", + "required":[ + "SourceDBSnapshotIdentifier", + "TargetDBSnapshotIdentifier" + ], + "members":{ + "SourceDBSnapshotIdentifier":{"shape":"String"}, + "TargetDBSnapshotIdentifier":{"shape":"String"}, + "Tags":{"shape":"TagList"} + } + }, + "CopyDBSnapshotResult":{ + "type":"structure", + "members":{ + "DBSnapshot":{"shape":"DBSnapshot"} + } + }, + "CreateDBInstanceMessage":{ + "type":"structure", + "required":[ + "DBInstanceIdentifier", + "AllocatedStorage", + "DBInstanceClass", + "Engine", + "MasterUsername", + "MasterUserPassword" + ], + "members":{ + "DBName":{"shape":"String"}, + "DBInstanceIdentifier":{"shape":"String"}, + "AllocatedStorage":{"shape":"IntegerOptional"}, + "DBInstanceClass":{"shape":"String"}, + "Engine":{"shape":"String"}, + "MasterUsername":{"shape":"String"}, + "MasterUserPassword":{"shape":"String"}, + "DBSecurityGroups":{"shape":"DBSecurityGroupNameList"}, + "VpcSecurityGroupIds":{"shape":"VpcSecurityGroupIdList"}, + "AvailabilityZone":{"shape":"String"}, + "DBSubnetGroupName":{"shape":"String"}, + "PreferredMaintenanceWindow":{"shape":"String"}, + "DBParameterGroupName":{"shape":"String"}, + "BackupRetentionPeriod":{"shape":"IntegerOptional"}, + "PreferredBackupWindow":{"shape":"String"}, + "Port":{"shape":"IntegerOptional"}, + "MultiAZ":{"shape":"BooleanOptional"}, + "EngineVersion":{"shape":"String"}, + "AutoMinorVersionUpgrade":{"shape":"BooleanOptional"}, + "LicenseModel":{"shape":"String"}, + "Iops":{"shape":"IntegerOptional"}, + "OptionGroupName":{"shape":"String"}, + "CharacterSetName":{"shape":"String"}, + "PubliclyAccessible":{"shape":"BooleanOptional"}, + "Tags":{"shape":"TagList"} + } + }, + "CreateDBInstanceReadReplicaMessage":{ + "type":"structure", + "required":[ + "DBInstanceIdentifier", + "SourceDBInstanceIdentifier" + ], + "members":{ + "DBInstanceIdentifier":{"shape":"String"}, + "SourceDBInstanceIdentifier":{"shape":"String"}, + "DBInstanceClass":{"shape":"String"}, + "AvailabilityZone":{"shape":"String"}, + "Port":{"shape":"IntegerOptional"}, + "AutoMinorVersionUpgrade":{"shape":"BooleanOptional"}, + "Iops":{"shape":"IntegerOptional"}, + "OptionGroupName":{"shape":"String"}, + "PubliclyAccessible":{"shape":"BooleanOptional"}, + "Tags":{"shape":"TagList"}, + "DBSubnetGroupName":{"shape":"String"} + } + }, + "CreateDBInstanceReadReplicaResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "CreateDBInstanceResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "CreateDBParameterGroupMessage":{ + "type":"structure", + "required":[ + "DBParameterGroupName", + "DBParameterGroupFamily", + "Description" + ], + "members":{ + "DBParameterGroupName":{"shape":"String"}, + "DBParameterGroupFamily":{"shape":"String"}, + "Description":{"shape":"String"}, + "Tags":{"shape":"TagList"} + } + }, + "CreateDBParameterGroupResult":{ + "type":"structure", + "members":{ + "DBParameterGroup":{"shape":"DBParameterGroup"} + } + }, + "CreateDBSecurityGroupMessage":{ + "type":"structure", + "required":[ + "DBSecurityGroupName", + "DBSecurityGroupDescription" + ], + "members":{ + "DBSecurityGroupName":{"shape":"String"}, + "DBSecurityGroupDescription":{"shape":"String"}, + "Tags":{"shape":"TagList"} + } + }, + "CreateDBSecurityGroupResult":{ + "type":"structure", + "members":{ + "DBSecurityGroup":{"shape":"DBSecurityGroup"} + } + }, + "CreateDBSnapshotMessage":{ + "type":"structure", + "required":[ + "DBSnapshotIdentifier", + "DBInstanceIdentifier" + ], + "members":{ + "DBSnapshotIdentifier":{"shape":"String"}, + "DBInstanceIdentifier":{"shape":"String"}, + "Tags":{"shape":"TagList"} + } + }, + "CreateDBSnapshotResult":{ + "type":"structure", + "members":{ + "DBSnapshot":{"shape":"DBSnapshot"} + } + }, + "CreateDBSubnetGroupMessage":{ + "type":"structure", + "required":[ + "DBSubnetGroupName", + "DBSubnetGroupDescription", + "SubnetIds" + ], + "members":{ + "DBSubnetGroupName":{"shape":"String"}, + "DBSubnetGroupDescription":{"shape":"String"}, + "SubnetIds":{"shape":"SubnetIdentifierList"}, + "Tags":{"shape":"TagList"} + } + }, + "CreateDBSubnetGroupResult":{ + "type":"structure", + "members":{ + "DBSubnetGroup":{"shape":"DBSubnetGroup"} + } + }, + "CreateEventSubscriptionMessage":{ + "type":"structure", + "required":[ + "SubscriptionName", + "SnsTopicArn" + ], + "members":{ + "SubscriptionName":{"shape":"String"}, + "SnsTopicArn":{"shape":"String"}, + "SourceType":{"shape":"String"}, + "EventCategories":{"shape":"EventCategoriesList"}, + "SourceIds":{"shape":"SourceIdsList"}, + "Enabled":{"shape":"BooleanOptional"}, + "Tags":{"shape":"TagList"} + } + }, + "CreateEventSubscriptionResult":{ + "type":"structure", + "members":{ + "EventSubscription":{"shape":"EventSubscription"} + } + }, + "CreateOptionGroupMessage":{ + "type":"structure", + "required":[ + "OptionGroupName", + "EngineName", + "MajorEngineVersion", + "OptionGroupDescription" + ], + "members":{ + "OptionGroupName":{"shape":"String"}, + "EngineName":{"shape":"String"}, + "MajorEngineVersion":{"shape":"String"}, + "OptionGroupDescription":{"shape":"String"}, + "Tags":{"shape":"TagList"} + } + }, + "CreateOptionGroupResult":{ + "type":"structure", + "members":{ + "OptionGroup":{"shape":"OptionGroup"} + } + }, + "DBEngineVersion":{ + "type":"structure", + "members":{ + "Engine":{"shape":"String"}, + "EngineVersion":{"shape":"String"}, + "DBParameterGroupFamily":{"shape":"String"}, + "DBEngineDescription":{"shape":"String"}, + "DBEngineVersionDescription":{"shape":"String"}, + "DefaultCharacterSet":{"shape":"CharacterSet"}, + "SupportedCharacterSets":{"shape":"SupportedCharacterSetsList"} + } + }, + "DBEngineVersionList":{ + "type":"list", + "member":{ + "shape":"DBEngineVersion", + "locationName":"DBEngineVersion" + } + }, + "DBEngineVersionMessage":{ + "type":"structure", + "members":{ + "Marker":{"shape":"String"}, + "DBEngineVersions":{"shape":"DBEngineVersionList"} + } + }, + "DBInstance":{ + "type":"structure", + "members":{ + "DBInstanceIdentifier":{"shape":"String"}, + "DBInstanceClass":{"shape":"String"}, + "Engine":{"shape":"String"}, + "DBInstanceStatus":{"shape":"String"}, + "MasterUsername":{"shape":"String"}, + "DBName":{"shape":"String"}, + "Endpoint":{"shape":"Endpoint"}, + "AllocatedStorage":{"shape":"Integer"}, + "InstanceCreateTime":{"shape":"TStamp"}, + "PreferredBackupWindow":{"shape":"String"}, + "BackupRetentionPeriod":{"shape":"Integer"}, + "DBSecurityGroups":{"shape":"DBSecurityGroupMembershipList"}, + "VpcSecurityGroups":{"shape":"VpcSecurityGroupMembershipList"}, + "DBParameterGroups":{"shape":"DBParameterGroupStatusList"}, + "AvailabilityZone":{"shape":"String"}, + "DBSubnetGroup":{"shape":"DBSubnetGroup"}, + "PreferredMaintenanceWindow":{"shape":"String"}, + "PendingModifiedValues":{"shape":"PendingModifiedValues"}, + "LatestRestorableTime":{"shape":"TStamp"}, + "MultiAZ":{"shape":"Boolean"}, + "EngineVersion":{"shape":"String"}, + "AutoMinorVersionUpgrade":{"shape":"Boolean"}, + "ReadReplicaSourceDBInstanceIdentifier":{"shape":"String"}, + "ReadReplicaDBInstanceIdentifiers":{"shape":"ReadReplicaDBInstanceIdentifierList"}, + "LicenseModel":{"shape":"String"}, + "Iops":{"shape":"IntegerOptional"}, + "OptionGroupMemberships":{"shape":"OptionGroupMembershipList"}, + "CharacterSetName":{"shape":"String"}, + "SecondaryAvailabilityZone":{"shape":"String"}, + "PubliclyAccessible":{"shape":"Boolean"}, + "StatusInfos":{"shape":"DBInstanceStatusInfoList"} + }, + "wrapper":true + }, + "DBInstanceAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBInstanceAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBInstanceList":{ + "type":"list", + "member":{ + "shape":"DBInstance", + "locationName":"DBInstance" + } + }, + "DBInstanceMessage":{ + "type":"structure", + "members":{ + "Marker":{"shape":"String"}, + "DBInstances":{"shape":"DBInstanceList"} + } + }, + "DBInstanceNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "DBInstanceStatusInfo":{ + "type":"structure", + "members":{ + "StatusType":{"shape":"String"}, + "Normal":{"shape":"Boolean"}, + "Status":{"shape":"String"}, + "Message":{"shape":"String"} + } + }, + "DBInstanceStatusInfoList":{ + "type":"list", + "member":{ + "shape":"DBInstanceStatusInfo", + "locationName":"DBInstanceStatusInfo" + } + }, + "DBLogFileNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBLogFileNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "DBParameterGroup":{ + "type":"structure", + "members":{ + "DBParameterGroupName":{"shape":"String"}, + "DBParameterGroupFamily":{"shape":"String"}, + "Description":{"shape":"String"} + }, + "wrapper":true + }, + "DBParameterGroupAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBParameterGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBParameterGroupDetails":{ + "type":"structure", + "members":{ + "Parameters":{"shape":"ParametersList"}, + "Marker":{"shape":"String"} + } + }, + "DBParameterGroupList":{ + "type":"list", + "member":{ + "shape":"DBParameterGroup", + "locationName":"DBParameterGroup" + } + }, + "DBParameterGroupNameMessage":{ + "type":"structure", + "members":{ + "DBParameterGroupName":{"shape":"String"} + } + }, + "DBParameterGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "DBParameterGroupQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBParameterGroupQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBParameterGroupStatus":{ + "type":"structure", + "members":{ + "DBParameterGroupName":{"shape":"String"}, + "ParameterApplyStatus":{"shape":"String"} + } + }, + "DBParameterGroupStatusList":{ + "type":"list", + "member":{ + "shape":"DBParameterGroupStatus", + "locationName":"DBParameterGroup" + } + }, + "DBParameterGroupsMessage":{ + "type":"structure", + "members":{ + "Marker":{"shape":"String"}, + "DBParameterGroups":{"shape":"DBParameterGroupList"} + } + }, + "DBSecurityGroup":{ + "type":"structure", + "members":{ + "OwnerId":{"shape":"String"}, + "DBSecurityGroupName":{"shape":"String"}, + "DBSecurityGroupDescription":{"shape":"String"}, + "VpcId":{"shape":"String"}, + "EC2SecurityGroups":{"shape":"EC2SecurityGroupList"}, + "IPRanges":{"shape":"IPRangeList"} + }, + "wrapper":true + }, + "DBSecurityGroupAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSecurityGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBSecurityGroupMembership":{ + "type":"structure", + "members":{ + "DBSecurityGroupName":{"shape":"String"}, + "Status":{"shape":"String"} + } + }, + "DBSecurityGroupMembershipList":{ + "type":"list", + "member":{ + "shape":"DBSecurityGroupMembership", + "locationName":"DBSecurityGroup" + } + }, + "DBSecurityGroupMessage":{ + "type":"structure", + "members":{ + "Marker":{"shape":"String"}, + "DBSecurityGroups":{"shape":"DBSecurityGroups"} + } + }, + "DBSecurityGroupNameList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"DBSecurityGroupName" + } + }, + "DBSecurityGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSecurityGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "DBSecurityGroupNotSupportedFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSecurityGroupNotSupported", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBSecurityGroupQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"QuotaExceeded.DBSecurityGroup", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBSecurityGroups":{ + "type":"list", + "member":{ + "shape":"DBSecurityGroup", + "locationName":"DBSecurityGroup" + } + }, + "DBSnapshot":{ + "type":"structure", + "members":{ + "DBSnapshotIdentifier":{"shape":"String"}, + "DBInstanceIdentifier":{"shape":"String"}, + "SnapshotCreateTime":{"shape":"TStamp"}, + "Engine":{"shape":"String"}, + "AllocatedStorage":{"shape":"Integer"}, + "Status":{"shape":"String"}, + "Port":{"shape":"Integer"}, + "AvailabilityZone":{"shape":"String"}, + "VpcId":{"shape":"String"}, + "InstanceCreateTime":{"shape":"TStamp"}, + "MasterUsername":{"shape":"String"}, + "EngineVersion":{"shape":"String"}, + "LicenseModel":{"shape":"String"}, + "SnapshotType":{"shape":"String"}, + "Iops":{"shape":"IntegerOptional"}, + "OptionGroupName":{"shape":"String"}, + "PercentProgress":{"shape":"Integer"}, + "SourceRegion":{"shape":"String"} + }, + "wrapper":true + }, + "DBSnapshotAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSnapshotAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBSnapshotList":{ + "type":"list", + "member":{ + "shape":"DBSnapshot", + "locationName":"DBSnapshot" + } + }, + "DBSnapshotMessage":{ + "type":"structure", + "members":{ + "Marker":{"shape":"String"}, + "DBSnapshots":{"shape":"DBSnapshotList"} + } + }, + "DBSnapshotNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSnapshotNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "DBSubnetGroup":{ + "type":"structure", + "members":{ + "DBSubnetGroupName":{"shape":"String"}, + "DBSubnetGroupDescription":{"shape":"String"}, + "VpcId":{"shape":"String"}, + "SubnetGroupStatus":{"shape":"String"}, + "Subnets":{"shape":"SubnetList"} + }, + "wrapper":true + }, + "DBSubnetGroupAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSubnetGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBSubnetGroupDoesNotCoverEnoughAZs":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSubnetGroupDoesNotCoverEnoughAZs", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBSubnetGroupMessage":{ + "type":"structure", + "members":{ + "Marker":{"shape":"String"}, + "DBSubnetGroups":{"shape":"DBSubnetGroups"} + } + }, + "DBSubnetGroupNotAllowedFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSubnetGroupNotAllowedFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBSubnetGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSubnetGroupNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "DBSubnetGroupQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSubnetGroupQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBSubnetGroups":{ + "type":"list", + "member":{ + "shape":"DBSubnetGroup", + "locationName":"DBSubnetGroup" + } + }, + "DBSubnetQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSubnetQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBUpgradeDependencyFailureFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBUpgradeDependencyFailure", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DeleteDBInstanceMessage":{ + "type":"structure", + "required":["DBInstanceIdentifier"], + "members":{ + "DBInstanceIdentifier":{"shape":"String"}, + "SkipFinalSnapshot":{"shape":"Boolean"}, + "FinalDBSnapshotIdentifier":{"shape":"String"} + } + }, + "DeleteDBInstanceResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "DeleteDBParameterGroupMessage":{ + "type":"structure", + "required":["DBParameterGroupName"], + "members":{ + "DBParameterGroupName":{"shape":"String"} + } + }, + "DeleteDBSecurityGroupMessage":{ + "type":"structure", + "required":["DBSecurityGroupName"], + "members":{ + "DBSecurityGroupName":{"shape":"String"} + } + }, + "DeleteDBSnapshotMessage":{ + "type":"structure", + "required":["DBSnapshotIdentifier"], + "members":{ + "DBSnapshotIdentifier":{"shape":"String"} + } + }, + "DeleteDBSnapshotResult":{ + "type":"structure", + "members":{ + "DBSnapshot":{"shape":"DBSnapshot"} + } + }, + "DeleteDBSubnetGroupMessage":{ + "type":"structure", + "required":["DBSubnetGroupName"], + "members":{ + "DBSubnetGroupName":{"shape":"String"} + } + }, + "DeleteEventSubscriptionMessage":{ + "type":"structure", + "required":["SubscriptionName"], + "members":{ + "SubscriptionName":{"shape":"String"} + } + }, + "DeleteEventSubscriptionResult":{ + "type":"structure", + "members":{ + "EventSubscription":{"shape":"EventSubscription"} + } + }, + "DeleteOptionGroupMessage":{ + "type":"structure", + "required":["OptionGroupName"], + "members":{ + "OptionGroupName":{"shape":"String"} + } + }, + "DescribeDBEngineVersionsMessage":{ + "type":"structure", + "members":{ + "Engine":{"shape":"String"}, + "EngineVersion":{"shape":"String"}, + "DBParameterGroupFamily":{"shape":"String"}, + "Filters":{"shape":"FilterList"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"}, + "DefaultOnly":{"shape":"Boolean"}, + "ListSupportedCharacterSets":{"shape":"BooleanOptional"} + } + }, + "DescribeDBInstancesMessage":{ + "type":"structure", + "members":{ + "DBInstanceIdentifier":{"shape":"String"}, + "Filters":{"shape":"FilterList"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "DescribeDBLogFilesDetails":{ + "type":"structure", + "members":{ + "LogFileName":{"shape":"String"}, + "LastWritten":{"shape":"Long"}, + "Size":{"shape":"Long"} + } + }, + "DescribeDBLogFilesList":{ + "type":"list", + "member":{ + "shape":"DescribeDBLogFilesDetails", + "locationName":"DescribeDBLogFilesDetails" + } + }, + "DescribeDBLogFilesMessage":{ + "type":"structure", + "required":["DBInstanceIdentifier"], + "members":{ + "DBInstanceIdentifier":{"shape":"String"}, + "FilenameContains":{"shape":"String"}, + "FileLastWritten":{"shape":"Long"}, + "FileSize":{"shape":"Long"}, + "Filters":{"shape":"FilterList"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "DescribeDBLogFilesResponse":{ + "type":"structure", + "members":{ + "DescribeDBLogFiles":{"shape":"DescribeDBLogFilesList"}, + "Marker":{"shape":"String"} + } + }, + "DescribeDBParameterGroupsMessage":{ + "type":"structure", + "members":{ + "DBParameterGroupName":{"shape":"String"}, + "Filters":{"shape":"FilterList"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "DescribeDBParametersMessage":{ + "type":"structure", + "required":["DBParameterGroupName"], + "members":{ + "DBParameterGroupName":{"shape":"String"}, + "Source":{"shape":"String"}, + "Filters":{"shape":"FilterList"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "DescribeDBSecurityGroupsMessage":{ + "type":"structure", + "members":{ + "DBSecurityGroupName":{"shape":"String"}, + "Filters":{"shape":"FilterList"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "DescribeDBSnapshotsMessage":{ + "type":"structure", + "members":{ + "DBInstanceIdentifier":{"shape":"String"}, + "DBSnapshotIdentifier":{"shape":"String"}, + "SnapshotType":{"shape":"String"}, + "Filters":{"shape":"FilterList"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "DescribeDBSubnetGroupsMessage":{ + "type":"structure", + "members":{ + "DBSubnetGroupName":{"shape":"String"}, + "Filters":{"shape":"FilterList"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "DescribeEngineDefaultParametersMessage":{ + "type":"structure", + "required":["DBParameterGroupFamily"], + "members":{ + "DBParameterGroupFamily":{"shape":"String"}, + "Filters":{"shape":"FilterList"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "DescribeEngineDefaultParametersResult":{ + "type":"structure", + "members":{ + "EngineDefaults":{"shape":"EngineDefaults"} + } + }, + "DescribeEventCategoriesMessage":{ + "type":"structure", + "members":{ + "SourceType":{"shape":"String"}, + "Filters":{"shape":"FilterList"} + } + }, + "DescribeEventSubscriptionsMessage":{ + "type":"structure", + "members":{ + "SubscriptionName":{"shape":"String"}, + "Filters":{"shape":"FilterList"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "DescribeEventsMessage":{ + "type":"structure", + "members":{ + "SourceIdentifier":{"shape":"String"}, + "SourceType":{"shape":"SourceType"}, + "StartTime":{"shape":"TStamp"}, + "EndTime":{"shape":"TStamp"}, + "Duration":{"shape":"IntegerOptional"}, + "EventCategories":{"shape":"EventCategoriesList"}, + "Filters":{"shape":"FilterList"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "DescribeOptionGroupOptionsMessage":{ + "type":"structure", + "required":["EngineName"], + "members":{ + "EngineName":{"shape":"String"}, + "MajorEngineVersion":{"shape":"String"}, + "Filters":{"shape":"FilterList"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "DescribeOptionGroupsMessage":{ + "type":"structure", + "members":{ + "OptionGroupName":{"shape":"String"}, + "Filters":{"shape":"FilterList"}, + "Marker":{"shape":"String"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "EngineName":{"shape":"String"}, + "MajorEngineVersion":{"shape":"String"} + } + }, + "DescribeOrderableDBInstanceOptionsMessage":{ + "type":"structure", + "required":["Engine"], + "members":{ + "Engine":{"shape":"String"}, + "EngineVersion":{"shape":"String"}, + "DBInstanceClass":{"shape":"String"}, + "LicenseModel":{"shape":"String"}, + "Vpc":{"shape":"BooleanOptional"}, + "Filters":{"shape":"FilterList"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "DescribeReservedDBInstancesMessage":{ + "type":"structure", + "members":{ + "ReservedDBInstanceId":{"shape":"String"}, + "ReservedDBInstancesOfferingId":{"shape":"String"}, + "DBInstanceClass":{"shape":"String"}, + "Duration":{"shape":"String"}, + "ProductDescription":{"shape":"String"}, + "OfferingType":{"shape":"String"}, + "MultiAZ":{"shape":"BooleanOptional"}, + "Filters":{"shape":"FilterList"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "DescribeReservedDBInstancesOfferingsMessage":{ + "type":"structure", + "members":{ + "ReservedDBInstancesOfferingId":{"shape":"String"}, + "DBInstanceClass":{"shape":"String"}, + "Duration":{"shape":"String"}, + "ProductDescription":{"shape":"String"}, + "OfferingType":{"shape":"String"}, + "MultiAZ":{"shape":"BooleanOptional"}, + "Filters":{"shape":"FilterList"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "Double":{"type":"double"}, + "DownloadDBLogFilePortionDetails":{ + "type":"structure", + "members":{ + "LogFileData":{"shape":"String"}, + "Marker":{"shape":"String"}, + "AdditionalDataPending":{"shape":"Boolean"} + } + }, + "DownloadDBLogFilePortionMessage":{ + "type":"structure", + "required":[ + "DBInstanceIdentifier", + "LogFileName" + ], + "members":{ + "DBInstanceIdentifier":{"shape":"String"}, + "LogFileName":{"shape":"String"}, + "Marker":{"shape":"String"}, + "NumberOfLines":{"shape":"Integer"} + } + }, + "EC2SecurityGroup":{ + "type":"structure", + "members":{ + "Status":{"shape":"String"}, + "EC2SecurityGroupName":{"shape":"String"}, + "EC2SecurityGroupId":{"shape":"String"}, + "EC2SecurityGroupOwnerId":{"shape":"String"} + } + }, + "EC2SecurityGroupList":{ + "type":"list", + "member":{ + "shape":"EC2SecurityGroup", + "locationName":"EC2SecurityGroup" + } + }, + "Endpoint":{ + "type":"structure", + "members":{ + "Address":{"shape":"String"}, + "Port":{"shape":"Integer"} + } + }, + "EngineDefaults":{ + "type":"structure", + "members":{ + "DBParameterGroupFamily":{"shape":"String"}, + "Marker":{"shape":"String"}, + "Parameters":{"shape":"ParametersList"} + }, + "wrapper":true + }, + "Event":{ + "type":"structure", + "members":{ + "SourceIdentifier":{"shape":"String"}, + "SourceType":{"shape":"SourceType"}, + "Message":{"shape":"String"}, + "EventCategories":{"shape":"EventCategoriesList"}, + "Date":{"shape":"TStamp"} + } + }, + "EventCategoriesList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"EventCategory" + } + }, + "EventCategoriesMap":{ + "type":"structure", + "members":{ + "SourceType":{"shape":"String"}, + "EventCategories":{"shape":"EventCategoriesList"} + }, + "wrapper":true + }, + "EventCategoriesMapList":{ + "type":"list", + "member":{ + "shape":"EventCategoriesMap", + "locationName":"EventCategoriesMap" + } + }, + "EventCategoriesMessage":{ + "type":"structure", + "members":{ + "EventCategoriesMapList":{"shape":"EventCategoriesMapList"} + } + }, + "EventList":{ + "type":"list", + "member":{ + "shape":"Event", + "locationName":"Event" + } + }, + "EventSubscription":{ + "type":"structure", + "members":{ + "CustomerAwsId":{"shape":"String"}, + "CustSubscriptionId":{"shape":"String"}, + "SnsTopicArn":{"shape":"String"}, + "Status":{"shape":"String"}, + "SubscriptionCreationTime":{"shape":"String"}, + "SourceType":{"shape":"String"}, + "SourceIdsList":{"shape":"SourceIdsList"}, + "EventCategoriesList":{"shape":"EventCategoriesList"}, + "Enabled":{"shape":"Boolean"} + }, + "wrapper":true + }, + "EventSubscriptionQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"EventSubscriptionQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "EventSubscriptionsList":{ + "type":"list", + "member":{ + "shape":"EventSubscription", + "locationName":"EventSubscription" + } + }, + "EventSubscriptionsMessage":{ + "type":"structure", + "members":{ + "Marker":{"shape":"String"}, + "EventSubscriptionsList":{"shape":"EventSubscriptionsList"} + } + }, + "EventsMessage":{ + "type":"structure", + "members":{ + "Marker":{"shape":"String"}, + "Events":{"shape":"EventList"} + } + }, + "Filter":{ + "type":"structure", + "required":[ + "Name", + "Values" + ], + "members":{ + "Name":{"shape":"String"}, + "Values":{"shape":"FilterValueList"} + } + }, + "FilterList":{ + "type":"list", + "member":{ + "shape":"Filter", + "locationName":"Filter" + } + }, + "FilterValueList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"Value" + } + }, + "IPRange":{ + "type":"structure", + "members":{ + "Status":{"shape":"String"}, + "CIDRIP":{"shape":"String"} + } + }, + "IPRangeList":{ + "type":"list", + "member":{ + "shape":"IPRange", + "locationName":"IPRange" + } + }, + "InstanceQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InstanceQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InsufficientDBInstanceCapacityFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InsufficientDBInstanceCapacity", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "Integer":{"type":"integer"}, + "IntegerOptional":{"type":"integer"}, + "InvalidDBInstanceStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidDBInstanceState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidDBParameterGroupStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidDBParameterGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidDBSecurityGroupStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidDBSecurityGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidDBSnapshotStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidDBSnapshotState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidDBSubnetGroupFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidDBSubnetGroupFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidDBSubnetGroupStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidDBSubnetGroupStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidDBSubnetStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidDBSubnetStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidEventSubscriptionStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidEventSubscriptionState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidOptionGroupStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidOptionGroupStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidRestoreFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidRestoreFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidSubnet":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidSubnet", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidVPCNetworkStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidVPCNetworkStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "KeyList":{ + "type":"list", + "member":{"shape":"String"} + }, + "ListTagsForResourceMessage":{ + "type":"structure", + "required":["ResourceName"], + "members":{ + "ResourceName":{"shape":"String"}, + "Filters":{"shape":"FilterList"} + } + }, + "Long":{"type":"long"}, + "ModifyDBInstanceMessage":{ + "type":"structure", + "required":["DBInstanceIdentifier"], + "members":{ + "DBInstanceIdentifier":{"shape":"String"}, + "AllocatedStorage":{"shape":"IntegerOptional"}, + "DBInstanceClass":{"shape":"String"}, + "DBSecurityGroups":{"shape":"DBSecurityGroupNameList"}, + "VpcSecurityGroupIds":{"shape":"VpcSecurityGroupIdList"}, + "ApplyImmediately":{"shape":"Boolean"}, + "MasterUserPassword":{"shape":"String"}, + "DBParameterGroupName":{"shape":"String"}, + "BackupRetentionPeriod":{"shape":"IntegerOptional"}, + "PreferredBackupWindow":{"shape":"String"}, + "PreferredMaintenanceWindow":{"shape":"String"}, + "MultiAZ":{"shape":"BooleanOptional"}, + "EngineVersion":{"shape":"String"}, + "AllowMajorVersionUpgrade":{"shape":"Boolean"}, + "AutoMinorVersionUpgrade":{"shape":"BooleanOptional"}, + "Iops":{"shape":"IntegerOptional"}, + "OptionGroupName":{"shape":"String"}, + "NewDBInstanceIdentifier":{"shape":"String"} + } + }, + "ModifyDBInstanceResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "ModifyDBParameterGroupMessage":{ + "type":"structure", + "required":[ + "DBParameterGroupName", + "Parameters" + ], + "members":{ + "DBParameterGroupName":{"shape":"String"}, + "Parameters":{"shape":"ParametersList"} + } + }, + "ModifyDBSubnetGroupMessage":{ + "type":"structure", + "required":[ + "DBSubnetGroupName", + "SubnetIds" + ], + "members":{ + "DBSubnetGroupName":{"shape":"String"}, + "DBSubnetGroupDescription":{"shape":"String"}, + "SubnetIds":{"shape":"SubnetIdentifierList"} + } + }, + "ModifyDBSubnetGroupResult":{ + "type":"structure", + "members":{ + "DBSubnetGroup":{"shape":"DBSubnetGroup"} + } + }, + "ModifyEventSubscriptionMessage":{ + "type":"structure", + "required":["SubscriptionName"], + "members":{ + "SubscriptionName":{"shape":"String"}, + "SnsTopicArn":{"shape":"String"}, + "SourceType":{"shape":"String"}, + "EventCategories":{"shape":"EventCategoriesList"}, + "Enabled":{"shape":"BooleanOptional"} + } + }, + "ModifyEventSubscriptionResult":{ + "type":"structure", + "members":{ + "EventSubscription":{"shape":"EventSubscription"} + } + }, + "ModifyOptionGroupMessage":{ + "type":"structure", + "required":["OptionGroupName"], + "members":{ + "OptionGroupName":{"shape":"String"}, + "OptionsToInclude":{"shape":"OptionConfigurationList"}, + "OptionsToRemove":{"shape":"OptionNamesList"}, + "ApplyImmediately":{"shape":"Boolean"} + } + }, + "ModifyOptionGroupResult":{ + "type":"structure", + "members":{ + "OptionGroup":{"shape":"OptionGroup"} + } + }, + "Option":{ + "type":"structure", + "members":{ + "OptionName":{"shape":"String"}, + "OptionDescription":{"shape":"String"}, + "Persistent":{"shape":"Boolean"}, + "Permanent":{"shape":"Boolean"}, + "Port":{"shape":"IntegerOptional"}, + "OptionSettings":{"shape":"OptionSettingConfigurationList"}, + "DBSecurityGroupMemberships":{"shape":"DBSecurityGroupMembershipList"}, + "VpcSecurityGroupMemberships":{"shape":"VpcSecurityGroupMembershipList"} + } + }, + "OptionConfiguration":{ + "type":"structure", + "required":["OptionName"], + "members":{ + "OptionName":{"shape":"String"}, + "Port":{"shape":"IntegerOptional"}, + "DBSecurityGroupMemberships":{"shape":"DBSecurityGroupNameList"}, + "VpcSecurityGroupMemberships":{"shape":"VpcSecurityGroupIdList"}, + "OptionSettings":{"shape":"OptionSettingsList"} + } + }, + "OptionConfigurationList":{ + "type":"list", + "member":{ + "shape":"OptionConfiguration", + "locationName":"OptionConfiguration" + } + }, + "OptionGroup":{ + "type":"structure", + "members":{ + "OptionGroupName":{"shape":"String"}, + "OptionGroupDescription":{"shape":"String"}, + "EngineName":{"shape":"String"}, + "MajorEngineVersion":{"shape":"String"}, + "Options":{"shape":"OptionsList"}, + "AllowsVpcAndNonVpcInstanceMemberships":{"shape":"Boolean"}, + "VpcId":{"shape":"String"} + }, + "wrapper":true + }, + "OptionGroupAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"OptionGroupAlreadyExistsFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "OptionGroupMembership":{ + "type":"structure", + "members":{ + "OptionGroupName":{"shape":"String"}, + "Status":{"shape":"String"} + } + }, + "OptionGroupMembershipList":{ + "type":"list", + "member":{ + "shape":"OptionGroupMembership", + "locationName":"OptionGroupMembership" + } + }, + "OptionGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"OptionGroupNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "OptionGroupOption":{ + "type":"structure", + "members":{ + "Name":{"shape":"String"}, + "Description":{"shape":"String"}, + "EngineName":{"shape":"String"}, + "MajorEngineVersion":{"shape":"String"}, + "MinimumRequiredMinorEngineVersion":{"shape":"String"}, + "PortRequired":{"shape":"Boolean"}, + "DefaultPort":{"shape":"IntegerOptional"}, + "OptionsDependedOn":{"shape":"OptionsDependedOn"}, + "Persistent":{"shape":"Boolean"}, + "Permanent":{"shape":"Boolean"}, + "OptionGroupOptionSettings":{"shape":"OptionGroupOptionSettingsList"} + } + }, + "OptionGroupOptionSetting":{ + "type":"structure", + "members":{ + "SettingName":{"shape":"String"}, + "SettingDescription":{"shape":"String"}, + "DefaultValue":{"shape":"String"}, + "ApplyType":{"shape":"String"}, + "AllowedValues":{"shape":"String"}, + "IsModifiable":{"shape":"Boolean"} + } + }, + "OptionGroupOptionSettingsList":{ + "type":"list", + "member":{ + "shape":"OptionGroupOptionSetting", + "locationName":"OptionGroupOptionSetting" + } + }, + "OptionGroupOptionsList":{ + "type":"list", + "member":{ + "shape":"OptionGroupOption", + "locationName":"OptionGroupOption" + } + }, + "OptionGroupOptionsMessage":{ + "type":"structure", + "members":{ + "OptionGroupOptions":{"shape":"OptionGroupOptionsList"}, + "Marker":{"shape":"String"} + } + }, + "OptionGroupQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"OptionGroupQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "OptionGroups":{ + "type":"structure", + "members":{ + "OptionGroupsList":{"shape":"OptionGroupsList"}, + "Marker":{"shape":"String"} + } + }, + "OptionGroupsList":{ + "type":"list", + "member":{ + "shape":"OptionGroup", + "locationName":"OptionGroup" + } + }, + "OptionNamesList":{ + "type":"list", + "member":{"shape":"String"} + }, + "OptionSetting":{ + "type":"structure", + "members":{ + "Name":{"shape":"String"}, + "Value":{"shape":"String"}, + "DefaultValue":{"shape":"String"}, + "Description":{"shape":"String"}, + "ApplyType":{"shape":"String"}, + "DataType":{"shape":"String"}, + "AllowedValues":{"shape":"String"}, + "IsModifiable":{"shape":"Boolean"}, + "IsCollection":{"shape":"Boolean"} + } + }, + "OptionSettingConfigurationList":{ + "type":"list", + "member":{ + "shape":"OptionSetting", + "locationName":"OptionSetting" + } + }, + "OptionSettingsList":{ + "type":"list", + "member":{ + "shape":"OptionSetting", + "locationName":"OptionSetting" + } + }, + "OptionsDependedOn":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"OptionName" + } + }, + "OptionsList":{ + "type":"list", + "member":{ + "shape":"Option", + "locationName":"Option" + } + }, + "OrderableDBInstanceOption":{ + "type":"structure", + "members":{ + "Engine":{"shape":"String"}, + "EngineVersion":{"shape":"String"}, + "DBInstanceClass":{"shape":"String"}, + "LicenseModel":{"shape":"String"}, + "AvailabilityZones":{"shape":"AvailabilityZoneList"}, + "MultiAZCapable":{"shape":"Boolean"}, + "ReadReplicaCapable":{"shape":"Boolean"}, + "Vpc":{"shape":"Boolean"} + }, + "wrapper":true + }, + "OrderableDBInstanceOptionsList":{ + "type":"list", + "member":{ + "shape":"OrderableDBInstanceOption", + "locationName":"OrderableDBInstanceOption" + } + }, + "OrderableDBInstanceOptionsMessage":{ + "type":"structure", + "members":{ + "OrderableDBInstanceOptions":{"shape":"OrderableDBInstanceOptionsList"}, + "Marker":{"shape":"String"} + } + }, + "Parameter":{ + "type":"structure", + "members":{ + "ParameterName":{"shape":"String"}, + "ParameterValue":{"shape":"String"}, + "Description":{"shape":"String"}, + "Source":{"shape":"String"}, + "ApplyType":{"shape":"String"}, + "DataType":{"shape":"String"}, + "AllowedValues":{"shape":"String"}, + "IsModifiable":{"shape":"Boolean"}, + "MinimumEngineVersion":{"shape":"String"}, + "ApplyMethod":{"shape":"ApplyMethod"} + } + }, + "ParametersList":{ + "type":"list", + "member":{ + "shape":"Parameter", + "locationName":"Parameter" + } + }, + "PendingModifiedValues":{ + "type":"structure", + "members":{ + "DBInstanceClass":{"shape":"String"}, + "AllocatedStorage":{"shape":"IntegerOptional"}, + "MasterUserPassword":{"shape":"String"}, + "Port":{"shape":"IntegerOptional"}, + "BackupRetentionPeriod":{"shape":"IntegerOptional"}, + "MultiAZ":{"shape":"BooleanOptional"}, + "EngineVersion":{"shape":"String"}, + "Iops":{"shape":"IntegerOptional"}, + "DBInstanceIdentifier":{"shape":"String"} + } + }, + "PointInTimeRestoreNotEnabledFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"PointInTimeRestoreNotEnabled", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "PromoteReadReplicaMessage":{ + "type":"structure", + "required":["DBInstanceIdentifier"], + "members":{ + "DBInstanceIdentifier":{"shape":"String"}, + "BackupRetentionPeriod":{"shape":"IntegerOptional"}, + "PreferredBackupWindow":{"shape":"String"} + } + }, + "PromoteReadReplicaResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "ProvisionedIopsNotAvailableInAZFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ProvisionedIopsNotAvailableInAZFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "PurchaseReservedDBInstancesOfferingMessage":{ + "type":"structure", + "required":["ReservedDBInstancesOfferingId"], + "members":{ + "ReservedDBInstancesOfferingId":{"shape":"String"}, + "ReservedDBInstanceId":{"shape":"String"}, + "DBInstanceCount":{"shape":"IntegerOptional"}, + "Tags":{"shape":"TagList"} + } + }, + "PurchaseReservedDBInstancesOfferingResult":{ + "type":"structure", + "members":{ + "ReservedDBInstance":{"shape":"ReservedDBInstance"} + } + }, + "ReadReplicaDBInstanceIdentifierList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ReadReplicaDBInstanceIdentifier" + } + }, + "RebootDBInstanceMessage":{ + "type":"structure", + "required":["DBInstanceIdentifier"], + "members":{ + "DBInstanceIdentifier":{"shape":"String"}, + "ForceFailover":{"shape":"BooleanOptional"} + } + }, + "RebootDBInstanceResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "RecurringCharge":{ + "type":"structure", + "members":{ + "RecurringChargeAmount":{"shape":"Double"}, + "RecurringChargeFrequency":{"shape":"String"} + }, + "wrapper":true + }, + "RecurringChargeList":{ + "type":"list", + "member":{ + "shape":"RecurringCharge", + "locationName":"RecurringCharge" + } + }, + "RemoveSourceIdentifierFromSubscriptionMessage":{ + "type":"structure", + "required":[ + "SubscriptionName", + "SourceIdentifier" + ], + "members":{ + "SubscriptionName":{"shape":"String"}, + "SourceIdentifier":{"shape":"String"} + } + }, + "RemoveSourceIdentifierFromSubscriptionResult":{ + "type":"structure", + "members":{ + "EventSubscription":{"shape":"EventSubscription"} + } + }, + "RemoveTagsFromResourceMessage":{ + "type":"structure", + "required":[ + "ResourceName", + "TagKeys" + ], + "members":{ + "ResourceName":{"shape":"String"}, + "TagKeys":{"shape":"KeyList"} + } + }, + "ReservedDBInstance":{ + "type":"structure", + "members":{ + "ReservedDBInstanceId":{"shape":"String"}, + "ReservedDBInstancesOfferingId":{"shape":"String"}, + "DBInstanceClass":{"shape":"String"}, + "StartTime":{"shape":"TStamp"}, + "Duration":{"shape":"Integer"}, + "FixedPrice":{"shape":"Double"}, + "UsagePrice":{"shape":"Double"}, + "CurrencyCode":{"shape":"String"}, + "DBInstanceCount":{"shape":"Integer"}, + "ProductDescription":{"shape":"String"}, + "OfferingType":{"shape":"String"}, + "MultiAZ":{"shape":"Boolean"}, + "State":{"shape":"String"}, + "RecurringCharges":{"shape":"RecurringChargeList"} + }, + "wrapper":true + }, + "ReservedDBInstanceAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ReservedDBInstanceAlreadyExists", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ReservedDBInstanceList":{ + "type":"list", + "member":{ + "shape":"ReservedDBInstance", + "locationName":"ReservedDBInstance" + } + }, + "ReservedDBInstanceMessage":{ + "type":"structure", + "members":{ + "Marker":{"shape":"String"}, + "ReservedDBInstances":{"shape":"ReservedDBInstanceList"} + } + }, + "ReservedDBInstanceNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ReservedDBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ReservedDBInstanceQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ReservedDBInstanceQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ReservedDBInstancesOffering":{ + "type":"structure", + "members":{ + "ReservedDBInstancesOfferingId":{"shape":"String"}, + "DBInstanceClass":{"shape":"String"}, + "Duration":{"shape":"Integer"}, + "FixedPrice":{"shape":"Double"}, + "UsagePrice":{"shape":"Double"}, + "CurrencyCode":{"shape":"String"}, + "ProductDescription":{"shape":"String"}, + "OfferingType":{"shape":"String"}, + "MultiAZ":{"shape":"Boolean"}, + "RecurringCharges":{"shape":"RecurringChargeList"} + }, + "wrapper":true + }, + "ReservedDBInstancesOfferingList":{ + "type":"list", + "member":{ + "shape":"ReservedDBInstancesOffering", + "locationName":"ReservedDBInstancesOffering" + } + }, + "ReservedDBInstancesOfferingMessage":{ + "type":"structure", + "members":{ + "Marker":{"shape":"String"}, + "ReservedDBInstancesOfferings":{"shape":"ReservedDBInstancesOfferingList"} + } + }, + "ReservedDBInstancesOfferingNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ReservedDBInstancesOfferingNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ResetDBParameterGroupMessage":{ + "type":"structure", + "required":["DBParameterGroupName"], + "members":{ + "DBParameterGroupName":{"shape":"String"}, + "ResetAllParameters":{"shape":"Boolean"}, + "Parameters":{"shape":"ParametersList"} + } + }, + "RestoreDBInstanceFromDBSnapshotMessage":{ + "type":"structure", + "required":[ + "DBInstanceIdentifier", + "DBSnapshotIdentifier" + ], + "members":{ + "DBInstanceIdentifier":{"shape":"String"}, + "DBSnapshotIdentifier":{"shape":"String"}, + "DBInstanceClass":{"shape":"String"}, + "Port":{"shape":"IntegerOptional"}, + "AvailabilityZone":{"shape":"String"}, + "DBSubnetGroupName":{"shape":"String"}, + "MultiAZ":{"shape":"BooleanOptional"}, + "PubliclyAccessible":{"shape":"BooleanOptional"}, + "AutoMinorVersionUpgrade":{"shape":"BooleanOptional"}, + "LicenseModel":{"shape":"String"}, + "DBName":{"shape":"String"}, + "Engine":{"shape":"String"}, + "Iops":{"shape":"IntegerOptional"}, + "OptionGroupName":{"shape":"String"}, + "Tags":{"shape":"TagList"} + } + }, + "RestoreDBInstanceFromDBSnapshotResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "RestoreDBInstanceToPointInTimeMessage":{ + "type":"structure", + "required":[ + "SourceDBInstanceIdentifier", + "TargetDBInstanceIdentifier" + ], + "members":{ + "SourceDBInstanceIdentifier":{"shape":"String"}, + "TargetDBInstanceIdentifier":{"shape":"String"}, + "RestoreTime":{"shape":"TStamp"}, + "UseLatestRestorableTime":{"shape":"Boolean"}, + "DBInstanceClass":{"shape":"String"}, + "Port":{"shape":"IntegerOptional"}, + "AvailabilityZone":{"shape":"String"}, + "DBSubnetGroupName":{"shape":"String"}, + "MultiAZ":{"shape":"BooleanOptional"}, + "PubliclyAccessible":{"shape":"BooleanOptional"}, + "AutoMinorVersionUpgrade":{"shape":"BooleanOptional"}, + "LicenseModel":{"shape":"String"}, + "DBName":{"shape":"String"}, + "Engine":{"shape":"String"}, + "Iops":{"shape":"IntegerOptional"}, + "OptionGroupName":{"shape":"String"}, + "Tags":{"shape":"TagList"} + } + }, + "RestoreDBInstanceToPointInTimeResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "RevokeDBSecurityGroupIngressMessage":{ + "type":"structure", + "required":["DBSecurityGroupName"], + "members":{ + "DBSecurityGroupName":{"shape":"String"}, + "CIDRIP":{"shape":"String"}, + "EC2SecurityGroupName":{"shape":"String"}, + "EC2SecurityGroupId":{"shape":"String"}, + "EC2SecurityGroupOwnerId":{"shape":"String"} + } + }, + "RevokeDBSecurityGroupIngressResult":{ + "type":"structure", + "members":{ + "DBSecurityGroup":{"shape":"DBSecurityGroup"} + } + }, + "SNSInvalidTopicFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SNSInvalidTopic", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "SNSNoAuthorizationFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SNSNoAuthorization", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "SNSTopicArnNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SNSTopicArnNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "SnapshotQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SnapshotQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "SourceIdsList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SourceId" + } + }, + "SourceNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SourceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "SourceType":{ + "type":"string", + "enum":[ + "db-instance", + "db-parameter-group", + "db-security-group", + "db-snapshot" + ] + }, + "StorageQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"StorageQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "String":{"type":"string"}, + "Subnet":{ + "type":"structure", + "members":{ + "SubnetIdentifier":{"shape":"String"}, + "SubnetAvailabilityZone":{"shape":"AvailabilityZone"}, + "SubnetStatus":{"shape":"String"} + } + }, + "SubnetAlreadyInUse":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SubnetAlreadyInUse", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "SubnetIdentifierList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SubnetIdentifier" + } + }, + "SubnetList":{ + "type":"list", + "member":{ + "shape":"Subnet", + "locationName":"Subnet" + } + }, + "SubscriptionAlreadyExistFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SubscriptionAlreadyExist", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "SubscriptionCategoryNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SubscriptionCategoryNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "SubscriptionNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SubscriptionNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "SupportedCharacterSetsList":{ + "type":"list", + "member":{ + "shape":"CharacterSet", + "locationName":"CharacterSet" + } + }, + "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"} + } + }, + "VpcSecurityGroupIdList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"VpcSecurityGroupId" + } + }, + "VpcSecurityGroupMembership":{ + "type":"structure", + "members":{ + "VpcSecurityGroupId":{"shape":"String"}, + "Status":{"shape":"String"} + } + }, + "VpcSecurityGroupMembershipList":{ + "type":"list", + "member":{ + "shape":"VpcSecurityGroupMembership", + "locationName":"VpcSecurityGroupMembership" + } + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/rds/2013-09-09/docs-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/rds/2013-09-09/docs-2.json new file mode 100644 index 000000000..f0a22a6eb --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/rds/2013-09-09/docs-2.json @@ -0,0 +1,1876 @@ +{ + "version": "2.0", + "service": "Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and scale a relational database in the cloud. It provides cost-efficient, resizable capacity for an industry-standard relational database and manages common database administration tasks, freeing up developers to focus on what makes their applications and businesses unique.
Amazon RDS gives you access to the capabilities of a MySQL, PostgreSQL, Microsoft SQL Server, or Oracle database server. This means the code, applications, and tools you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS is flexible: you can scale your database instance's compute resources and storage capacity to meet your application's demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for the resources you use.
This is an interface reference for Amazon RDS. It contains documentation for a programming or command line interface you can use to manage Amazon RDS. Note that Amazon RDS is asynchronous, which means that some interfaces may require techniques such as polling or callback functions to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, or during the maintenance window. For a summary of the Amazon RDS interfaces, go to Available RDS Interfaces.
", + "operations": { + "AddSourceIdentifierToSubscription": "Adds a source identifier to an existing RDS event notification subscription.
", + "AddTagsToResource": "Adds metadata tags to an Amazon RDS resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon RDS resources, or used in Condition statement in IAM policy for Amazon RDS.
For an overview on tagging Amazon RDS resources, see Tagging Amazon RDS Resources.
", + "AuthorizeDBSecurityGroupIngress": "Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC instances. Second, IP ranges are available if the application accessing your database is running on the Internet. Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).
For an overview of CIDR ranges, go to the Wikipedia Tutorial.
", + "CopyDBSnapshot": "Copies the specified DBSnapshot. The source DBSnapshot must be in the \"available\" state.
", + "CreateDBInstance": "Creates a new DB instance.
", + "CreateDBInstanceReadReplica": "Creates a DB instance that acts as a read replica of a source DB instance.
All read replica DB instances are created as Single-AZ deployments with backups disabled. All other DB instance attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance, except as specified below.
The source DB instance must have backup retention enabled.
Creates a new DB parameter group.
A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup. Once you've created a DB parameter group, you need to associate it with your DB instance using ModifyDBInstance. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB Instance for the new DB parameter group and associated settings to take effect.
After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.
Creates a new DB security group. DB security groups control access to a DB instance.
", + "CreateDBSnapshot": "Creates a DBSnapshot. The source DBInstance must be in \"available\" state.
", + "CreateDBSubnetGroup": "Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the region.
", + "CreateEventSubscription": "Creates an RDS event notification subscription. This action requires a topic ARN (Amazon Resource Name) created by either the RDS console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.
You can specify the type of source (SourceType) you want to be notified of, provide a list of RDS sources (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.
If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIdentifier = myDBInstance1, you will be notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you will receive notice of the events for that source type for all your RDS sources. If you do not specify either the SourceType nor the SourceIdentifier, you will be notified of events generated from all RDS sources belonging to your customer account.
", + "CreateOptionGroup": "Creates a new option group. You can create up to 20 option groups.
", + "DeleteDBInstance": "The DeleteDBInstance action deletes a previously provisioned DB instance. A successful response from the web service indicates the request was received correctly. When you delete a DB instance, all automated backups for that instance are deleted and cannot be recovered. Manual DB snapshots of the DB instance to be deleted are not deleted.
If a final DB snapshot is requested the status of the RDS instance will be \"deleting\" until the DB snapshot is created. The API action DescribeDBInstance is used to monitor the status of this operation. The action cannot be canceled or reverted once submitted.
Deletes a specified DBParameterGroup. The DBParameterGroup cannot be associated with any RDS instances to be deleted.
Deletes a DB security group.
Deletes a DBSnapshot. If the snapshot is being copied, the copy operation is terminated.
available state to be deleted.Deletes a DB subnet group.
Deletes an RDS event notification subscription.
", + "DeleteOptionGroup": "Deletes an existing option group.
", + "DescribeDBEngineVersions": "Returns a list of the available DB engines.
", + "DescribeDBInstances": "Returns information about provisioned RDS instances. This API supports pagination.
", + "DescribeDBLogFiles": "Returns a list of DB log files for the DB instance.
", + "DescribeDBParameterGroups": " Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DB parameter group.
Returns the detailed parameter list for a particular DB parameter group.
", + "DescribeDBSecurityGroups": " Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified, the list will contain only the descriptions of the specified DB security group.
Returns information about DB snapshots. This API supports pagination.
", + "DescribeDBSubnetGroups": "Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.
For an overview of CIDR ranges, go to the Wikipedia Tutorial.
", + "DescribeEngineDefaultParameters": "Returns the default engine and system parameter information for the specified database engine.
", + "DescribeEventCategories": "Displays a list of categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in the Events topic in the Amazon RDS User Guide.
", + "DescribeEventSubscriptions": "Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.
If you specify a SubscriptionName, lists the description for that subscription.
", + "DescribeEvents": "Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.
", + "DescribeOptionGroupOptions": "Describes all available options.
", + "DescribeOptionGroups": "Describes the available option groups.
", + "DescribeOrderableDBInstanceOptions": "Returns a list of orderable DB instance options for the specified engine.
", + "DescribeReservedDBInstances": "Returns information about reserved DB instances for this account, or about a specified reserved DB instance.
", + "DescribeReservedDBInstancesOfferings": "Lists available reserved DB instance offerings.
", + "DownloadDBLogFilePortion": "Downloads all or a portion of the specified log file.
", + "ListTagsForResource": "Lists all tags on an Amazon RDS resource.
For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources.
", + "ModifyDBInstance": "Modify settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.
", + "ModifyDBParameterGroup": " Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.
The apply-immediate method can be used only for dynamic parameters; the pending-reboot method can be used with MySQL, PostgreSQL, and Oracle DB instances for either dynamic or static parameters. For Microsoft SQL Server DB instances, the pending-reboot method can be used only for static parameters.
After you modify a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the modify action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.
Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the region.
", + "ModifyEventSubscription": "Modifies an existing RDS event notification subscription. Note that you cannot modify the source identifiers using this call; to change source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.
You can see a list of the event categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.
", + "ModifyOptionGroup": "Modifies an existing option group.
", + "PromoteReadReplica": "Promotes a read replica DB instance to a standalone DB instance.
We recommend that you enable automated backups on your read replica before promoting the read replica. This ensures that no backup is taken during the promotion process. Once the instance is promoted to a primary instance, backups are taken based on your backup settings.
Purchases a reserved DB instance offering.
", + "RebootDBInstance": "Rebooting a DB instance restarts the database engine service. A reboot also applies to the DB instance any modifications to the associated DB parameter group that were pending. Rebooting a DB instance results in a momentary outage of the instance, during which the DB instance status is set to rebooting. If the RDS instance is configured for MultiAZ, it is possible that the reboot will be conducted through a failover. An Amazon RDS event is created when the reboot is completed.
If your DB instance is deployed in multiple Availability Zones, you can force a failover from one AZ to the other during the reboot. You might force a failover to test the availability of your DB instance deployment or to restore operations to the original AZ after a failover occurs.
The time required to reboot is a function of the specific database engine's crash recovery process. To improve the reboot time, we recommend that you reduce database activities as much as possible during the reboot process to reduce rollback activity for in-transit transactions.
", + "RemoveSourceIdentifierFromSubscription": "Removes a source identifier from an existing RDS event notification subscription.
", + "RemoveTagsFromResource": "Removes metadata tags from an Amazon RDS resource.
For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources.
", + "ResetDBParameterGroup": " Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request.
Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with the same configuration as the original source database, except that the new RDS instance is created with the default security group.
", + "RestoreDBInstanceToPointInTime": "Restores a DB instance to an arbitrary point-in-time. Users can restore to any point in time before the latestRestorableTime for up to backupRetentionPeriod days. The target database is created from the source database with the same configuration as the original database except that the DB instance is created with the default DB security group.
", + "RevokeDBSecurityGroupIngress": "Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC Security Groups. Required parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId).
" + }, + "shapes": { + "AddSourceIdentifierToSubscriptionMessage": { + "base": "", + "refs": { + } + }, + "AddSourceIdentifierToSubscriptionResult": { + "base": null, + "refs": { + } + }, + "AddTagsToResourceMessage": { + "base": "", + "refs": { + } + }, + "ApplyMethod": { + "base": null, + "refs": { + "Parameter$ApplyMethod": "Indicates when to apply parameter updates.
" + } + }, + "AuthorizationAlreadyExistsFault": { + "base": "The specified CIDRIP or EC2 security group is already authorized for the specified DB security group.
", + "refs": { + } + }, + "AuthorizationNotFoundFault": { + "base": "Specified CIDRIP or EC2 security group is not authorized for the specified DB security group.
RDS may not also be authorized via IAM to perform necessary actions on your behalf.
", + "refs": { + } + }, + "AuthorizationQuotaExceededFault": { + "base": "DB security group authorization quota has been reached.
", + "refs": { + } + }, + "AuthorizeDBSecurityGroupIngressMessage": { + "base": "", + "refs": { + } + }, + "AuthorizeDBSecurityGroupIngressResult": { + "base": null, + "refs": { + } + }, + "AvailabilityZone": { + "base": "
Contains Availability Zone information.
This data type is used as an element in the following data type:
", + "refs": { + "AvailabilityZoneList$member": null, + "Subnet$SubnetAvailabilityZone": null + } + }, + "AvailabilityZoneList": { + "base": null, + "refs": { + "OrderableDBInstanceOption$AvailabilityZones": "A list of availability zones for the orderable DB instance.
" + } + }, + "Boolean": { + "base": null, + "refs": { + "AvailabilityZone$ProvisionedIopsCapable": "True indicates the availability zone is capable of provisioned IOPs.
", + "DBInstance$MultiAZ": "Specifies if the DB instance is a Multi-AZ deployment.
", + "DBInstance$AutoMinorVersionUpgrade": "Indicates that minor version patches are applied automatically.
", + "DBInstance$PubliclyAccessible": "Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.
", + "DBInstanceStatusInfo$Normal": "Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.
", + "DeleteDBInstanceMessage$SkipFinalSnapshot": " Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted.
Specify true when deleting a read replica.
false.Default: false
Indicates that only the default version of the specified engine or engine and major version combination is returned.
", + "DownloadDBLogFilePortionDetails$AdditionalDataPending": "Boolean value that if true, indicates there is more data to be downloaded.
", + "EventSubscription$Enabled": "A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.
", + "ModifyDBInstanceMessage$ApplyImmediately": "Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB instance.
If this parameter is set to false, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage and will be applied on the next call to RebootDBInstance, or the next failure reboot. Review the table of parameters in Modifying a DB Instance and Using the Apply Immediately Parameter to see the impact that setting ApplyImmediately to true or false has for each modified parameter and to determine when the changes will be applied.
Default: false
Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.
Constraints: This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.
", + "ModifyOptionGroupMessage$ApplyImmediately": "Indicates whether the changes should be applied immediately, or during the next maintenance window for each instance associated with the option group.
", + "Option$Persistent": "Indicate if this option is persistent.
", + "Option$Permanent": "Indicate if this option is permanent.
", + "OptionGroup$AllowsVpcAndNonVpcInstanceMemberships": "Indicates whether this option group can be applied to both VPC and non-VPC instances. The value 'true' indicates the option group can be applied to both VPC and non-VPC instances.
", + "OptionGroupOption$PortRequired": "Specifies whether the option requires a port.
", + "OptionGroupOption$Persistent": "A persistent option cannot be removed from the option group once the option group is used, but this option can be removed from the db instance while modifying the related data and assigning another option group without this option.
", + "OptionGroupOption$Permanent": "A permanent option cannot be removed from the option group once the option group is used, and it cannot be removed from the db instance after assigning an option group with this permanent option.
", + "OptionGroupOptionSetting$IsModifiable": "Boolean value where true indicates that this option group option can be changed from the default value.
", + "OptionSetting$IsModifiable": "A Boolean value that, when true, indicates the option setting can be modified from the default.
", + "OptionSetting$IsCollection": "Indicates if the option setting is part of a collection.
", + "OrderableDBInstanceOption$MultiAZCapable": "Indicates whether this orderable DB instance is multi-AZ capable.
", + "OrderableDBInstanceOption$ReadReplicaCapable": "Indicates whether this orderable DB instance can have a read replica.
", + "OrderableDBInstanceOption$Vpc": "Indicates whether this is a VPC orderable DB instance.
", + "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.
Indicates if the reservation applies to Multi-AZ deployments.
", + "ReservedDBInstancesOffering$MultiAZ": "Indicates if the offering applies to Multi-AZ deployments.
", + "ResetDBParameterGroupMessage$ResetAllParameters": " Specifies whether (true) or not (false) to reset all parameters in the DB parameter group to default values.
Default: true
Specifies whether (true) or not (false) the DB instance is restored from the latest backup time.
Default: false
Constraints: Cannot be specified if RestoreTime parameter is provided.
" + } + }, + "BooleanOptional": { + "base": null, + "refs": { + "CreateDBInstanceMessage$MultiAZ": "Specifies if the DB instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the MultiAZ parameter is set to true.
", + "CreateDBInstanceMessage$AutoMinorVersionUpgrade": "Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window.
Default: true
Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.
", + "CreateDBInstanceReadReplicaMessage$AutoMinorVersionUpgrade": "Indicates that minor engine upgrades will be applied automatically to the read replica during the maintenance window.
Default: Inherits from the source DB instance
", + "CreateDBInstanceReadReplicaMessage$PubliclyAccessible": "Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.
", + "CreateEventSubscriptionMessage$Enabled": "A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.
", + "DescribeDBEngineVersionsMessage$ListSupportedCharacterSets": "If this parameter is specified, and if the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.
", + "DescribeOrderableDBInstanceOptionsMessage$Vpc": "The VPC filter value. Specify this parameter to show only the available VPC or non-VPC offerings.
", + "DescribeReservedDBInstancesMessage$MultiAZ": "The Multi-AZ filter value. Specify this parameter to show only those reservations matching the specified Multi-AZ parameter.
", + "DescribeReservedDBInstancesOfferingsMessage$MultiAZ": "The Multi-AZ filter value. Specify this parameter to show only the available offerings matching the specified Multi-AZ parameter.
", + "ModifyDBInstanceMessage$MultiAZ": " Specifies if the DB instance is a Multi-AZ deployment. Changing this parameter does not result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.
Constraints: Cannot be specified if the DB instance is a read replica.
", + "ModifyDBInstanceMessage$AutoMinorVersionUpgrade": " Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window. Changing this parameter does not result in an outage except in the following case and the change is asynchronously applied as soon as possible. An outage will result if this parameter is set to true during the maintenance window, and a newer minor version is available, and RDS has enabled auto patching for that engine version.
A Boolean value; set to true to activate the subscription.
", + "PendingModifiedValues$MultiAZ": "Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.
", + "RebootDBInstanceMessage$ForceFailover": " When true, the reboot will be conducted through a MultiAZ failover.
Constraint: You cannot specify true if the instance is not configured for MultiAZ.
Specifies if the DB instance is a Multi-AZ deployment.
Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.
Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.
", + "RestoreDBInstanceFromDBSnapshotMessage$AutoMinorVersionUpgrade": "Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window.
", + "RestoreDBInstanceToPointInTimeMessage$MultiAZ": "Specifies if the DB instance is a Multi-AZ deployment.
Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.
Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.
", + "RestoreDBInstanceToPointInTimeMessage$AutoMinorVersionUpgrade": "Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window.
" + } + }, + "CharacterSet": { + "base": "This data type is used as a response element in the action DescribeDBEngineVersions.
", + "refs": { + "DBEngineVersion$DefaultCharacterSet": " The default character set for new instances of this engine version, if the CharacterSetName parameter of the CreateDBInstance API is not specified.
", + "refs": { + } + }, + "CopyDBSnapshotResult": { + "base": null, + "refs": { + } + }, + "CreateDBInstanceMessage": { + "base": "
", + "refs": { + } + }, + "CreateDBInstanceReadReplicaMessage": { + "base": null, + "refs": { + } + }, + "CreateDBInstanceReadReplicaResult": { + "base": null, + "refs": { + } + }, + "CreateDBInstanceResult": { + "base": null, + "refs": { + } + }, + "CreateDBParameterGroupMessage": { + "base": "
", + "refs": { + } + }, + "CreateDBParameterGroupResult": { + "base": null, + "refs": { + } + }, + "CreateDBSecurityGroupMessage": { + "base": "
", + "refs": { + } + }, + "CreateDBSecurityGroupResult": { + "base": null, + "refs": { + } + }, + "CreateDBSnapshotMessage": { + "base": "
", + "refs": { + } + }, + "CreateDBSnapshotResult": { + "base": null, + "refs": { + } + }, + "CreateDBSubnetGroupMessage": { + "base": "
", + "refs": { + } + }, + "CreateDBSubnetGroupResult": { + "base": null, + "refs": { + } + }, + "CreateEventSubscriptionMessage": { + "base": "", + "refs": { + } + }, + "CreateEventSubscriptionResult": { + "base": null, + "refs": { + } + }, + "CreateOptionGroupMessage": { + "base": "", + "refs": { + } + }, + "CreateOptionGroupResult": { + "base": null, + "refs": { + } + }, + "DBEngineVersion": { + "base": "
This data type is used as a response element in the action DescribeDBEngineVersions.
", + "refs": { + "DBEngineVersionList$member": null + } + }, + "DBEngineVersionList": { + "base": null, + "refs": { + "DBEngineVersionMessage$DBEngineVersions": " A list of DBEngineVersion elements.
Contains the result of a successful invocation of the DescribeDBEngineVersions action.
", + "refs": { + } + }, + "DBInstance": { + "base": "Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBInstances action.
", + "refs": { + "CreateDBInstanceReadReplicaResult$DBInstance": null, + "CreateDBInstanceResult$DBInstance": null, + "DBInstanceList$member": null, + "DeleteDBInstanceResult$DBInstance": null, + "ModifyDBInstanceResult$DBInstance": null, + "PromoteReadReplicaResult$DBInstance": null, + "RebootDBInstanceResult$DBInstance": null, + "RestoreDBInstanceFromDBSnapshotResult$DBInstance": null, + "RestoreDBInstanceToPointInTimeResult$DBInstance": null + } + }, + "DBInstanceAlreadyExistsFault": { + "base": "User already has a DB instance with the given identifier.
", + "refs": { + } + }, + "DBInstanceList": { + "base": null, + "refs": { + "DBInstanceMessage$DBInstances": "A list of DBInstance instances.
" + } + }, + "DBInstanceMessage": { + "base": "Contains the result of a successful invocation of the DescribeDBInstances action.
", + "refs": { + } + }, + "DBInstanceNotFoundFault": { + "base": "DBInstanceIdentifier does not refer to an existing DB instance.
", + "refs": { + } + }, + "DBInstanceStatusInfo": { + "base": "Provides a list of status information for a DB instance.
", + "refs": { + "DBInstanceStatusInfoList$member": null + } + }, + "DBInstanceStatusInfoList": { + "base": null, + "refs": { + "DBInstance$StatusInfos": "The status of a read replica. If the instance is not a read replica, this will be blank.
" + } + }, + "DBLogFileNotFoundFault": { + "base": "LogFileName does not refer to an existing DB log file.
", + "refs": { + } + }, + "DBParameterGroup": { + "base": "Contains the result of a successful invocation of the CreateDBParameterGroup action.
This data type is used as a request parameter in the DeleteDBParameterGroup action, and as a response element in the DescribeDBParameterGroups action.
", + "refs": { + "CreateDBParameterGroupResult$DBParameterGroup": null, + "DBParameterGroupList$member": null + } + }, + "DBParameterGroupAlreadyExistsFault": { + "base": "A DB parameter group with the same name exists.
", + "refs": { + } + }, + "DBParameterGroupDetails": { + "base": "Contains the result of a successful invocation of the DescribeDBParameters action.
", + "refs": { + } + }, + "DBParameterGroupList": { + "base": null, + "refs": { + "DBParameterGroupsMessage$DBParameterGroups": "A list of DBParameterGroup instances.
" + } + }, + "DBParameterGroupNameMessage": { + "base": "Contains the result of a successful invocation of the ModifyDBParameterGroup or ResetDBParameterGroup action.
", + "refs": { + } + }, + "DBParameterGroupNotFoundFault": { + "base": "DBParameterGroupName does not refer to an existing DB parameter group.
", + "refs": { + } + }, + "DBParameterGroupQuotaExceededFault": { + "base": "Request would result in user exceeding the allowed number of DB parameter groups.
", + "refs": { + } + }, + "DBParameterGroupStatus": { + "base": "The status of the DB parameter group.
This data type is used as a response element in the following actions:
Provides the list of DB parameter groups applied to this DB instance.
" + } + }, + "DBParameterGroupsMessage": { + "base": "Contains the result of a successful invocation of the DescribeDBParameterGroups action.
", + "refs": { + } + }, + "DBSecurityGroup": { + "base": "Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBSecurityGroups action.
", + "refs": { + "AuthorizeDBSecurityGroupIngressResult$DBSecurityGroup": null, + "CreateDBSecurityGroupResult$DBSecurityGroup": null, + "DBSecurityGroups$member": null, + "RevokeDBSecurityGroupIngressResult$DBSecurityGroup": null + } + }, + "DBSecurityGroupAlreadyExistsFault": { + "base": "A DB security group with the name specified in DBSecurityGroupName already exists.
", + "refs": { + } + }, + "DBSecurityGroupMembership": { + "base": "This data type is used as a response element in the following actions:
", + "refs": { + "DBSecurityGroupMembershipList$member": null + } + }, + "DBSecurityGroupMembershipList": { + "base": null, + "refs": { + "DBInstance$DBSecurityGroups": " Provides List of DB security group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.
If the option requires access to a port, then this DB security group allows access to the port.
" + } + }, + "DBSecurityGroupMessage": { + "base": "Contains the result of a successful invocation of the DescribeDBSecurityGroups action.
", + "refs": { + } + }, + "DBSecurityGroupNameList": { + "base": null, + "refs": { + "CreateDBInstanceMessage$DBSecurityGroups": "A list of DB security groups to associate with this DB instance.
Default: The default DB security group for the database engine.
", + "ModifyDBInstanceMessage$DBSecurityGroups": "A list of DB security groups to authorize on this DB instance. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.
Constraints:
A list of DBSecurityGroupMemebrship name strings used for this option.
" + } + }, + "DBSecurityGroupNotFoundFault": { + "base": "DBSecurityGroupName does not refer to an existing DB security group.
", + "refs": { + } + }, + "DBSecurityGroupNotSupportedFault": { + "base": "A DB security group is not allowed for this action.
", + "refs": { + } + }, + "DBSecurityGroupQuotaExceededFault": { + "base": "Request would result in user exceeding the allowed number of DB security groups.
", + "refs": { + } + }, + "DBSecurityGroups": { + "base": null, + "refs": { + "DBSecurityGroupMessage$DBSecurityGroups": "A list of DBSecurityGroup instances.
" + } + }, + "DBSnapshot": { + "base": "Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBSnapshots action.
", + "refs": { + "CopyDBSnapshotResult$DBSnapshot": null, + "CreateDBSnapshotResult$DBSnapshot": null, + "DBSnapshotList$member": null, + "DeleteDBSnapshotResult$DBSnapshot": null + } + }, + "DBSnapshotAlreadyExistsFault": { + "base": "DBSnapshotIdentifier is already used by an existing snapshot.
", + "refs": { + } + }, + "DBSnapshotList": { + "base": null, + "refs": { + "DBSnapshotMessage$DBSnapshots": "A list of DBSnapshot instances.
" + } + }, + "DBSnapshotMessage": { + "base": "Contains the result of a successful invocation of the DescribeDBSnapshots action.
", + "refs": { + } + }, + "DBSnapshotNotFoundFault": { + "base": "DBSnapshotIdentifier does not refer to an existing DB snapshot.
", + "refs": { + } + }, + "DBSubnetGroup": { + "base": "Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBSubnetGroups action.
", + "refs": { + "CreateDBSubnetGroupResult$DBSubnetGroup": null, + "DBInstance$DBSubnetGroup": "Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
", + "DBSubnetGroups$member": null, + "ModifyDBSubnetGroupResult$DBSubnetGroup": null + } + }, + "DBSubnetGroupAlreadyExistsFault": { + "base": "DBSubnetGroupName is already used by an existing DB subnet group.
", + "refs": { + } + }, + "DBSubnetGroupDoesNotCoverEnoughAZs": { + "base": "Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
", + "refs": { + } + }, + "DBSubnetGroupMessage": { + "base": "Contains the result of a successful invocation of the DescribeDBSubnetGroups action.
", + "refs": { + } + }, + "DBSubnetGroupNotAllowedFault": { + "base": "Indicates that the DBSubnetGroup should not be specified while creating read replicas that lie in the same region as the source instance.
", + "refs": { + } + }, + "DBSubnetGroupNotFoundFault": { + "base": "DBSubnetGroupName does not refer to an existing DB subnet group.
", + "refs": { + } + }, + "DBSubnetGroupQuotaExceededFault": { + "base": "Request would result in user exceeding the allowed number of DB subnet groups.
", + "refs": { + } + }, + "DBSubnetGroups": { + "base": null, + "refs": { + "DBSubnetGroupMessage$DBSubnetGroups": "A list of DBSubnetGroup instances.
" + } + }, + "DBSubnetQuotaExceededFault": { + "base": "Request would result in user exceeding the allowed number of subnets in a DB subnet groups.
", + "refs": { + } + }, + "DBUpgradeDependencyFailureFault": { + "base": "The DB upgrade failed because a resource the DB depends on could not be modified.
", + "refs": { + } + }, + "DeleteDBInstanceMessage": { + "base": "", + "refs": { + } + }, + "DeleteDBInstanceResult": { + "base": null, + "refs": { + } + }, + "DeleteDBParameterGroupMessage": { + "base": "
", + "refs": { + } + }, + "DeleteDBSecurityGroupMessage": { + "base": "
", + "refs": { + } + }, + "DeleteDBSnapshotMessage": { + "base": "
", + "refs": { + } + }, + "DeleteDBSnapshotResult": { + "base": null, + "refs": { + } + }, + "DeleteDBSubnetGroupMessage": { + "base": "
", + "refs": { + } + }, + "DeleteEventSubscriptionMessage": { + "base": "", + "refs": { + } + }, + "DeleteEventSubscriptionResult": { + "base": null, + "refs": { + } + }, + "DeleteOptionGroupMessage": { + "base": "
", + "refs": { + } + }, + "DescribeDBEngineVersionsMessage": { + "base": null, + "refs": { + } + }, + "DescribeDBInstancesMessage": { + "base": "
", + "refs": { + } + }, + "DescribeDBLogFilesDetails": { + "base": "
This data type is used as a response element to DescribeDBLogFiles.
", + "refs": { + "DescribeDBLogFilesList$member": null + } + }, + "DescribeDBLogFilesList": { + "base": null, + "refs": { + "DescribeDBLogFilesResponse$DescribeDBLogFiles": "The DB log files returned.
" + } + }, + "DescribeDBLogFilesMessage": { + "base": "", + "refs": { + } + }, + "DescribeDBLogFilesResponse": { + "base": "
The response from a call to DescribeDBLogFiles.
", + "refs": { + } + }, + "DescribeDBParameterGroupsMessage": { + "base": "", + "refs": { + } + }, + "DescribeDBParametersMessage": { + "base": null, + "refs": { + } + }, + "DescribeDBSecurityGroupsMessage": { + "base": "
", + "refs": { + } + }, + "DescribeDBSnapshotsMessage": { + "base": "
", + "refs": { + } + }, + "DescribeDBSubnetGroupsMessage": { + "base": "
", + "refs": { + } + }, + "DescribeEngineDefaultParametersMessage": { + "base": "
", + "refs": { + } + }, + "DescribeEngineDefaultParametersResult": { + "base": null, + "refs": { + } + }, + "DescribeEventCategoriesMessage": { + "base": "", + "refs": { + } + }, + "DescribeEventSubscriptionsMessage": { + "base": "", + "refs": { + } + }, + "DescribeEventsMessage": { + "base": "
", + "refs": { + } + }, + "DescribeOptionGroupOptionsMessage": { + "base": "
", + "refs": { + } + }, + "DescribeOptionGroupsMessage": { + "base": "
", + "refs": { + } + }, + "DescribeOrderableDBInstanceOptionsMessage": { + "base": "
", + "refs": { + } + }, + "DescribeReservedDBInstancesMessage": { + "base": "
", + "refs": { + } + }, + "DescribeReservedDBInstancesOfferingsMessage": { + "base": "
", + "refs": { + } + }, + "Double": { + "base": null, + "refs": { + "RecurringCharge$RecurringChargeAmount": "
The amount of the recurring charge.
", + "ReservedDBInstance$FixedPrice": "The fixed price charged for this reserved DB instance.
", + "ReservedDBInstance$UsagePrice": "The hourly price charged for this reserved DB instance.
", + "ReservedDBInstancesOffering$FixedPrice": "The fixed price charged for this offering.
", + "ReservedDBInstancesOffering$UsagePrice": "The hourly price charged for this offering.
" + } + }, + "DownloadDBLogFilePortionDetails": { + "base": "This data type is used as a response element to DownloadDBLogFilePortion.
", + "refs": { + } + }, + "DownloadDBLogFilePortionMessage": { + "base": "", + "refs": { + } + }, + "EC2SecurityGroup": { + "base": "
This data type is used as a response element in the following actions:
", + "refs": { + "EC2SecurityGroupList$member": null + } + }, + "EC2SecurityGroupList": { + "base": null, + "refs": { + "DBSecurityGroup$EC2SecurityGroups": "Contains a list of EC2SecurityGroup elements.
" + } + }, + "Endpoint": { + "base": "This data type is used as a response element in the following actions:
", + "refs": { + "DBInstance$Endpoint": "Specifies the connection endpoint.
" + } + }, + "EngineDefaults": { + "base": "Contains the result of a successful invocation of the DescribeEngineDefaultParameters action.
", + "refs": { + "DescribeEngineDefaultParametersResult$EngineDefaults": null + } + }, + "Event": { + "base": "This data type is used as a response element in the DescribeEvents action.
", + "refs": { + "EventList$member": null + } + }, + "EventCategoriesList": { + "base": null, + "refs": { + "CreateEventSubscriptionMessage$EventCategories": "A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.
", + "DescribeEventsMessage$EventCategories": "A list of event categories that trigger notifications for a event notification subscription.
", + "Event$EventCategories": "Specifies the category for the event.
", + "EventCategoriesMap$EventCategories": "The event categories for the specified source type
", + "EventSubscription$EventCategoriesList": "A list of event categories for the RDS event notification subscription.
", + "ModifyEventSubscriptionMessage$EventCategories": "A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.
" + } + }, + "EventCategoriesMap": { + "base": "Contains the results of a successful invocation of the DescribeEventCategories action.
", + "refs": { + "EventCategoriesMapList$member": null + } + }, + "EventCategoriesMapList": { + "base": null, + "refs": { + "EventCategoriesMessage$EventCategoriesMapList": "A list of EventCategoriesMap data types.
" + } + }, + "EventCategoriesMessage": { + "base": "Data returned from the DescribeEventCategories action.
", + "refs": { + } + }, + "EventList": { + "base": null, + "refs": { + "EventsMessage$Events": "A list of Event instances.
" + } + }, + "EventSubscription": { + "base": "Contains the results of a successful invocation of the DescribeEventSubscriptions action.
", + "refs": { + "AddSourceIdentifierToSubscriptionResult$EventSubscription": null, + "CreateEventSubscriptionResult$EventSubscription": null, + "DeleteEventSubscriptionResult$EventSubscription": null, + "EventSubscriptionsList$member": null, + "ModifyEventSubscriptionResult$EventSubscription": null, + "RemoveSourceIdentifierFromSubscriptionResult$EventSubscription": null + } + }, + "EventSubscriptionQuotaExceededFault": { + "base": "You have reached the maximum number of event subscriptions.
", + "refs": { + } + }, + "EventSubscriptionsList": { + "base": null, + "refs": { + "EventSubscriptionsMessage$EventSubscriptionsList": "A list of EventSubscriptions data types.
" + } + }, + "EventSubscriptionsMessage": { + "base": "Data returned by the DescribeEventSubscriptions action.
", + "refs": { + } + }, + "EventsMessage": { + "base": "Contains the result of a successful invocation of the DescribeEvents action.
", + "refs": { + } + }, + "Filter": { + "base": null, + "refs": { + "FilterList$member": null + } + }, + "FilterList": { + "base": null, + "refs": { + "DescribeDBEngineVersionsMessage$Filters": "Not currently supported.
", + "DescribeDBInstancesMessage$Filters": "This parameter is not currently supported.
", + "DescribeDBLogFilesMessage$Filters": "This parameter is not currently supported.
", + "DescribeDBParameterGroupsMessage$Filters": "This parameter is not currently supported.
", + "DescribeDBParametersMessage$Filters": "This parameter is not currently supported.
", + "DescribeDBSecurityGroupsMessage$Filters": "This parameter is not currently supported.
", + "DescribeDBSnapshotsMessage$Filters": "This parameter is not currently supported.
", + "DescribeDBSubnetGroupsMessage$Filters": "This parameter is not currently supported.
", + "DescribeEngineDefaultParametersMessage$Filters": "Not currently supported.
", + "DescribeEventCategoriesMessage$Filters": "This parameter is not currently supported.
", + "DescribeEventSubscriptionsMessage$Filters": "This parameter is not currently supported.
", + "DescribeEventsMessage$Filters": "This parameter is not currently supported.
", + "DescribeOptionGroupOptionsMessage$Filters": "This parameter is not currently supported.
", + "DescribeOptionGroupsMessage$Filters": "This parameter is not currently supported.
", + "DescribeOrderableDBInstanceOptionsMessage$Filters": "This parameter is not currently supported.
", + "DescribeReservedDBInstancesMessage$Filters": "This parameter is not currently supported.
", + "DescribeReservedDBInstancesOfferingsMessage$Filters": "This parameter is not currently supported.
", + "ListTagsForResourceMessage$Filters": "This parameter is not currently supported.
" + } + }, + "FilterValueList": { + "base": null, + "refs": { + "Filter$Values": "This parameter is not currently supported.
" + } + }, + "IPRange": { + "base": "This data type is used as a response element in the DescribeDBSecurityGroups action.
", + "refs": { + "IPRangeList$member": null + } + }, + "IPRangeList": { + "base": null, + "refs": { + "DBSecurityGroup$IPRanges": "Contains a list of IPRange elements.
" + } + }, + "InstanceQuotaExceededFault": { + "base": "Request would result in user exceeding the allowed number of DB instances.
", + "refs": { + } + }, + "InsufficientDBInstanceCapacityFault": { + "base": "Specified DB instance class is not available in the specified Availability Zone.
", + "refs": { + } + }, + "Integer": { + "base": null, + "refs": { + "DBInstance$AllocatedStorage": "Specifies the allocated storage size specified in gigabytes.
", + "DBInstance$BackupRetentionPeriod": "Specifies the number of days for which automatic DB snapshots are retained.
", + "DBSnapshot$AllocatedStorage": "Specifies the allocated storage size in gigabytes (GB).
", + "DBSnapshot$Port": "Specifies the port that the database engine was listening on at the time of the snapshot.
", + "DBSnapshot$PercentProgress": "The percentage of the estimated data that has been transferred.
", + "DownloadDBLogFilePortionMessage$NumberOfLines": "The number of lines to download.
If the NumberOfLines parameter is specified, then the block of lines returned can be from the beginning or the end of the log file, depending on the value of the Marker parameter.
If neither Marker or NumberOfLines are specified, the entire log file is returned.
If NumberOfLines is specified and Marker is not specified, then the most recent lines from the end of the log file are returned.
If Marker is specified as \"0\", then the specified number of lines from the beginning of the log file are returned.
You can download the log file in blocks of lines by specifying the size of the block using the NumberOfLines parameter, and by specifying a value of \"0\" for the Marker parameter in your first request. Include the Marker value returned in the response as the Marker value for the next request, continuing until the AdditionalDataPending response element returns false.
Specifies the port that the database engine is listening on.
", + "ReservedDBInstance$Duration": "The duration of the reservation in seconds.
", + "ReservedDBInstance$DBInstanceCount": "The number of reserved DB instances.
", + "ReservedDBInstancesOffering$Duration": "The duration of the offering in seconds.
" + } + }, + "IntegerOptional": { + "base": null, + "refs": { + "CreateDBInstanceMessage$AllocatedStorage": "The amount of storage (in gigabytes) to be initially allocated for the database instance.
Type: Integer
MySQL
Constraints: Must be an integer from 5 to 3072.
PostgreSQL
Constraints: Must be an integer from 5 to 3072.
Oracle
Constraints: Must be an integer from 10 to 3072.
SQL Server
Constraints: Must be an integer from 200 to 1024 (Standard Edition and Enterprise Edition) or from 30 to 1024 (Express Edition and Web Edition)
", + "CreateDBInstanceMessage$BackupRetentionPeriod": "The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
Default: 1
Constraints:
The port number on which the database accepts connections.
MySQL
Default: 3306
Valid Values: 1150-65535
Type: Integer
PostgreSQL
Default: 5432
Valid Values: 1150-65535
Type: Integer
Oracle
Default: 1521
Valid Values: 1150-65535
SQL Server
Default: 1433
Valid Values: 1150-65535 except for 1434, 3389, 47001, 49152, and 49152 through 49156.
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
Constraints: To use PIOPS, this value must be an integer greater than 1000.
", + "CreateDBInstanceReadReplicaMessage$Port": "The port number that the DB instance uses for connections.
Default: Inherits from the source DB instance
Valid Values: 1150-65535
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
", + "DBInstance$Iops": "Specifies the Provisioned IOPS (I/O operations per second) value.
", + "DBSnapshot$Iops": "Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
", + "DescribeDBEngineVersionsMessage$MaxRecords": " The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
", + "DescribeDBInstancesMessage$MaxRecords": " The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
", + "DescribeDBLogFilesMessage$MaxRecords": "The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
", + "DescribeDBParameterGroupsMessage$MaxRecords": " The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
", + "DescribeDBParametersMessage$MaxRecords": " The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
", + "DescribeDBSecurityGroupsMessage$MaxRecords": " The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
", + "DescribeDBSnapshotsMessage$MaxRecords": " The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
", + "DescribeDBSubnetGroupsMessage$MaxRecords": " The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may 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 pagination token called a marker is included in the response so that the remaining results may be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
", + "DescribeEventSubscriptionsMessage$MaxRecords": " The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called 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 to retrieve events for.
Default: 60
", + "DescribeEventsMessage$MaxRecords": " The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
", + "DescribeOptionGroupOptionsMessage$MaxRecords": " The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
", + "DescribeOptionGroupsMessage$MaxRecords": " The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
", + "DescribeOrderableDBInstanceOptionsMessage$MaxRecords": " The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
", + "DescribeReservedDBInstancesMessage$MaxRecords": " The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
", + "DescribeReservedDBInstancesOfferingsMessage$MaxRecords": " The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
", + "ModifyDBInstanceMessage$AllocatedStorage": " The new storage capacity of the RDS instance. Changing this parameter does not result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.
MySQL
Default: Uses existing setting
Valid Values: 5-3072
Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
Type: Integer
PostgreSQL
Default: Uses existing setting
Valid Values: 5-3072
Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
Type: Integer
Oracle
Default: Uses existing setting
Valid Values: 10-3072
Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
SQL Server
Cannot be modified.
If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance will be available for use, but may experience performance degradation. While the migration takes place, nightly backups for the instance will be suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and creating a DB snapshot of the instance.
", + "ModifyDBInstanceMessage$BackupRetentionPeriod": "The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
Changing this parameter can result in an outage if you change from 0 to a non-zero value or from a non-zero value to 0. These changes are applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously applied as soon as possible.
Default: Uses existing setting
Constraints:
The new Provisioned IOPS (I/O operations per second) value for the RDS instance. Changing this parameter does not result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.
Default: Uses existing setting
Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value. If you are migrating from Provisioned IOPS to standard storage, set this value to 0.
SQL Server
Setting the IOPS value for the SQL Server database engine is not supported.
Type: Integer
If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance will be available for use, but may experience performance degradation. While the migration takes place, nightly backups for the instance will be suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and creating a DB snapshot of the instance.
", + "Option$Port": "If required, the port configured for this option to use.
", + "OptionConfiguration$Port": "The optional port for the option.
", + "OptionGroupOption$DefaultPort": "If the option requires a port, specifies the default port for the option.
", + "PendingModifiedValues$AllocatedStorage": " Contains the new AllocatedStorage size for the DB instance that will be applied or is in progress.
Specifies the pending port for the DB instance.
", + "PendingModifiedValues$BackupRetentionPeriod": "Specifies the pending number of days for which automated backups are retained.
", + "PendingModifiedValues$Iops": "Specifies the new Provisioned IOPS value for the DB instance that will be applied or is being applied.
", + "PromoteReadReplicaMessage$BackupRetentionPeriod": "The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
Default: 1
Constraints:
The number of instances to reserve.
Default: 1
The port number on which the database accepts connections.
Default: The same port as the original DB instance
Constraints: Value must be 1150-65535
Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. If this parameter is not specified, the IOPS value will be taken from the backup. If this parameter is set to 0, the new instance will be converted to a non-PIOPS instance, which will take additional time, though your DB instance will be available for connections before the conversion starts.
Constraints: Must be an integer greater than 1000.
SQL Server
Setting the IOPS value for the SQL Server database engine is not supported.
", + "RestoreDBInstanceToPointInTimeMessage$Port": "The port number on which the database accepts connections.
Constraints: Value must be 1150-65535
Default: The same port as the original DB instance.
", + "RestoreDBInstanceToPointInTimeMessage$Iops": "The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
Constraints: Must be an integer greater than 1000.
SQL Server
Setting the IOPS value for the SQL Server database engine is not supported.
" + } + }, + "InvalidDBInstanceStateFault": { + "base": "The specified DB instance is not in the available state.
", + "refs": { + } + }, + "InvalidDBParameterGroupStateFault": { + "base": "The DB parameter group cannot be deleted because it is in use.
", + "refs": { + } + }, + "InvalidDBSecurityGroupStateFault": { + "base": "The state of the DB security group does not allow deletion.
", + "refs": { + } + }, + "InvalidDBSnapshotStateFault": { + "base": "The state of the DB snapshot does not allow deletion.
", + "refs": { + } + }, + "InvalidDBSubnetGroupFault": { + "base": "Indicates the DBSubnetGroup does not belong to the same VPC as that of an existing cross region read replica of the same source instance.
", + "refs": { + } + }, + "InvalidDBSubnetGroupStateFault": { + "base": "The DB subnet group cannot be deleted because it is in use.
", + "refs": { + } + }, + "InvalidDBSubnetStateFault": { + "base": "The DB subnet is not in the available state.
", + "refs": { + } + }, + "InvalidEventSubscriptionStateFault": { + "base": "This error can occur if someone else is modifying a subscription. You should retry the action.
", + "refs": { + } + }, + "InvalidOptionGroupStateFault": { + "base": "The option group is not in the available state.
", + "refs": { + } + }, + "InvalidRestoreFault": { + "base": "Cannot restore from vpc backup to non-vpc DB instance.
", + "refs": { + } + }, + "InvalidSubnet": { + "base": "The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
", + "refs": { + } + }, + "InvalidVPCNetworkStateFault": { + "base": "DB subnet group does not cover all Availability Zones after it is created because users' change.
", + "refs": { + } + }, + "KeyList": { + "base": null, + "refs": { + "RemoveTagsFromResourceMessage$TagKeys": "The tag key (name) of the tag to be removed.
" + } + }, + "ListTagsForResourceMessage": { + "base": "", + "refs": { + } + }, + "Long": { + "base": null, + "refs": { + "DescribeDBLogFilesDetails$LastWritten": "A POSIX timestamp when the last log entry was written.
", + "DescribeDBLogFilesDetails$Size": "The size, in bytes, of the log file for the specified DB instance.
", + "DescribeDBLogFilesMessage$FileLastWritten": "Filters the available log files for files written since the specified date, in POSIX timestamp format.
", + "DescribeDBLogFilesMessage$FileSize": "Filters the available log files for files larger than the specified size.
" + } + }, + "ModifyDBInstanceMessage": { + "base": "", + "refs": { + } + }, + "ModifyDBInstanceResult": { + "base": null, + "refs": { + } + }, + "ModifyDBParameterGroupMessage": { + "base": "
", + "refs": { + } + }, + "ModifyDBSubnetGroupMessage": { + "base": "
", + "refs": { + } + }, + "ModifyDBSubnetGroupResult": { + "base": null, + "refs": { + } + }, + "ModifyEventSubscriptionMessage": { + "base": "", + "refs": { + } + }, + "ModifyEventSubscriptionResult": { + "base": null, + "refs": { + } + }, + "ModifyOptionGroupMessage": { + "base": "
", + "refs": { + } + }, + "ModifyOptionGroupResult": { + "base": null, + "refs": { + } + }, + "Option": { + "base": "
Option details.
", + "refs": { + "OptionsList$member": null + } + }, + "OptionConfiguration": { + "base": "A list of all available options
", + "refs": { + "OptionConfigurationList$member": null + } + }, + "OptionConfigurationList": { + "base": null, + "refs": { + "ModifyOptionGroupMessage$OptionsToInclude": "Options in this list are added to the option group or, if already present, the specified configuration is used to update the existing configuration.
" + } + }, + "OptionGroup": { + "base": "", + "refs": { + "CreateOptionGroupResult$OptionGroup": null, + "ModifyOptionGroupResult$OptionGroup": null, + "OptionGroupsList$member": null + } + }, + "OptionGroupAlreadyExistsFault": { + "base": "
The option group you are trying to create already exists.
", + "refs": { + } + }, + "OptionGroupMembership": { + "base": "Provides information on the option groups the DB instance is a member of.
", + "refs": { + "OptionGroupMembershipList$member": null + } + }, + "OptionGroupMembershipList": { + "base": null, + "refs": { + "DBInstance$OptionGroupMemberships": "Provides the list of option group memberships for this DB instance.
" + } + }, + "OptionGroupNotFoundFault": { + "base": "The specified option group could not be found.
", + "refs": { + } + }, + "OptionGroupOption": { + "base": "Available option.
", + "refs": { + "OptionGroupOptionsList$member": null + } + }, + "OptionGroupOptionSetting": { + "base": "option group option settings are used to display settings available for each option with their default values and other information. These values are used with the DescribeOptionGroupOptions action.
", + "refs": { + "OptionGroupOptionSettingsList$member": null + } + }, + "OptionGroupOptionSettingsList": { + "base": null, + "refs": { + "OptionGroupOption$OptionGroupOptionSettings": "Specifies the option settings that are available (and the default value) for each option in an option group.
" + } + }, + "OptionGroupOptionsList": { + "base": "List of available option group options.
", + "refs": { + "OptionGroupOptionsMessage$OptionGroupOptions": null + } + }, + "OptionGroupOptionsMessage": { + "base": "", + "refs": { + } + }, + "OptionGroupQuotaExceededFault": { + "base": "
The quota of 20 option groups was exceeded for this AWS account.
", + "refs": { + } + }, + "OptionGroups": { + "base": "List of option groups.
", + "refs": { + } + }, + "OptionGroupsList": { + "base": null, + "refs": { + "OptionGroups$OptionGroupsList": "List of option groups.
" + } + }, + "OptionNamesList": { + "base": null, + "refs": { + "ModifyOptionGroupMessage$OptionsToRemove": "Options in this list are removed from the option group.
" + } + }, + "OptionSetting": { + "base": "Option settings are the actual settings being applied or configured for that option. It is used when you modify an option group or describe option groups. For example, the NATIVE_NETWORK_ENCRYPTION option has a setting called SQLNET.ENCRYPTION_SERVER that can have several different values.
", + "refs": { + "OptionSettingConfigurationList$member": null, + "OptionSettingsList$member": null + } + }, + "OptionSettingConfigurationList": { + "base": null, + "refs": { + "Option$OptionSettings": "The option settings for this option.
" + } + }, + "OptionSettingsList": { + "base": null, + "refs": { + "OptionConfiguration$OptionSettings": "The option settings to include in an option group.
" + } + }, + "OptionsDependedOn": { + "base": null, + "refs": { + "OptionGroupOption$OptionsDependedOn": "List of all options that are prerequisites for this option.
" + } + }, + "OptionsList": { + "base": null, + "refs": { + "OptionGroup$Options": "Indicates what options are available in the option group.
" + } + }, + "OrderableDBInstanceOption": { + "base": "Contains a list of available options for a DB instance
This data type is used as a response element in the DescribeOrderableDBInstanceOptions action.
", + "refs": { + "OrderableDBInstanceOptionsList$member": null + } + }, + "OrderableDBInstanceOptionsList": { + "base": null, + "refs": { + "OrderableDBInstanceOptionsMessage$OrderableDBInstanceOptions": "An OrderableDBInstanceOption structure containing information about orderable options for the DB instance.
" + } + }, + "OrderableDBInstanceOptionsMessage": { + "base": "Contains the result of a successful invocation of the DescribeOrderableDBInstanceOptions action.
", + "refs": { + } + }, + "Parameter": { + "base": "This data type is used as a request parameter in the ModifyDBParameterGroup and ResetDBParameterGroup actions.
This data type is used as a response element in the DescribeEngineDefaultParameters and DescribeDBParameters actions.
", + "refs": { + "ParametersList$member": null + } + }, + "ParametersList": { + "base": null, + "refs": { + "DBParameterGroupDetails$Parameters": "A list of Parameter values.
", + "EngineDefaults$Parameters": "Contains a list of engine default parameters.
", + "ModifyDBParameterGroupMessage$Parameters": "An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters may be modified in a single request.
Valid Values (for the application method): immediate | pending-reboot
An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters may be modified in a single request.
MySQL
Valid Values (for Apply method): immediate | pending-reboot
You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when DB instance reboots.
Oracle
Valid Values (for Apply method): pending-reboot
This data type is used as a response element in the ModifyDBInstance action.
", + "refs": { + "DBInstance$PendingModifiedValues": "Specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
" + } + }, + "PointInTimeRestoreNotEnabledFault": { + "base": "SourceDBInstanceIdentifier refers to a DB instance with BackupRetentionPeriod equal to 0.
", + "refs": { + } + }, + "PromoteReadReplicaMessage": { + "base": "", + "refs": { + } + }, + "PromoteReadReplicaResult": { + "base": null, + "refs": { + } + }, + "ProvisionedIopsNotAvailableInAZFault": { + "base": "
Provisioned IOPS not available in the specified Availability Zone.
", + "refs": { + } + }, + "PurchaseReservedDBInstancesOfferingMessage": { + "base": "", + "refs": { + } + }, + "PurchaseReservedDBInstancesOfferingResult": { + "base": null, + "refs": { + } + }, + "ReadReplicaDBInstanceIdentifierList": { + "base": null, + "refs": { + "DBInstance$ReadReplicaDBInstanceIdentifiers": "
Contains one or more identifiers of the read replicas associated with this DB instance.
" + } + }, + "RebootDBInstanceMessage": { + "base": "", + "refs": { + } + }, + "RebootDBInstanceResult": { + "base": null, + "refs": { + } + }, + "RecurringCharge": { + "base": "
This data type is used as a response element in the DescribeReservedDBInstances and DescribeReservedDBInstancesOfferings actions.
", + "refs": { + "RecurringChargeList$member": null + } + }, + "RecurringChargeList": { + "base": null, + "refs": { + "ReservedDBInstance$RecurringCharges": "The recurring price charged to run this reserved DB instance.
", + "ReservedDBInstancesOffering$RecurringCharges": "The recurring price charged to run this reserved DB instance.
" + } + }, + "RemoveSourceIdentifierFromSubscriptionMessage": { + "base": "", + "refs": { + } + }, + "RemoveSourceIdentifierFromSubscriptionResult": { + "base": null, + "refs": { + } + }, + "RemoveTagsFromResourceMessage": { + "base": "", + "refs": { + } + }, + "ReservedDBInstance": { + "base": "This data type is used as a response element in the DescribeReservedDBInstances and PurchaseReservedDBInstancesOffering actions.
", + "refs": { + "PurchaseReservedDBInstancesOfferingResult$ReservedDBInstance": null, + "ReservedDBInstanceList$member": null + } + }, + "ReservedDBInstanceAlreadyExistsFault": { + "base": "User already has a reservation with the given identifier.
", + "refs": { + } + }, + "ReservedDBInstanceList": { + "base": null, + "refs": { + "ReservedDBInstanceMessage$ReservedDBInstances": "A list of reserved DB instances.
" + } + }, + "ReservedDBInstanceMessage": { + "base": "Contains the result of a successful invocation of the DescribeReservedDBInstances action.
", + "refs": { + } + }, + "ReservedDBInstanceNotFoundFault": { + "base": "The specified reserved DB Instance not found.
", + "refs": { + } + }, + "ReservedDBInstanceQuotaExceededFault": { + "base": "Request would exceed the user's DB Instance quota.
", + "refs": { + } + }, + "ReservedDBInstancesOffering": { + "base": "This data type is used as a response element in the DescribeReservedDBInstancesOfferings action.
", + "refs": { + "ReservedDBInstancesOfferingList$member": null + } + }, + "ReservedDBInstancesOfferingList": { + "base": null, + "refs": { + "ReservedDBInstancesOfferingMessage$ReservedDBInstancesOfferings": "A list of reserved DB instance offerings.
" + } + }, + "ReservedDBInstancesOfferingMessage": { + "base": "Contains the result of a successful invocation of the DescribeReservedDBInstancesOfferings action.
", + "refs": { + } + }, + "ReservedDBInstancesOfferingNotFoundFault": { + "base": "Specified offering does not exist.
", + "refs": { + } + }, + "ResetDBParameterGroupMessage": { + "base": "", + "refs": { + } + }, + "RestoreDBInstanceFromDBSnapshotMessage": { + "base": "
", + "refs": { + } + }, + "RestoreDBInstanceFromDBSnapshotResult": { + "base": null, + "refs": { + } + }, + "RestoreDBInstanceToPointInTimeMessage": { + "base": "
", + "refs": { + } + }, + "RestoreDBInstanceToPointInTimeResult": { + "base": null, + "refs": { + } + }, + "RevokeDBSecurityGroupIngressMessage": { + "base": "
", + "refs": { + } + }, + "RevokeDBSecurityGroupIngressResult": { + "base": null, + "refs": { + } + }, + "SNSInvalidTopicFault": { + "base": "
SNS has responded that there is a problem with the SND topic specified.
", + "refs": { + } + }, + "SNSNoAuthorizationFault": { + "base": "You do not have permission to publish to the SNS topic ARN.
", + "refs": { + } + }, + "SNSTopicArnNotFoundFault": { + "base": "The SNS topic ARN does not exist.
", + "refs": { + } + }, + "SnapshotQuotaExceededFault": { + "base": "Request would result in user exceeding the allowed number of DB snapshots.
", + "refs": { + } + }, + "SourceIdsList": { + "base": null, + "refs": { + "CreateEventSubscriptionMessage$SourceIds": "The list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens.
Constraints:
DBInstanceIdentifier must be supplied.DBSecurityGroupName must be supplied.DBParameterGroupName must be supplied.DBSnapshotIdentifier must be supplied.A list of source Ids for the RDS event notification subscription.
" + } + }, + "SourceNotFoundFault": { + "base": "The requested source could not be found.
", + "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 source type for this event.
" + } + }, + "StorageQuotaExceededFault": { + "base": "Request would result in user exceeding the allowed amount of storage available across all DB instances.
", + "refs": { + } + }, + "String": { + "base": null, + "refs": { + "AddSourceIdentifierToSubscriptionMessage$SubscriptionName": "The name of the RDS event notification subscription you want to add a source identifier to.
", + "AddSourceIdentifierToSubscriptionMessage$SourceIdentifier": "The identifier of the event source to be added. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens.
Constraints:
DBInstanceIdentifier must be supplied.DBSecurityGroupName must be supplied.DBParameterGroupName must be supplied.DBSnapshotIdentifier must be supplied.The Amazon RDS resource the tags will be added to. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).
", + "AuthorizeDBSecurityGroupIngressMessage$DBSecurityGroupName": "The name of the DB security group to add authorization to.
", + "AuthorizeDBSecurityGroupIngressMessage$CIDRIP": "The IP range to authorize.
", + "AuthorizeDBSecurityGroupIngressMessage$EC2SecurityGroupName": " Name of the EC2 security group to authorize. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
Id of the EC2 security group to authorize. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
AWS Account Number of the owner of the EC2 security group specified in the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
The name of the availability zone.
", + "CharacterSet$CharacterSetName": "The name of the character set.
", + "CharacterSet$CharacterSetDescription": "The description of the character set.
", + "CopyDBSnapshotMessage$SourceDBSnapshotIdentifier": "The identifier for the source DB snapshot.
Constraints:
Example: rds:mydb-2012-04-02-00-01
Example: arn:aws:rds:rr-regn-1:123456789012:snapshot:mysql-instance1-snapshot-20130805
The identifier for the copied snapshot.
Constraints:
Example: my-db-snapshot
The meaning of this parameter differs according to the database engine you use.
Type: String
MySQL
The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.
Constraints:
PostgreSQL
The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.
Constraints:
Oracle
The Oracle System ID (SID) of the created DB instance.
Default: ORCL
Constraints:
SQL Server
Not applicable. Must be null.
", + "CreateDBInstanceMessage$DBInstanceIdentifier": "The DB instance identifier. This parameter is stored as a lowercase string.
Constraints:
Example: mydbinstance
The compute and memory capacity of the DB instance.
Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge
The name of the database engine to be used for this instance.
Valid Values: MySQL | oracle-se1 | oracle-se | oracle-ee | sqlserver-ee | sqlserver-se | sqlserver-ex | sqlserver-web | postgres
The name of master user for the client DB instance.
MySQL
Constraints:
Type: String
Oracle
Constraints:
SQL Server
Constraints:
The password for the master database user. Can be any printable ASCII character except \"/\", \"\"\", or \"@\".
Type: String
MySQL
Constraints: Must contain from 8 to 41 characters.
Oracle
Constraints: Must contain from 8 to 30 characters.
SQL Server
Constraints: Must contain from 8 to 128 characters.
", + "CreateDBInstanceMessage$AvailabilityZone": "The EC2 Availability Zone that the database instance will be created in.
Default: A random, system-chosen Availability Zone in the endpoint's region.
Example: us-east-1d
Constraint: The AvailabilityZone parameter cannot be specified if the MultiAZ parameter is set to true. The specified Availability Zone must be in the same region as the current endpoint.
A DB subnet group to associate with this DB instance.
If there is no DB subnet group, then it is a non-VPC DB instance.
", + "CreateDBInstanceMessage$PreferredMaintenanceWindow": "The weekly time range (in UTC) during which system maintenance can occur.
Format: ddd:hh24:mi-ddd:hh24:mi
Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
", + "CreateDBInstanceMessage$DBParameterGroupName": "The name of the DB parameter group to associate with this DB instance. If this argument is omitted, the default DBParameterGroup for the specified engine will be used.
Constraints:
The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.
Default: A 30-minute window selected at random from an 8-hour block of time per region. See the Amazon RDS User Guide for the time blocks for each region from which the default backup windows are assigned.
Constraints: Must be in the format hh24:mi-hh24:mi. Times should be Universal Time Coordinated (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes.
The version number of the database engine to use.
MySQL
Example: 5.1.42
Type: String
PostgreSQL
Example: 9.3
Type: String
Oracle
Example: 11.2.0.2.v2
Type: String
SQL Server
Example: 10.50.2789.0.v1
License model information for this DB instance.
Valid values: license-included | bring-your-own-license | general-public-license
Indicates that the DB instance should be associated with the specified option group.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
", + "CreateDBInstanceMessage$CharacterSetName": "For supported engines, indicates that the DB instance should be associated with the specified CharacterSet.
", + "CreateDBInstanceReadReplicaMessage$DBInstanceIdentifier": "The DB instance identifier of the read replica. This is the unique key that identifies a DB instance. This parameter is stored as a lowercase string.
", + "CreateDBInstanceReadReplicaMessage$SourceDBInstanceIdentifier": "The identifier of the DB instance that will act as the source for the read replica. Each DB instance can have up to five read replicas.
Constraints:
The compute and memory capacity of the read replica.
Valid Values: db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge
Default: Inherits from the source DB instance.
", + "CreateDBInstanceReadReplicaMessage$AvailabilityZone": "The Amazon EC2 Availability Zone that the read replica will be created in.
Default: A random, system-chosen Availability Zone in the endpoint's region.
Example: us-east-1d
The option group the DB instance will be associated with. If omitted, the default option group for the engine specified will be used.
", + "CreateDBInstanceReadReplicaMessage$DBSubnetGroupName": "Specifies a DB subnet group for the DB instance. The new DB instance will be created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance is not created in a VPC.
Constraints:
The name of the DB parameter group.
Constraints:
The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family.
", + "CreateDBParameterGroupMessage$Description": "The description for the DB parameter group.
", + "CreateDBSecurityGroupMessage$DBSecurityGroupName": "The name for the DB security group. This value is stored as a lowercase string.
Constraints:
Example: mysecuritygroup
The description for the DB security group.
", + "CreateDBSnapshotMessage$DBSnapshotIdentifier": "The identifier for the DB snapshot.
Constraints:
Example: my-snapshot-id
The DB instance identifier. This is the unique key that identifies a DB instance.
Constraints:
The name for the DB subnet group. This value is stored as a lowercase string.
Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Must not be \"Default\".
Example: mySubnetgroup
The description for the DB subnet group.
", + "CreateEventSubscriptionMessage$SubscriptionName": "The name of the subscription.
Constraints: The name must be less than 255 characters.
", + "CreateEventSubscriptionMessage$SnsTopicArn": "The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.
", + "CreateEventSubscriptionMessage$SourceType": "The type of source that will be generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned.
Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot
", + "CreateOptionGroupMessage$OptionGroupName": "Specifies the name of the option group to be created.
Constraints:
Example: myoptiongroup
Specifies the name of the engine that this option group should be associated with.
", + "CreateOptionGroupMessage$MajorEngineVersion": "Specifies the major version of the engine that this option group should be associated with.
", + "CreateOptionGroupMessage$OptionGroupDescription": "The description of the option group.
", + "DBEngineVersion$Engine": "The name of the database engine.
", + "DBEngineVersion$EngineVersion": "The version number of the database engine.
", + "DBEngineVersion$DBParameterGroupFamily": "The name of the DB parameter group family for the database engine.
", + "DBEngineVersion$DBEngineDescription": "The description of the database engine.
", + "DBEngineVersion$DBEngineVersionDescription": "The description of the database engine version.
", + "DBEngineVersionMessage$Marker": " An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
Contains a user-supplied database identifier. This is the unique key that identifies a DB instance.
", + "DBInstance$DBInstanceClass": "Contains the name of the compute and memory capacity class of the DB instance.
", + "DBInstance$Engine": "Provides the name of the database engine to be used for this DB instance.
", + "DBInstance$DBInstanceStatus": "Specifies the current state of this database.
", + "DBInstance$MasterUsername": "Contains the master username for the DB instance.
", + "DBInstance$DBName": "The meaning of this parameter differs according to the database engine you use. For example, this value returns only MySQL information when returning values from CreateDBInstanceReadReplica since read replicas are only supported for MySQL.
MySQL
Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.
Type: String
Oracle
Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.
", + "DBInstance$PreferredBackupWindow": " Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
Specifies the name of the Availability Zone the DB instance is located in.
", + "DBInstance$PreferredMaintenanceWindow": "Specifies the weekly time range (in UTC) during which system maintenance can occur.
", + "DBInstance$EngineVersion": "Indicates the database engine version.
", + "DBInstance$ReadReplicaSourceDBInstanceIdentifier": "Contains the identifier of the source DB instance if this DB instance is a read replica.
", + "DBInstance$LicenseModel": "License model information for this DB instance.
", + "DBInstance$CharacterSetName": "If present, specifies the name of the character set that this instance is associated with.
", + "DBInstance$SecondaryAvailabilityZone": "If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
", + "DBInstanceMessage$Marker": " An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
This value is currently \"read replication.\"
", + "DBInstanceStatusInfo$Status": "Status of the DB instance. For a StatusType of read replica, the values can be replicating, error, stopped, or terminated.
", + "DBInstanceStatusInfo$Message": "Details of the error if there is an error for the instance. If the instance is not in an error state, this value is blank.
", + "DBParameterGroup$DBParameterGroupName": "Provides the name of the DB parameter group.
", + "DBParameterGroup$DBParameterGroupFamily": "Provides the name of the DB parameter group family that this DB parameter group is compatible with.
", + "DBParameterGroup$Description": "Provides the customer-specified description for this DB parameter group.
", + "DBParameterGroupDetails$Marker": " An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of the DB parameter group.
", + "DBParameterGroupStatus$DBParameterGroupName": "The name of the DP parameter group.
", + "DBParameterGroupStatus$ParameterApplyStatus": "The status of parameter updates.
", + "DBParameterGroupsMessage$Marker": " An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
Provides the AWS ID of the owner of a specific DB security group.
", + "DBSecurityGroup$DBSecurityGroupName": "Specifies the name of the DB security group.
", + "DBSecurityGroup$DBSecurityGroupDescription": "Provides the description of the DB security group.
", + "DBSecurityGroup$VpcId": "Provides the VpcId of the DB security group.
", + "DBSecurityGroupMembership$DBSecurityGroupName": "The name of the DB security group.
", + "DBSecurityGroupMembership$Status": "The status of the DB security group.
", + "DBSecurityGroupMessage$Marker": " An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
Specifies the identifier for the DB snapshot.
", + "DBSnapshot$DBInstanceIdentifier": "Specifies the DB instance identifier of the DB instance this DB snapshot was created from.
", + "DBSnapshot$Engine": "Specifies the name of the database engine.
", + "DBSnapshot$Status": "Specifies the status of this DB snapshot.
", + "DBSnapshot$AvailabilityZone": "Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
", + "DBSnapshot$VpcId": "Provides the Vpc Id associated with the DB snapshot.
", + "DBSnapshot$MasterUsername": "Provides the master username for the DB snapshot.
", + "DBSnapshot$EngineVersion": "Specifies the version of the database engine.
", + "DBSnapshot$LicenseModel": "License model information for the restored DB instance.
", + "DBSnapshot$SnapshotType": "Provides the type of the DB snapshot.
", + "DBSnapshot$OptionGroupName": "Provides the option group name for the DB snapshot.
", + "DBSnapshot$SourceRegion": "The region that the DB snapshot was created in or copied from.
", + "DBSnapshotMessage$Marker": " An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
Specifies the name of the DB subnet group.
", + "DBSubnetGroup$DBSubnetGroupDescription": "Provides the description of the DB subnet group.
", + "DBSubnetGroup$VpcId": "Provides the VpcId of the DB subnet group.
", + "DBSubnetGroup$SubnetGroupStatus": "Provides the status of the DB subnet group.
", + "DBSubnetGroupMessage$Marker": " An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The DB instance identifier for the DB instance to be deleted. This parameter isn't case sensitive.
Constraints:
The DBSnapshotIdentifier of the new DBSnapshot created when SkipFinalSnapshot is set to false.
Constraints:
The name of the DB parameter group.
Constraints:
The name of the DB security group to delete.
Constraints:
The DBSnapshot identifier.
Constraints: Must be the name of an existing DB snapshot in the available state.
The name of the database subnet group to delete.
Constraints:
The name of the RDS event notification subscription you want to delete.
", + "DeleteOptionGroupMessage$OptionGroupName": "The name of the option group to be deleted.
The database engine to return.
", + "DescribeDBEngineVersionsMessage$EngineVersion": "The database engine version to return.
Example: 5.1.49
The name of a specific DB parameter group family to return details for.
Constraints:
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The user-supplied instance identifier. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn't case sensitive.
Constraints:
An optional pagination token provided by a previous DescribeDBInstances request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
The name of the log file for the specified DB instance.
", + "DescribeDBLogFilesMessage$DBInstanceIdentifier": "The customer-assigned name of the DB instance that contains the log files you want to list.
Constraints:
Filters the available log files for log file names that contain the specified string.
", + "DescribeDBLogFilesMessage$Marker": "The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.
", + "DescribeDBLogFilesResponse$Marker": "A pagination token that can be used in a subsequent DescribeDBLogFiles request.
", + "DescribeDBParameterGroupsMessage$DBParameterGroupName": "The name of a specific DB parameter group to return details for.
Constraints:
An optional pagination token provided by a previous DescribeDBParameterGroups request. 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 DB parameter group to return details for.
Constraints:
The parameter types to return.
Default: All parameter types returned
Valid Values: user | system | engine-default
An optional pagination token provided by a previous DescribeDBParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of the DB security group to return details for.
", + "DescribeDBSecurityGroupsMessage$Marker": " An optional pagination token provided by a previous DescribeDBSecurityGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
A DB instance identifier to retrieve the list of DB snapshots for. Cannot be used in conjunction with DBSnapshotIdentifier. This parameter is not case sensitive.
Constraints:
A specific DB snapshot identifier to describe. Cannot be used in conjunction with DBInstanceIdentifier. This value is stored as a lowercase string.
Constraints:
SnapshotType parameter must also be specified.The type of snapshots that will be returned. Values can be \"automated\" or \"manual.\" If not specified, the returned results will include all snapshots types.
", + "DescribeDBSnapshotsMessage$Marker": " An optional pagination token provided by a previous DescribeDBSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of the DB subnet group to return details for.
", + "DescribeDBSubnetGroupsMessage$Marker": " An optional pagination token provided by a previous DescribeDBSubnetGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of the DB parameter group family.
", + "DescribeEngineDefaultParametersMessage$Marker": " An optional pagination token provided by a previous DescribeEngineDefaultParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The type of source that will be generating the events.
Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot
", + "DescribeEventSubscriptionsMessage$SubscriptionName": "The name of the RDS event notification subscription you want to describe.
", + "DescribeEventSubscriptionsMessage$Marker": " An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. 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 will be returned. If not specified, then all sources are included in the response.
Constraints:
DBInstance, then a DBInstanceIdentifier must be supplied.DBSecurityGroup, a DBSecurityGroupName must be supplied.DBParameterGroup, a DBParameterGroupName must be supplied.DBSnapshot, a DBSnapshotIdentifier must be supplied. An optional pagination token provided by a previous DescribeEvents request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
A required parameter. Options available for the given Engine name will be described.
", + "DescribeOptionGroupOptionsMessage$MajorEngineVersion": "If specified, filters the results to include only options for the specified major engine version.
", + "DescribeOptionGroupOptionsMessage$Marker": "An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of the option group to describe. Cannot be supplied together with EngineName or MajorEngineVersion.
", + "DescribeOptionGroupsMessage$Marker": " An optional pagination token provided by a previous DescribeOptionGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
Filters the list of option groups to only include groups associated with a specific database engine.
", + "DescribeOptionGroupsMessage$MajorEngineVersion": "Filters the list of option groups to only include groups associated with a specific database engine version. If specified, then EngineName must also be specified.
", + "DescribeOrderableDBInstanceOptionsMessage$Engine": "The name of the engine to retrieve DB instance options for.
", + "DescribeOrderableDBInstanceOptionsMessage$EngineVersion": "The engine version filter value. Specify this parameter to show only the available offerings matching the specified engine version.
", + "DescribeOrderableDBInstanceOptionsMessage$DBInstanceClass": "The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.
", + "DescribeOrderableDBInstanceOptionsMessage$LicenseModel": "The license model filter value. Specify this parameter to show only the available offerings matching the specified license model.
", + "DescribeOrderableDBInstanceOptionsMessage$Marker": " An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID.
", + "DescribeReservedDBInstancesMessage$ReservedDBInstancesOfferingId": "The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.
", + "DescribeReservedDBInstancesMessage$DBInstanceClass": "The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class.
", + "DescribeReservedDBInstancesMessage$Duration": "The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.
Valid Values: 1 | 3 | 31536000 | 94608000
The product description filter value. Specify this parameter to show only those reservations matching the specified product description.
", + "DescribeReservedDBInstancesMessage$OfferingType": "The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.
Valid Values: \"Light Utilization\" | \"Medium Utilization\" | \"Heavy Utilization\"
An optional pagination token provided by a previous request. 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. Specify this parameter to show only the available offering that matches the specified reservation identifier.
Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.
", + "DescribeReservedDBInstancesOfferingsMessage$Duration": "Duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.
Valid Values: 1 | 3 | 31536000 | 94608000
Product description filter value. Specify this parameter to show only the available offerings matching the specified product description.
", + "DescribeReservedDBInstancesOfferingsMessage$OfferingType": "The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.
Valid Values: \"Light Utilization\" | \"Medium Utilization\" | \"Heavy Utilization\"
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
Entries from the specified log file.
", + "DownloadDBLogFilePortionDetails$Marker": "A pagination token that can be used in a subsequent DownloadDBLogFilePortion request.
", + "DownloadDBLogFilePortionMessage$DBInstanceIdentifier": "The customer-assigned name of the DB instance that contains the log files you want to list.
Constraints:
The name of the log file to be downloaded.
", + "DownloadDBLogFilePortionMessage$Marker": "The pagination token provided in the previous request or \"0\". If the Marker parameter is specified the response includes only records beyond the marker until the end of the file or up to NumberOfLines.
", + "EC2SecurityGroup$Status": "Provides the status of the EC2 security group. Status can be \"authorizing\", \"authorized\", \"revoking\", and \"revoked\".
", + "EC2SecurityGroup$EC2SecurityGroupName": "Specifies the name of the EC2 security group.
", + "EC2SecurityGroup$EC2SecurityGroupId": "Specifies the id of the EC2 security group.
", + "EC2SecurityGroup$EC2SecurityGroupOwnerId": " Specifies the AWS ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field.
Specifies the DNS address of the DB instance.
", + "EngineDefaults$DBParameterGroupFamily": "Specifies the name of the DB parameter group family which the engine default parameters apply to.
", + "EngineDefaults$Marker": " An optional pagination token provided by a previous EngineDefaults request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
Provides the identifier for the source of the event.
", + "Event$Message": "Provides the text of this event.
", + "EventCategoriesList$member": null, + "EventCategoriesMap$SourceType": "The source type that the returned categories belong to
", + "EventSubscription$CustomerAwsId": "The AWS customer account associated with the RDS event notification subscription.
", + "EventSubscription$CustSubscriptionId": "The RDS event notification subscription Id.
", + "EventSubscription$SnsTopicArn": "The topic ARN of the RDS event notification subscription.
", + "EventSubscription$Status": "The status of the RDS event notification subscription.
Constraints:
Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist
The status \"no-permission\" indicates that RDS no longer has permission to post to the SNS topic. The status \"topic-not-exist\" indicates that the topic was deleted after the subscription was created.
", + "EventSubscription$SubscriptionCreationTime": "The time the RDS event notification subscription was created.
", + "EventSubscription$SourceType": "The source type for the RDS event notification subscription.
", + "EventSubscriptionsMessage$Marker": " An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
An optional pagination token provided by a previous Events request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
This parameter is not currently supported.
", + "FilterValueList$member": null, + "IPRange$Status": "Specifies the status of the IP range. Status can be \"authorizing\", \"authorized\", \"revoking\", and \"revoked\".
", + "IPRange$CIDRIP": "Specifies the IP range.
", + "KeyList$member": null, + "ListTagsForResourceMessage$ResourceName": "The Amazon RDS resource with tags to be listed. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).
", + "ModifyDBInstanceMessage$DBInstanceIdentifier": "The DB instance identifier. This value is stored as a lowercase string.
Constraints:
The new compute and memory capacity of the DB instance. To determine the instance classes that are available for a particular DB engine, use the DescribeOrderableDBInstanceOptions action.
Passing a value for this parameter causes an outage during the change and is applied during the next maintenance window, unless the ApplyImmediately parameter is specified as true for this request.
Default: Uses existing setting
Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge | db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge
The new password for the DB instance master user. Can be any printable ASCII character except \"/\", \"\"\", or \"@\".
Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.
Default: Uses existing setting
Constraints: Must be 8 to 41 alphanumeric characters (MySQL), 8 to 30 alphanumeric characters (Oracle), or 8 to 128 alphanumeric characters (SQL Server).
The name of the DB parameter group to apply to the DB instance. Changing this setting does not result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. The DB instance will NOT be rebooted automatically and the parameter changes will NOT be applied during the next maintenance window.
Default: Uses existing setting
Constraints: The DB parameter group must be in the same DB parameter group family as the DB instance.
", + "ModifyDBInstanceMessage$PreferredBackupWindow": " The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.
Constraints:
The weekly time range (in UTC) during which system maintenance can occur, which may result in an outage. Changing this parameter does not result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, then changing this parameter will cause a reboot of the DB instance. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied.
Default: Uses existing setting
Format: ddd:hh24:mi-ddd:hh24:mi
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Must be at least 30 minutes
", + "ModifyDBInstanceMessage$EngineVersion": " The version number of the database engine to upgrade to. Changing this parameter results in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.
For major version upgrades, if a non-default DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family.
Example: 5.1.42
Indicates that the DB instance should be associated with the specified option group. Changing this parameter does not result in an outage except in the following case and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
", + "ModifyDBInstanceMessage$NewDBInstanceIdentifier": " The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot will occur immediately if you set Apply Immediately to true, or will occur during the next maintenance window if Apply Immediately to false. This value is stored as a lowercase string.
Constraints:
The name of the DB parameter group.
Constraints:
The name for the DB subnet group. This value is stored as a lowercase string.
Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Must not be \"Default\".
Example: mySubnetgroup
The description for the DB subnet group.
", + "ModifyEventSubscriptionMessage$SubscriptionName": "The name of the RDS event notification subscription.
", + "ModifyEventSubscriptionMessage$SnsTopicArn": "The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.
", + "ModifyEventSubscriptionMessage$SourceType": "The type of source that will be generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned.
Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot
", + "ModifyOptionGroupMessage$OptionGroupName": "The name of the option group to be modified.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
", + "Option$OptionName": "The name of the option.
", + "Option$OptionDescription": "The description of the option.
", + "OptionConfiguration$OptionName": "The configuration of options to include in a group.
", + "OptionGroup$OptionGroupName": "Specifies the name of the option group.
", + "OptionGroup$OptionGroupDescription": "Provides the description of the option group.
", + "OptionGroup$EngineName": "Engine name that this option group can be applied to.
", + "OptionGroup$MajorEngineVersion": "Indicates the major engine version associated with this option group.
", + "OptionGroup$VpcId": "If AllowsVpcAndNonVpcInstanceMemberships is 'false', this field is blank. If AllowsVpcAndNonVpcInstanceMemberships is 'true' and this field is blank, then this option group can be applied to both VPC and non-VPC instances. If this field contains a value, then this option group can only be applied to instances that are in the VPC indicated by this field.
", + "OptionGroupMembership$OptionGroupName": "The name of the option group that the instance belongs to.
", + "OptionGroupMembership$Status": "The status of the DB instance's option group membership (e.g. in-sync, pending, pending-maintenance, applying).
", + "OptionGroupOption$Name": "The name of the option.
", + "OptionGroupOption$Description": "The description of the option.
", + "OptionGroupOption$EngineName": "Engine name that this option can be applied to.
", + "OptionGroupOption$MajorEngineVersion": "Indicates the major engine version that the option is available for.
", + "OptionGroupOption$MinimumRequiredMinorEngineVersion": "The minimum required engine version for the option to be applied.
", + "OptionGroupOptionSetting$SettingName": "The name of the option group option.
", + "OptionGroupOptionSetting$SettingDescription": "The description of the option group option.
", + "OptionGroupOptionSetting$DefaultValue": "The default value for the option group option.
", + "OptionGroupOptionSetting$ApplyType": "The DB engine specific parameter type for the option group option.
", + "OptionGroupOptionSetting$AllowedValues": "Indicates the acceptable values for the option group option.
", + "OptionGroupOptionsMessage$Marker": "An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of the option that has settings that you can set.
", + "OptionSetting$Value": "The current value of the option setting.
", + "OptionSetting$DefaultValue": "The default value of the option setting.
", + "OptionSetting$Description": "The description of the option setting.
", + "OptionSetting$ApplyType": "The DB engine specific parameter type.
", + "OptionSetting$DataType": "The data type of the option setting.
", + "OptionSetting$AllowedValues": "The allowed values of the option setting.
", + "OptionsDependedOn$member": null, + "OrderableDBInstanceOption$Engine": "The engine type of the orderable DB instance.
", + "OrderableDBInstanceOption$EngineVersion": "The engine version of the orderable DB instance.
", + "OrderableDBInstanceOption$DBInstanceClass": "The DB instance Class for the orderable DB instance
", + "OrderableDBInstanceOption$LicenseModel": "The license model for the orderable DB instance.
", + "OrderableDBInstanceOptionsMessage$Marker": " An optional pagination token provided by a previous OrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
Specifies the name of the parameter.
", + "Parameter$ParameterValue": "Specifies the value of the parameter.
", + "Parameter$Description": "Provides a description of the parameter.
", + "Parameter$Source": "Indicates the source of the parameter value.
", + "Parameter$ApplyType": "Specifies the engine specific parameters type.
", + "Parameter$DataType": "Specifies the valid data type for the parameter.
", + "Parameter$AllowedValues": "Specifies the valid range of values for the parameter.
", + "Parameter$MinimumEngineVersion": "The earliest engine version to which the parameter can apply.
", + "PendingModifiedValues$DBInstanceClass": " Contains the new DBInstanceClass for the DB instance that will be applied or is in progress.
Contains the pending or in-progress change of the master credentials for the DB instance.
", + "PendingModifiedValues$EngineVersion": "Indicates the database engine version.
", + "PendingModifiedValues$DBInstanceIdentifier": " Contains the new DBInstanceIdentifier for the DB instance that will be applied or is in progress.
The DB instance identifier. This value is stored as a lowercase string.
Constraints:
Example:
The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.
Default: A 30-minute window selected at random from an 8-hour block of time per region. See the Amazon RDS User Guide for the time blocks for each region from which the default backup windows are assigned.
Constraints: Must be in the format hh24:mi-hh24:mi. Times should be Universal Time Coordinated (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes.
The ID of the Reserved DB instance offering to purchase.
Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
", + "PurchaseReservedDBInstancesOfferingMessage$ReservedDBInstanceId": "Customer-specified identifier to track this reservation.
Example: myreservationID
", + "ReadReplicaDBInstanceIdentifierList$member": null, + "RebootDBInstanceMessage$DBInstanceIdentifier": "The DB instance identifier. This parameter is stored as a lowercase string.
Constraints:
The frequency of the recurring charge.
", + "RemoveSourceIdentifierFromSubscriptionMessage$SubscriptionName": "The name of the RDS event notification subscription you want to remove a source identifier from.
", + "RemoveSourceIdentifierFromSubscriptionMessage$SourceIdentifier": "The source identifier to be removed from the subscription, such as the DB instance identifier for a DB instance or the name of a security group.
", + "RemoveTagsFromResourceMessage$ResourceName": "The Amazon RDS resource the tags will be removed from. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).
", + "ReservedDBInstance$ReservedDBInstanceId": "The unique identifier for the reservation.
", + "ReservedDBInstance$ReservedDBInstancesOfferingId": "The offering identifier.
", + "ReservedDBInstance$DBInstanceClass": "The DB instance class for the reserved DB instance.
", + "ReservedDBInstance$CurrencyCode": "The currency code for the reserved DB instance.
", + "ReservedDBInstance$ProductDescription": "The description of the reserved DB instance.
", + "ReservedDBInstance$OfferingType": "The offering type of this reserved DB instance.
", + "ReservedDBInstance$State": "The state of the reserved DB instance.
", + "ReservedDBInstanceMessage$Marker": " An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The offering identifier.
", + "ReservedDBInstancesOffering$DBInstanceClass": "The DB instance class for the reserved DB instance.
", + "ReservedDBInstancesOffering$CurrencyCode": "The currency code for the reserved DB instance offering.
", + "ReservedDBInstancesOffering$ProductDescription": "The database engine used by the offering.
", + "ReservedDBInstancesOffering$OfferingType": "The offering type.
", + "ReservedDBInstancesOfferingMessage$Marker": " An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of the DB parameter group.
Constraints:
Name of the DB instance to create from the DB snapshot. This parameter isn't case sensitive.
Constraints:
Example: my-snapshot-id
The identifier for the DB snapshot to restore from.
Constraints:
The compute and memory capacity of the Amazon RDS DB instance.
Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge
The EC2 Availability Zone that the database instance will be created in.
Default: A random, system-chosen Availability Zone.
Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.
Example: us-east-1a
The DB subnet group name to use for the new instance.
", + "RestoreDBInstanceFromDBSnapshotMessage$LicenseModel": "License model information for the restored DB instance.
Default: Same as source.
Valid values: license-included | bring-your-own-license | general-public-license
The database name for the restored DB instance.
This parameter doesn't apply to the MySQL engine.
The database engine to use for the new instance.
Default: The same as source
Constraint: Must be compatible with the engine of the source
Example: oracle-ee
The name of the option group to be used for the restored DB instance.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
", + "RestoreDBInstanceToPointInTimeMessage$SourceDBInstanceIdentifier": "The identifier of the source DB instance from which to restore.
Constraints:
The name of the new database instance to be created.
Constraints:
The compute and memory capacity of the Amazon RDS DB instance.
Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge
Default: The same DBInstanceClass as the original DB instance.
", + "RestoreDBInstanceToPointInTimeMessage$AvailabilityZone": "The EC2 Availability Zone that the database instance will be created in.
Default: A random, system-chosen Availability Zone.
Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.
Example: us-east-1a
The DB subnet group name to use for the new instance.
", + "RestoreDBInstanceToPointInTimeMessage$LicenseModel": "License model information for the restored DB instance.
Default: Same as source.
Valid values: license-included | bring-your-own-license | general-public-license
The database name for the restored DB instance.
This parameter is not used for the MySQL engine.
The database engine to use for the new instance.
Default: The same as source
Constraint: Must be compatible with the engine of the source
Example: oracle-ee
The name of the option group to be used for the restored DB instance.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
", + "RevokeDBSecurityGroupIngressMessage$DBSecurityGroupName": "The name of the DB security group to revoke ingress from.
", + "RevokeDBSecurityGroupIngressMessage$CIDRIP": " The IP range to revoke access from. Must be a valid CIDR range. If CIDRIP is specified, EC2SecurityGroupName, EC2SecurityGroupId and EC2SecurityGroupOwnerId cannot be provided.
The name of the EC2 security group to revoke access from. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
The id of the EC2 security group to revoke access from. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
The AWS Account Number of the owner of the EC2 security group specified in the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
Specifies the identifier of the subnet.
", + "Subnet$SubnetStatus": "Specifies the status of the subnet.
", + "SubnetIdentifierList$member": null, + "Tag$Key": "A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and cannot be prefixed with \"aws:\" or \"rds:\". The string may only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").
", + "Tag$Value": "A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and cannot be prefixed with \"aws:\" or \"rds:\". The string may only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").
", + "VpcSecurityGroupIdList$member": null, + "VpcSecurityGroupMembership$VpcSecurityGroupId": "The name of the VPC security group.
", + "VpcSecurityGroupMembership$Status": "The status of the VPC security group.
" + } + }, + "Subnet": { + "base": "This data type is used as a response element in the DescribeDBSubnetGroups action.
", + "refs": { + "SubnetList$member": null + } + }, + "SubnetAlreadyInUse": { + "base": "The DB subnet is already in use in the Availability Zone.
", + "refs": { + } + }, + "SubnetIdentifierList": { + "base": null, + "refs": { + "CreateDBSubnetGroupMessage$SubnetIds": "The EC2 Subnet IDs for the DB subnet group.
", + "ModifyDBSubnetGroupMessage$SubnetIds": "The EC2 subnet IDs for the DB subnet group.
" + } + }, + "SubnetList": { + "base": null, + "refs": { + "DBSubnetGroup$Subnets": "Contains a list of Subnet elements.
" + } + }, + "SubscriptionAlreadyExistFault": { + "base": "The supplied subscription name already exists.
", + "refs": { + } + }, + "SubscriptionCategoryNotFoundFault": { + "base": "The supplied category does not exist.
", + "refs": { + } + }, + "SubscriptionNotFoundFault": { + "base": "The subscription name does not exist.
", + "refs": { + } + }, + "SupportedCharacterSetsList": { + "base": null, + "refs": { + "DBEngineVersion$SupportedCharacterSets": " A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance API.
Provides the date and time the DB instance was created.
", + "DBInstance$LatestRestorableTime": "Specifies the latest time to which a database can be restored with point-in-time restore.
", + "DBSnapshot$SnapshotCreateTime": "Provides the time (UTC) when the snapshot was taken.
", + "DBSnapshot$InstanceCreateTime": "Specifies the time (UTC) when the snapshot was taken.
", + "DescribeEventsMessage$StartTime": "The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2009-07-08T18:00Z
", + "DescribeEventsMessage$EndTime": "The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2009-07-08T18:00Z
", + "Event$Date": "Specifies the date and time of the event.
", + "ReservedDBInstance$StartTime": "The time the reservation started.
", + "RestoreDBInstanceToPointInTimeMessage$RestoreTime": "The date and time to restore from.
Valid Values: Value must be a UTC time
Constraints:
Example: 2009-09-07T23:45:00Z
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
", + "refs": { + "TagList$member": null + } + }, + "TagList": { + "base": "A list of tags.
", + "refs": { + "AddTagsToResourceMessage$Tags": "The tags to be assigned to the Amazon RDS resource.
", + "CopyDBSnapshotMessage$Tags": null, + "CreateDBInstanceMessage$Tags": null, + "CreateDBInstanceReadReplicaMessage$Tags": null, + "CreateDBParameterGroupMessage$Tags": null, + "CreateDBSecurityGroupMessage$Tags": null, + "CreateDBSnapshotMessage$Tags": null, + "CreateDBSubnetGroupMessage$Tags": null, + "CreateEventSubscriptionMessage$Tags": null, + "CreateOptionGroupMessage$Tags": null, + "PurchaseReservedDBInstancesOfferingMessage$Tags": null, + "RestoreDBInstanceFromDBSnapshotMessage$Tags": null, + "RestoreDBInstanceToPointInTimeMessage$Tags": null, + "TagListMessage$TagList": "List of tags returned by the ListTagsForResource operation.
" + } + }, + "TagListMessage": { + "base": "", + "refs": { + } + }, + "VpcSecurityGroupIdList": { + "base": null, + "refs": { + "CreateDBInstanceMessage$VpcSecurityGroupIds": "A list of EC2 VPC security groups to associate with this DB instance.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
", + "ModifyDBInstanceMessage$VpcSecurityGroupIds": "A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible.
Constraints:
A list of VpcSecurityGroupMemebrship name strings used for this option.
" + } + }, + "VpcSecurityGroupMembership": { + "base": "This data type is used as a response element for queries on VPC security group membership.
", + "refs": { + "VpcSecurityGroupMembershipList$member": null + } + }, + "VpcSecurityGroupMembershipList": { + "base": null, + "refs": { + "DBInstance$VpcSecurityGroups": "Provides List of VPC security group elements that the DB instance belongs to.
", + "Option$VpcSecurityGroupMemberships": "If the option requires access to a port, then this VPC security group allows access to the port.
" + } + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/rds/2013-09-09/examples-1.json b/vendor/github.com/aws/aws-sdk-go/models/apis/rds/2013-09-09/examples-1.json new file mode 100644 index 000000000..0ea7e3b0b --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/rds/2013-09-09/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/rds/2013-09-09/paginators-1.json b/vendor/github.com/aws/aws-sdk-go/models/apis/rds/2013-09-09/paginators-1.json new file mode 100644 index 000000000..662845c12 --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/rds/2013-09-09/paginators-1.json @@ -0,0 +1,110 @@ +{ + "pagination": { + "DescribeDBEngineVersions": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "DBEngineVersions" + }, + "DescribeDBInstances": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "DBInstances" + }, + "DescribeDBLogFiles": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "DescribeDBLogFiles" + }, + "DescribeDBParameterGroups": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "DBParameterGroups" + }, + "DescribeDBParameters": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "Parameters" + }, + "DescribeDBSecurityGroups": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "DBSecurityGroups" + }, + "DescribeDBSnapshots": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "DBSnapshots" + }, + "DescribeDBSubnetGroups": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "DBSubnetGroups" + }, + "DescribeEngineDefaultParameters": { + "input_token": "Marker", + "output_token": "EngineDefaults.Marker", + "limit_key": "MaxRecords", + "result_key": "EngineDefaults.Parameters" + }, + "DescribeEventSubscriptions": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "EventSubscriptionsList" + }, + "DescribeEvents": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "Events" + }, + "DescribeOptionGroupOptions": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "OptionGroupOptions" + }, + "DescribeOptionGroups": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "OptionGroupsList" + }, + "DescribeOrderableDBInstanceOptions": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "OrderableDBInstanceOptions" + }, + "DescribeReservedDBInstances": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "ReservedDBInstances" + }, + "DescribeReservedDBInstancesOfferings": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "ReservedDBInstancesOfferings" + }, + "DownloadDBLogFilePortion": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "NumberOfLines", + "more_results": "AdditionalDataPending", + "result_key": "LogFileData" + }, + "ListTagsForResource": { + "result_key": "TagList" + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/rds/2013-09-09/waiters-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/rds/2013-09-09/waiters-2.json new file mode 100644 index 000000000..b01500797 --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/rds/2013-09-09/waiters-2.json @@ -0,0 +1,97 @@ +{ + "version": 2, + "waiters": { + "DBInstanceAvailable": { + "delay": 30, + "operation": "DescribeDBInstances", + "maxAttempts": 60, + "acceptors": [ + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "deleted", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "deleting", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "failed", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "incompatible-restore", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "incompatible-parameters", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "incompatible-parameters", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "incompatible-restore", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + } + ] + }, + "DBInstanceDeleted": { + "delay": 30, + "operation": "DescribeDBInstances", + "maxAttempts": 60, + "acceptors": [ + { + "expected": "deleted", + "matcher": "pathAll", + "state": "success", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "creating", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "modifying", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "rebooting", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "resetting-master-credentials", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + } + ] + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/rds/2014-09-01/api-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/rds/2014-09-01/api-2.json new file mode 100644 index 000000000..45271a77a --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/rds/2014-09-01/api-2.json @@ -0,0 +1,3271 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2014-09-01", + "endpointPrefix":"rds", + "protocol":"query", + "serviceAbbreviation":"Amazon RDS", + "serviceFullName":"Amazon Relational Database Service", + "signatureVersion":"v4", + "xmlNamespace":"http://rds.amazonaws.com/doc/2014-09-01/" + }, + "operations":{ + "AddSourceIdentifierToSubscription":{ + "name":"AddSourceIdentifierToSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddSourceIdentifierToSubscriptionMessage"}, + "output":{ + "shape":"AddSourceIdentifierToSubscriptionResult", + "resultWrapper":"AddSourceIdentifierToSubscriptionResult" + }, + "errors":[ + {"shape":"SubscriptionNotFoundFault"}, + {"shape":"SourceNotFoundFault"} + ] + }, + "AddTagsToResource":{ + "name":"AddTagsToResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddTagsToResourceMessage"}, + "errors":[ + {"shape":"DBInstanceNotFoundFault"}, + {"shape":"DBSnapshotNotFoundFault"} + ] + }, + "AuthorizeDBSecurityGroupIngress":{ + "name":"AuthorizeDBSecurityGroupIngress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AuthorizeDBSecurityGroupIngressMessage"}, + "output":{ + "shape":"AuthorizeDBSecurityGroupIngressResult", + "resultWrapper":"AuthorizeDBSecurityGroupIngressResult" + }, + "errors":[ + {"shape":"DBSecurityGroupNotFoundFault"}, + {"shape":"InvalidDBSecurityGroupStateFault"}, + {"shape":"AuthorizationAlreadyExistsFault"}, + {"shape":"AuthorizationQuotaExceededFault"} + ] + }, + "CopyDBParameterGroup":{ + "name":"CopyDBParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CopyDBParameterGroupMessage"}, + "output":{ + "shape":"CopyDBParameterGroupResult", + "resultWrapper":"CopyDBParameterGroupResult" + }, + "errors":[ + {"shape":"DBParameterGroupNotFoundFault"}, + {"shape":"DBParameterGroupAlreadyExistsFault"}, + {"shape":"DBParameterGroupQuotaExceededFault"} + ] + }, + "CopyDBSnapshot":{ + "name":"CopyDBSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CopyDBSnapshotMessage"}, + "output":{ + "shape":"CopyDBSnapshotResult", + "resultWrapper":"CopyDBSnapshotResult" + }, + "errors":[ + {"shape":"DBSnapshotAlreadyExistsFault"}, + {"shape":"DBSnapshotNotFoundFault"}, + {"shape":"InvalidDBSnapshotStateFault"}, + {"shape":"SnapshotQuotaExceededFault"} + ] + }, + "CopyOptionGroup":{ + "name":"CopyOptionGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CopyOptionGroupMessage"}, + "output":{ + "shape":"CopyOptionGroupResult", + "resultWrapper":"CopyOptionGroupResult" + }, + "errors":[ + {"shape":"OptionGroupAlreadyExistsFault"}, + {"shape":"OptionGroupNotFoundFault"}, + {"shape":"OptionGroupQuotaExceededFault"} + ] + }, + "CreateDBInstance":{ + "name":"CreateDBInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDBInstanceMessage"}, + "output":{ + "shape":"CreateDBInstanceResult", + "resultWrapper":"CreateDBInstanceResult" + }, + "errors":[ + {"shape":"DBInstanceAlreadyExistsFault"}, + {"shape":"InsufficientDBInstanceCapacityFault"}, + {"shape":"DBParameterGroupNotFoundFault"}, + {"shape":"DBSecurityGroupNotFoundFault"}, + {"shape":"InstanceQuotaExceededFault"}, + {"shape":"StorageQuotaExceededFault"}, + {"shape":"DBSubnetGroupNotFoundFault"}, + {"shape":"DBSubnetGroupDoesNotCoverEnoughAZs"}, + {"shape":"InvalidSubnet"}, + {"shape":"InvalidVPCNetworkStateFault"}, + {"shape":"ProvisionedIopsNotAvailableInAZFault"}, + {"shape":"OptionGroupNotFoundFault"}, + {"shape":"StorageTypeNotSupportedFault"}, + {"shape":"AuthorizationNotFoundFault"} + ] + }, + "CreateDBInstanceReadReplica":{ + "name":"CreateDBInstanceReadReplica", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDBInstanceReadReplicaMessage"}, + "output":{ + "shape":"CreateDBInstanceReadReplicaResult", + "resultWrapper":"CreateDBInstanceReadReplicaResult" + }, + "errors":[ + {"shape":"DBInstanceAlreadyExistsFault"}, + {"shape":"InsufficientDBInstanceCapacityFault"}, + {"shape":"DBParameterGroupNotFoundFault"}, + {"shape":"DBSecurityGroupNotFoundFault"}, + {"shape":"InstanceQuotaExceededFault"}, + {"shape":"StorageQuotaExceededFault"}, + {"shape":"DBInstanceNotFoundFault"}, + {"shape":"InvalidDBInstanceStateFault"}, + {"shape":"DBSubnetGroupNotFoundFault"}, + {"shape":"DBSubnetGroupDoesNotCoverEnoughAZs"}, + {"shape":"InvalidSubnet"}, + {"shape":"InvalidVPCNetworkStateFault"}, + {"shape":"ProvisionedIopsNotAvailableInAZFault"}, + {"shape":"OptionGroupNotFoundFault"}, + {"shape":"DBSubnetGroupNotAllowedFault"}, + {"shape":"InvalidDBSubnetGroupFault"}, + {"shape":"StorageTypeNotSupportedFault"} + ] + }, + "CreateDBParameterGroup":{ + "name":"CreateDBParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDBParameterGroupMessage"}, + "output":{ + "shape":"CreateDBParameterGroupResult", + "resultWrapper":"CreateDBParameterGroupResult" + }, + "errors":[ + {"shape":"DBParameterGroupQuotaExceededFault"}, + {"shape":"DBParameterGroupAlreadyExistsFault"} + ] + }, + "CreateDBSecurityGroup":{ + "name":"CreateDBSecurityGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDBSecurityGroupMessage"}, + "output":{ + "shape":"CreateDBSecurityGroupResult", + "resultWrapper":"CreateDBSecurityGroupResult" + }, + "errors":[ + {"shape":"DBSecurityGroupAlreadyExistsFault"}, + {"shape":"DBSecurityGroupQuotaExceededFault"}, + {"shape":"DBSecurityGroupNotSupportedFault"} + ] + }, + "CreateDBSnapshot":{ + "name":"CreateDBSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDBSnapshotMessage"}, + "output":{ + "shape":"CreateDBSnapshotResult", + "resultWrapper":"CreateDBSnapshotResult" + }, + "errors":[ + {"shape":"DBSnapshotAlreadyExistsFault"}, + {"shape":"InvalidDBInstanceStateFault"}, + {"shape":"DBInstanceNotFoundFault"}, + {"shape":"SnapshotQuotaExceededFault"} + ] + }, + "CreateDBSubnetGroup":{ + "name":"CreateDBSubnetGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDBSubnetGroupMessage"}, + "output":{ + "shape":"CreateDBSubnetGroupResult", + "resultWrapper":"CreateDBSubnetGroupResult" + }, + "errors":[ + {"shape":"DBSubnetGroupAlreadyExistsFault"}, + {"shape":"DBSubnetGroupQuotaExceededFault"}, + {"shape":"DBSubnetQuotaExceededFault"}, + {"shape":"DBSubnetGroupDoesNotCoverEnoughAZs"}, + {"shape":"InvalidSubnet"} + ] + }, + "CreateEventSubscription":{ + "name":"CreateEventSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateEventSubscriptionMessage"}, + "output":{ + "shape":"CreateEventSubscriptionResult", + "resultWrapper":"CreateEventSubscriptionResult" + }, + "errors":[ + {"shape":"EventSubscriptionQuotaExceededFault"}, + {"shape":"SubscriptionAlreadyExistFault"}, + {"shape":"SNSInvalidTopicFault"}, + {"shape":"SNSNoAuthorizationFault"}, + {"shape":"SNSTopicArnNotFoundFault"}, + {"shape":"SubscriptionCategoryNotFoundFault"}, + {"shape":"SourceNotFoundFault"} + ] + }, + "CreateOptionGroup":{ + "name":"CreateOptionGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateOptionGroupMessage"}, + "output":{ + "shape":"CreateOptionGroupResult", + "resultWrapper":"CreateOptionGroupResult" + }, + "errors":[ + {"shape":"OptionGroupAlreadyExistsFault"}, + {"shape":"OptionGroupQuotaExceededFault"} + ] + }, + "DeleteDBInstance":{ + "name":"DeleteDBInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDBInstanceMessage"}, + "output":{ + "shape":"DeleteDBInstanceResult", + "resultWrapper":"DeleteDBInstanceResult" + }, + "errors":[ + {"shape":"DBInstanceNotFoundFault"}, + {"shape":"InvalidDBInstanceStateFault"}, + {"shape":"DBSnapshotAlreadyExistsFault"}, + {"shape":"SnapshotQuotaExceededFault"} + ] + }, + "DeleteDBParameterGroup":{ + "name":"DeleteDBParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDBParameterGroupMessage"}, + "errors":[ + {"shape":"InvalidDBParameterGroupStateFault"}, + {"shape":"DBParameterGroupNotFoundFault"} + ] + }, + "DeleteDBSecurityGroup":{ + "name":"DeleteDBSecurityGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDBSecurityGroupMessage"}, + "errors":[ + {"shape":"InvalidDBSecurityGroupStateFault"}, + {"shape":"DBSecurityGroupNotFoundFault"} + ] + }, + "DeleteDBSnapshot":{ + "name":"DeleteDBSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDBSnapshotMessage"}, + "output":{ + "shape":"DeleteDBSnapshotResult", + "resultWrapper":"DeleteDBSnapshotResult" + }, + "errors":[ + {"shape":"InvalidDBSnapshotStateFault"}, + {"shape":"DBSnapshotNotFoundFault"} + ] + }, + "DeleteDBSubnetGroup":{ + "name":"DeleteDBSubnetGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDBSubnetGroupMessage"}, + "errors":[ + {"shape":"InvalidDBSubnetGroupStateFault"}, + {"shape":"InvalidDBSubnetStateFault"}, + {"shape":"DBSubnetGroupNotFoundFault"} + ] + }, + "DeleteEventSubscription":{ + "name":"DeleteEventSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteEventSubscriptionMessage"}, + "output":{ + "shape":"DeleteEventSubscriptionResult", + "resultWrapper":"DeleteEventSubscriptionResult" + }, + "errors":[ + {"shape":"SubscriptionNotFoundFault"}, + {"shape":"InvalidEventSubscriptionStateFault"} + ] + }, + "DeleteOptionGroup":{ + "name":"DeleteOptionGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteOptionGroupMessage"}, + "errors":[ + {"shape":"OptionGroupNotFoundFault"}, + {"shape":"InvalidOptionGroupStateFault"} + ] + }, + "DescribeDBEngineVersions":{ + "name":"DescribeDBEngineVersions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBEngineVersionsMessage"}, + "output":{ + "shape":"DBEngineVersionMessage", + "resultWrapper":"DescribeDBEngineVersionsResult" + } + }, + "DescribeDBInstances":{ + "name":"DescribeDBInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBInstancesMessage"}, + "output":{ + "shape":"DBInstanceMessage", + "resultWrapper":"DescribeDBInstancesResult" + }, + "errors":[ + {"shape":"DBInstanceNotFoundFault"} + ] + }, + "DescribeDBLogFiles":{ + "name":"DescribeDBLogFiles", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBLogFilesMessage"}, + "output":{ + "shape":"DescribeDBLogFilesResponse", + "resultWrapper":"DescribeDBLogFilesResult" + }, + "errors":[ + {"shape":"DBInstanceNotFoundFault"} + ] + }, + "DescribeDBParameterGroups":{ + "name":"DescribeDBParameterGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBParameterGroupsMessage"}, + "output":{ + "shape":"DBParameterGroupsMessage", + "resultWrapper":"DescribeDBParameterGroupsResult" + }, + "errors":[ + {"shape":"DBParameterGroupNotFoundFault"} + ] + }, + "DescribeDBParameters":{ + "name":"DescribeDBParameters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBParametersMessage"}, + "output":{ + "shape":"DBParameterGroupDetails", + "resultWrapper":"DescribeDBParametersResult" + }, + "errors":[ + {"shape":"DBParameterGroupNotFoundFault"} + ] + }, + "DescribeDBSecurityGroups":{ + "name":"DescribeDBSecurityGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBSecurityGroupsMessage"}, + "output":{ + "shape":"DBSecurityGroupMessage", + "resultWrapper":"DescribeDBSecurityGroupsResult" + }, + "errors":[ + {"shape":"DBSecurityGroupNotFoundFault"} + ] + }, + "DescribeDBSnapshots":{ + "name":"DescribeDBSnapshots", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBSnapshotsMessage"}, + "output":{ + "shape":"DBSnapshotMessage", + "resultWrapper":"DescribeDBSnapshotsResult" + }, + "errors":[ + {"shape":"DBSnapshotNotFoundFault"} + ] + }, + "DescribeDBSubnetGroups":{ + "name":"DescribeDBSubnetGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBSubnetGroupsMessage"}, + "output":{ + "shape":"DBSubnetGroupMessage", + "resultWrapper":"DescribeDBSubnetGroupsResult" + }, + "errors":[ + {"shape":"DBSubnetGroupNotFoundFault"} + ] + }, + "DescribeEngineDefaultParameters":{ + "name":"DescribeEngineDefaultParameters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEngineDefaultParametersMessage"}, + "output":{ + "shape":"DescribeEngineDefaultParametersResult", + "resultWrapper":"DescribeEngineDefaultParametersResult" + } + }, + "DescribeEventCategories":{ + "name":"DescribeEventCategories", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEventCategoriesMessage"}, + "output":{ + "shape":"EventCategoriesMessage", + "resultWrapper":"DescribeEventCategoriesResult" + } + }, + "DescribeEventSubscriptions":{ + "name":"DescribeEventSubscriptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEventSubscriptionsMessage"}, + "output":{ + "shape":"EventSubscriptionsMessage", + "resultWrapper":"DescribeEventSubscriptionsResult" + }, + "errors":[ + {"shape":"SubscriptionNotFoundFault"} + ] + }, + "DescribeEvents":{ + "name":"DescribeEvents", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEventsMessage"}, + "output":{ + "shape":"EventsMessage", + "resultWrapper":"DescribeEventsResult" + } + }, + "DescribeOptionGroupOptions":{ + "name":"DescribeOptionGroupOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeOptionGroupOptionsMessage"}, + "output":{ + "shape":"OptionGroupOptionsMessage", + "resultWrapper":"DescribeOptionGroupOptionsResult" + } + }, + "DescribeOptionGroups":{ + "name":"DescribeOptionGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeOptionGroupsMessage"}, + "output":{ + "shape":"OptionGroups", + "resultWrapper":"DescribeOptionGroupsResult" + }, + "errors":[ + {"shape":"OptionGroupNotFoundFault"} + ] + }, + "DescribeOrderableDBInstanceOptions":{ + "name":"DescribeOrderableDBInstanceOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeOrderableDBInstanceOptionsMessage"}, + "output":{ + "shape":"OrderableDBInstanceOptionsMessage", + "resultWrapper":"DescribeOrderableDBInstanceOptionsResult" + } + }, + "DescribeReservedDBInstances":{ + "name":"DescribeReservedDBInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeReservedDBInstancesMessage"}, + "output":{ + "shape":"ReservedDBInstanceMessage", + "resultWrapper":"DescribeReservedDBInstancesResult" + }, + "errors":[ + {"shape":"ReservedDBInstanceNotFoundFault"} + ] + }, + "DescribeReservedDBInstancesOfferings":{ + "name":"DescribeReservedDBInstancesOfferings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeReservedDBInstancesOfferingsMessage"}, + "output":{ + "shape":"ReservedDBInstancesOfferingMessage", + "resultWrapper":"DescribeReservedDBInstancesOfferingsResult" + }, + "errors":[ + {"shape":"ReservedDBInstancesOfferingNotFoundFault"} + ] + }, + "DownloadDBLogFilePortion":{ + "name":"DownloadDBLogFilePortion", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DownloadDBLogFilePortionMessage"}, + "output":{ + "shape":"DownloadDBLogFilePortionDetails", + "resultWrapper":"DownloadDBLogFilePortionResult" + }, + "errors":[ + {"shape":"DBInstanceNotFoundFault"}, + {"shape":"DBLogFileNotFoundFault"} + ] + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForResourceMessage"}, + "output":{ + "shape":"TagListMessage", + "resultWrapper":"ListTagsForResourceResult" + }, + "errors":[ + {"shape":"DBInstanceNotFoundFault"}, + {"shape":"DBSnapshotNotFoundFault"} + ] + }, + "ModifyDBInstance":{ + "name":"ModifyDBInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyDBInstanceMessage"}, + "output":{ + "shape":"ModifyDBInstanceResult", + "resultWrapper":"ModifyDBInstanceResult" + }, + "errors":[ + {"shape":"InvalidDBInstanceStateFault"}, + {"shape":"InvalidDBSecurityGroupStateFault"}, + {"shape":"DBInstanceAlreadyExistsFault"}, + {"shape":"DBInstanceNotFoundFault"}, + {"shape":"DBSecurityGroupNotFoundFault"}, + {"shape":"DBParameterGroupNotFoundFault"}, + {"shape":"InsufficientDBInstanceCapacityFault"}, + {"shape":"StorageQuotaExceededFault"}, + {"shape":"InvalidVPCNetworkStateFault"}, + {"shape":"ProvisionedIopsNotAvailableInAZFault"}, + {"shape":"OptionGroupNotFoundFault"}, + {"shape":"DBUpgradeDependencyFailureFault"}, + {"shape":"StorageTypeNotSupportedFault"}, + {"shape":"AuthorizationNotFoundFault"} + ] + }, + "ModifyDBParameterGroup":{ + "name":"ModifyDBParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyDBParameterGroupMessage"}, + "output":{ + "shape":"DBParameterGroupNameMessage", + "resultWrapper":"ModifyDBParameterGroupResult" + }, + "errors":[ + {"shape":"DBParameterGroupNotFoundFault"}, + {"shape":"InvalidDBParameterGroupStateFault"} + ] + }, + "ModifyDBSubnetGroup":{ + "name":"ModifyDBSubnetGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyDBSubnetGroupMessage"}, + "output":{ + "shape":"ModifyDBSubnetGroupResult", + "resultWrapper":"ModifyDBSubnetGroupResult" + }, + "errors":[ + {"shape":"DBSubnetGroupNotFoundFault"}, + {"shape":"DBSubnetQuotaExceededFault"}, + {"shape":"SubnetAlreadyInUse"}, + {"shape":"DBSubnetGroupDoesNotCoverEnoughAZs"}, + {"shape":"InvalidSubnet"} + ] + }, + "ModifyEventSubscription":{ + "name":"ModifyEventSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyEventSubscriptionMessage"}, + "output":{ + "shape":"ModifyEventSubscriptionResult", + "resultWrapper":"ModifyEventSubscriptionResult" + }, + "errors":[ + {"shape":"EventSubscriptionQuotaExceededFault"}, + {"shape":"SubscriptionNotFoundFault"}, + {"shape":"SNSInvalidTopicFault"}, + {"shape":"SNSNoAuthorizationFault"}, + {"shape":"SNSTopicArnNotFoundFault"}, + {"shape":"SubscriptionCategoryNotFoundFault"} + ] + }, + "ModifyOptionGroup":{ + "name":"ModifyOptionGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyOptionGroupMessage"}, + "output":{ + "shape":"ModifyOptionGroupResult", + "resultWrapper":"ModifyOptionGroupResult" + }, + "errors":[ + {"shape":"InvalidOptionGroupStateFault"}, + {"shape":"OptionGroupNotFoundFault"} + ] + }, + "PromoteReadReplica":{ + "name":"PromoteReadReplica", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PromoteReadReplicaMessage"}, + "output":{ + "shape":"PromoteReadReplicaResult", + "resultWrapper":"PromoteReadReplicaResult" + }, + "errors":[ + {"shape":"InvalidDBInstanceStateFault"}, + {"shape":"DBInstanceNotFoundFault"} + ] + }, + "PurchaseReservedDBInstancesOffering":{ + "name":"PurchaseReservedDBInstancesOffering", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PurchaseReservedDBInstancesOfferingMessage"}, + "output":{ + "shape":"PurchaseReservedDBInstancesOfferingResult", + "resultWrapper":"PurchaseReservedDBInstancesOfferingResult" + }, + "errors":[ + {"shape":"ReservedDBInstancesOfferingNotFoundFault"}, + {"shape":"ReservedDBInstanceAlreadyExistsFault"}, + {"shape":"ReservedDBInstanceQuotaExceededFault"} + ] + }, + "RebootDBInstance":{ + "name":"RebootDBInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RebootDBInstanceMessage"}, + "output":{ + "shape":"RebootDBInstanceResult", + "resultWrapper":"RebootDBInstanceResult" + }, + "errors":[ + {"shape":"InvalidDBInstanceStateFault"}, + {"shape":"DBInstanceNotFoundFault"} + ] + }, + "RemoveSourceIdentifierFromSubscription":{ + "name":"RemoveSourceIdentifierFromSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RemoveSourceIdentifierFromSubscriptionMessage"}, + "output":{ + "shape":"RemoveSourceIdentifierFromSubscriptionResult", + "resultWrapper":"RemoveSourceIdentifierFromSubscriptionResult" + }, + "errors":[ + {"shape":"SubscriptionNotFoundFault"}, + {"shape":"SourceNotFoundFault"} + ] + }, + "RemoveTagsFromResource":{ + "name":"RemoveTagsFromResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RemoveTagsFromResourceMessage"}, + "errors":[ + {"shape":"DBInstanceNotFoundFault"}, + {"shape":"DBSnapshotNotFoundFault"} + ] + }, + "ResetDBParameterGroup":{ + "name":"ResetDBParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResetDBParameterGroupMessage"}, + "output":{ + "shape":"DBParameterGroupNameMessage", + "resultWrapper":"ResetDBParameterGroupResult" + }, + "errors":[ + {"shape":"InvalidDBParameterGroupStateFault"}, + {"shape":"DBParameterGroupNotFoundFault"} + ] + }, + "RestoreDBInstanceFromDBSnapshot":{ + "name":"RestoreDBInstanceFromDBSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RestoreDBInstanceFromDBSnapshotMessage"}, + "output":{ + "shape":"RestoreDBInstanceFromDBSnapshotResult", + "resultWrapper":"RestoreDBInstanceFromDBSnapshotResult" + }, + "errors":[ + {"shape":"DBInstanceAlreadyExistsFault"}, + {"shape":"DBSnapshotNotFoundFault"}, + {"shape":"InstanceQuotaExceededFault"}, + {"shape":"InsufficientDBInstanceCapacityFault"}, + {"shape":"InvalidDBSnapshotStateFault"}, + {"shape":"StorageQuotaExceededFault"}, + {"shape":"InvalidVPCNetworkStateFault"}, + {"shape":"InvalidRestoreFault"}, + {"shape":"DBSubnetGroupNotFoundFault"}, + {"shape":"DBSubnetGroupDoesNotCoverEnoughAZs"}, + {"shape":"InvalidSubnet"}, + {"shape":"ProvisionedIopsNotAvailableInAZFault"}, + {"shape":"OptionGroupNotFoundFault"}, + {"shape":"StorageTypeNotSupportedFault"}, + {"shape":"AuthorizationNotFoundFault"} + ] + }, + "RestoreDBInstanceToPointInTime":{ + "name":"RestoreDBInstanceToPointInTime", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RestoreDBInstanceToPointInTimeMessage"}, + "output":{ + "shape":"RestoreDBInstanceToPointInTimeResult", + "resultWrapper":"RestoreDBInstanceToPointInTimeResult" + }, + "errors":[ + {"shape":"DBInstanceAlreadyExistsFault"}, + {"shape":"DBInstanceNotFoundFault"}, + {"shape":"InstanceQuotaExceededFault"}, + {"shape":"InsufficientDBInstanceCapacityFault"}, + {"shape":"InvalidDBInstanceStateFault"}, + {"shape":"PointInTimeRestoreNotEnabledFault"}, + {"shape":"StorageQuotaExceededFault"}, + {"shape":"InvalidVPCNetworkStateFault"}, + {"shape":"InvalidRestoreFault"}, + {"shape":"DBSubnetGroupNotFoundFault"}, + {"shape":"DBSubnetGroupDoesNotCoverEnoughAZs"}, + {"shape":"InvalidSubnet"}, + {"shape":"ProvisionedIopsNotAvailableInAZFault"}, + {"shape":"OptionGroupNotFoundFault"}, + {"shape":"StorageTypeNotSupportedFault"}, + {"shape":"AuthorizationNotFoundFault"} + ] + }, + "RevokeDBSecurityGroupIngress":{ + "name":"RevokeDBSecurityGroupIngress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RevokeDBSecurityGroupIngressMessage"}, + "output":{ + "shape":"RevokeDBSecurityGroupIngressResult", + "resultWrapper":"RevokeDBSecurityGroupIngressResult" + }, + "errors":[ + {"shape":"DBSecurityGroupNotFoundFault"}, + {"shape":"AuthorizationNotFoundFault"}, + {"shape":"InvalidDBSecurityGroupStateFault"} + ] + } + }, + "shapes":{ + "AddSourceIdentifierToSubscriptionMessage":{ + "type":"structure", + "required":[ + "SubscriptionName", + "SourceIdentifier" + ], + "members":{ + "SubscriptionName":{"shape":"String"}, + "SourceIdentifier":{"shape":"String"} + } + }, + "AddSourceIdentifierToSubscriptionResult":{ + "type":"structure", + "members":{ + "EventSubscription":{"shape":"EventSubscription"} + } + }, + "AddTagsToResourceMessage":{ + "type":"structure", + "required":[ + "ResourceName", + "Tags" + ], + "members":{ + "ResourceName":{"shape":"String"}, + "Tags":{"shape":"TagList"} + } + }, + "ApplyMethod":{ + "type":"string", + "enum":[ + "immediate", + "pending-reboot" + ] + }, + "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 + }, + "AuthorizationQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"AuthorizationQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "AuthorizeDBSecurityGroupIngressMessage":{ + "type":"structure", + "required":["DBSecurityGroupName"], + "members":{ + "DBSecurityGroupName":{"shape":"String"}, + "CIDRIP":{"shape":"String"}, + "EC2SecurityGroupName":{"shape":"String"}, + "EC2SecurityGroupId":{"shape":"String"}, + "EC2SecurityGroupOwnerId":{"shape":"String"} + } + }, + "AuthorizeDBSecurityGroupIngressResult":{ + "type":"structure", + "members":{ + "DBSecurityGroup":{"shape":"DBSecurityGroup"} + } + }, + "AvailabilityZone":{ + "type":"structure", + "members":{ + "Name":{"shape":"String"} + }, + "wrapper":true + }, + "AvailabilityZoneList":{ + "type":"list", + "member":{ + "shape":"AvailabilityZone", + "locationName":"AvailabilityZone" + } + }, + "Boolean":{"type":"boolean"}, + "BooleanOptional":{"type":"boolean"}, + "CharacterSet":{ + "type":"structure", + "members":{ + "CharacterSetName":{"shape":"String"}, + "CharacterSetDescription":{"shape":"String"} + } + }, + "CopyDBParameterGroupMessage":{ + "type":"structure", + "required":[ + "SourceDBParameterGroupIdentifier", + "TargetDBParameterGroupIdentifier", + "TargetDBParameterGroupDescription" + ], + "members":{ + "SourceDBParameterGroupIdentifier":{"shape":"String"}, + "TargetDBParameterGroupIdentifier":{"shape":"String"}, + "TargetDBParameterGroupDescription":{"shape":"String"}, + "Tags":{"shape":"TagList"} + } + }, + "CopyDBParameterGroupResult":{ + "type":"structure", + "members":{ + "DBParameterGroup":{"shape":"DBParameterGroup"} + } + }, + "CopyDBSnapshotMessage":{ + "type":"structure", + "required":[ + "SourceDBSnapshotIdentifier", + "TargetDBSnapshotIdentifier" + ], + "members":{ + "SourceDBSnapshotIdentifier":{"shape":"String"}, + "TargetDBSnapshotIdentifier":{"shape":"String"}, + "Tags":{"shape":"TagList"} + } + }, + "CopyDBSnapshotResult":{ + "type":"structure", + "members":{ + "DBSnapshot":{"shape":"DBSnapshot"} + } + }, + "CopyOptionGroupMessage":{ + "type":"structure", + "required":[ + "SourceOptionGroupIdentifier", + "TargetOptionGroupIdentifier", + "TargetOptionGroupDescription" + ], + "members":{ + "SourceOptionGroupIdentifier":{"shape":"String"}, + "TargetOptionGroupIdentifier":{"shape":"String"}, + "TargetOptionGroupDescription":{"shape":"String"}, + "Tags":{"shape":"TagList"} + } + }, + "CopyOptionGroupResult":{ + "type":"structure", + "members":{ + "OptionGroup":{"shape":"OptionGroup"} + } + }, + "CreateDBInstanceMessage":{ + "type":"structure", + "required":[ + "DBInstanceIdentifier", + "AllocatedStorage", + "DBInstanceClass", + "Engine", + "MasterUsername", + "MasterUserPassword" + ], + "members":{ + "DBName":{"shape":"String"}, + "DBInstanceIdentifier":{"shape":"String"}, + "AllocatedStorage":{"shape":"IntegerOptional"}, + "DBInstanceClass":{"shape":"String"}, + "Engine":{"shape":"String"}, + "MasterUsername":{"shape":"String"}, + "MasterUserPassword":{"shape":"String"}, + "DBSecurityGroups":{"shape":"DBSecurityGroupNameList"}, + "VpcSecurityGroupIds":{"shape":"VpcSecurityGroupIdList"}, + "AvailabilityZone":{"shape":"String"}, + "DBSubnetGroupName":{"shape":"String"}, + "PreferredMaintenanceWindow":{"shape":"String"}, + "DBParameterGroupName":{"shape":"String"}, + "BackupRetentionPeriod":{"shape":"IntegerOptional"}, + "PreferredBackupWindow":{"shape":"String"}, + "Port":{"shape":"IntegerOptional"}, + "MultiAZ":{"shape":"BooleanOptional"}, + "EngineVersion":{"shape":"String"}, + "AutoMinorVersionUpgrade":{"shape":"BooleanOptional"}, + "LicenseModel":{"shape":"String"}, + "Iops":{"shape":"IntegerOptional"}, + "OptionGroupName":{"shape":"String"}, + "CharacterSetName":{"shape":"String"}, + "PubliclyAccessible":{"shape":"BooleanOptional"}, + "Tags":{"shape":"TagList"}, + "StorageType":{"shape":"String"}, + "TdeCredentialArn":{"shape":"String"}, + "TdeCredentialPassword":{"shape":"String"} + } + }, + "CreateDBInstanceReadReplicaMessage":{ + "type":"structure", + "required":[ + "DBInstanceIdentifier", + "SourceDBInstanceIdentifier" + ], + "members":{ + "DBInstanceIdentifier":{"shape":"String"}, + "SourceDBInstanceIdentifier":{"shape":"String"}, + "DBInstanceClass":{"shape":"String"}, + "AvailabilityZone":{"shape":"String"}, + "Port":{"shape":"IntegerOptional"}, + "AutoMinorVersionUpgrade":{"shape":"BooleanOptional"}, + "Iops":{"shape":"IntegerOptional"}, + "OptionGroupName":{"shape":"String"}, + "PubliclyAccessible":{"shape":"BooleanOptional"}, + "Tags":{"shape":"TagList"}, + "DBSubnetGroupName":{"shape":"String"}, + "StorageType":{"shape":"String"} + } + }, + "CreateDBInstanceReadReplicaResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "CreateDBInstanceResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "CreateDBParameterGroupMessage":{ + "type":"structure", + "required":[ + "DBParameterGroupName", + "DBParameterGroupFamily", + "Description" + ], + "members":{ + "DBParameterGroupName":{"shape":"String"}, + "DBParameterGroupFamily":{"shape":"String"}, + "Description":{"shape":"String"}, + "Tags":{"shape":"TagList"} + } + }, + "CreateDBParameterGroupResult":{ + "type":"structure", + "members":{ + "DBParameterGroup":{"shape":"DBParameterGroup"} + } + }, + "CreateDBSecurityGroupMessage":{ + "type":"structure", + "required":[ + "DBSecurityGroupName", + "DBSecurityGroupDescription" + ], + "members":{ + "DBSecurityGroupName":{"shape":"String"}, + "DBSecurityGroupDescription":{"shape":"String"}, + "Tags":{"shape":"TagList"} + } + }, + "CreateDBSecurityGroupResult":{ + "type":"structure", + "members":{ + "DBSecurityGroup":{"shape":"DBSecurityGroup"} + } + }, + "CreateDBSnapshotMessage":{ + "type":"structure", + "required":[ + "DBSnapshotIdentifier", + "DBInstanceIdentifier" + ], + "members":{ + "DBSnapshotIdentifier":{"shape":"String"}, + "DBInstanceIdentifier":{"shape":"String"}, + "Tags":{"shape":"TagList"} + } + }, + "CreateDBSnapshotResult":{ + "type":"structure", + "members":{ + "DBSnapshot":{"shape":"DBSnapshot"} + } + }, + "CreateDBSubnetGroupMessage":{ + "type":"structure", + "required":[ + "DBSubnetGroupName", + "DBSubnetGroupDescription", + "SubnetIds" + ], + "members":{ + "DBSubnetGroupName":{"shape":"String"}, + "DBSubnetGroupDescription":{"shape":"String"}, + "SubnetIds":{"shape":"SubnetIdentifierList"}, + "Tags":{"shape":"TagList"} + } + }, + "CreateDBSubnetGroupResult":{ + "type":"structure", + "members":{ + "DBSubnetGroup":{"shape":"DBSubnetGroup"} + } + }, + "CreateEventSubscriptionMessage":{ + "type":"structure", + "required":[ + "SubscriptionName", + "SnsTopicArn" + ], + "members":{ + "SubscriptionName":{"shape":"String"}, + "SnsTopicArn":{"shape":"String"}, + "SourceType":{"shape":"String"}, + "EventCategories":{"shape":"EventCategoriesList"}, + "SourceIds":{"shape":"SourceIdsList"}, + "Enabled":{"shape":"BooleanOptional"}, + "Tags":{"shape":"TagList"} + } + }, + "CreateEventSubscriptionResult":{ + "type":"structure", + "members":{ + "EventSubscription":{"shape":"EventSubscription"} + } + }, + "CreateOptionGroupMessage":{ + "type":"structure", + "required":[ + "OptionGroupName", + "EngineName", + "MajorEngineVersion", + "OptionGroupDescription" + ], + "members":{ + "OptionGroupName":{"shape":"String"}, + "EngineName":{"shape":"String"}, + "MajorEngineVersion":{"shape":"String"}, + "OptionGroupDescription":{"shape":"String"}, + "Tags":{"shape":"TagList"} + } + }, + "CreateOptionGroupResult":{ + "type":"structure", + "members":{ + "OptionGroup":{"shape":"OptionGroup"} + } + }, + "DBEngineVersion":{ + "type":"structure", + "members":{ + "Engine":{"shape":"String"}, + "EngineVersion":{"shape":"String"}, + "DBParameterGroupFamily":{"shape":"String"}, + "DBEngineDescription":{"shape":"String"}, + "DBEngineVersionDescription":{"shape":"String"}, + "DefaultCharacterSet":{"shape":"CharacterSet"}, + "SupportedCharacterSets":{"shape":"SupportedCharacterSetsList"} + } + }, + "DBEngineVersionList":{ + "type":"list", + "member":{ + "shape":"DBEngineVersion", + "locationName":"DBEngineVersion" + } + }, + "DBEngineVersionMessage":{ + "type":"structure", + "members":{ + "Marker":{"shape":"String"}, + "DBEngineVersions":{"shape":"DBEngineVersionList"} + } + }, + "DBInstance":{ + "type":"structure", + "members":{ + "DBInstanceIdentifier":{"shape":"String"}, + "DBInstanceClass":{"shape":"String"}, + "Engine":{"shape":"String"}, + "DBInstanceStatus":{"shape":"String"}, + "MasterUsername":{"shape":"String"}, + "DBName":{"shape":"String"}, + "Endpoint":{"shape":"Endpoint"}, + "AllocatedStorage":{"shape":"Integer"}, + "InstanceCreateTime":{"shape":"TStamp"}, + "PreferredBackupWindow":{"shape":"String"}, + "BackupRetentionPeriod":{"shape":"Integer"}, + "DBSecurityGroups":{"shape":"DBSecurityGroupMembershipList"}, + "VpcSecurityGroups":{"shape":"VpcSecurityGroupMembershipList"}, + "DBParameterGroups":{"shape":"DBParameterGroupStatusList"}, + "AvailabilityZone":{"shape":"String"}, + "DBSubnetGroup":{"shape":"DBSubnetGroup"}, + "PreferredMaintenanceWindow":{"shape":"String"}, + "PendingModifiedValues":{"shape":"PendingModifiedValues"}, + "LatestRestorableTime":{"shape":"TStamp"}, + "MultiAZ":{"shape":"Boolean"}, + "EngineVersion":{"shape":"String"}, + "AutoMinorVersionUpgrade":{"shape":"Boolean"}, + "ReadReplicaSourceDBInstanceIdentifier":{"shape":"String"}, + "ReadReplicaDBInstanceIdentifiers":{"shape":"ReadReplicaDBInstanceIdentifierList"}, + "LicenseModel":{"shape":"String"}, + "Iops":{"shape":"IntegerOptional"}, + "OptionGroupMemberships":{"shape":"OptionGroupMembershipList"}, + "CharacterSetName":{"shape":"String"}, + "SecondaryAvailabilityZone":{"shape":"String"}, + "PubliclyAccessible":{"shape":"Boolean"}, + "StatusInfos":{"shape":"DBInstanceStatusInfoList"}, + "StorageType":{"shape":"String"}, + "TdeCredentialArn":{"shape":"String"} + }, + "wrapper":true + }, + "DBInstanceAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBInstanceAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBInstanceList":{ + "type":"list", + "member":{ + "shape":"DBInstance", + "locationName":"DBInstance" + } + }, + "DBInstanceMessage":{ + "type":"structure", + "members":{ + "Marker":{"shape":"String"}, + "DBInstances":{"shape":"DBInstanceList"} + } + }, + "DBInstanceNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "DBInstanceStatusInfo":{ + "type":"structure", + "members":{ + "StatusType":{"shape":"String"}, + "Normal":{"shape":"Boolean"}, + "Status":{"shape":"String"}, + "Message":{"shape":"String"} + } + }, + "DBInstanceStatusInfoList":{ + "type":"list", + "member":{ + "shape":"DBInstanceStatusInfo", + "locationName":"DBInstanceStatusInfo" + } + }, + "DBLogFileNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBLogFileNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "DBParameterGroup":{ + "type":"structure", + "members":{ + "DBParameterGroupName":{"shape":"String"}, + "DBParameterGroupFamily":{"shape":"String"}, + "Description":{"shape":"String"} + }, + "wrapper":true + }, + "DBParameterGroupAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBParameterGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBParameterGroupDetails":{ + "type":"structure", + "members":{ + "Parameters":{"shape":"ParametersList"}, + "Marker":{"shape":"String"} + } + }, + "DBParameterGroupList":{ + "type":"list", + "member":{ + "shape":"DBParameterGroup", + "locationName":"DBParameterGroup" + } + }, + "DBParameterGroupNameMessage":{ + "type":"structure", + "members":{ + "DBParameterGroupName":{"shape":"String"} + } + }, + "DBParameterGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "DBParameterGroupQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBParameterGroupQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBParameterGroupStatus":{ + "type":"structure", + "members":{ + "DBParameterGroupName":{"shape":"String"}, + "ParameterApplyStatus":{"shape":"String"} + } + }, + "DBParameterGroupStatusList":{ + "type":"list", + "member":{ + "shape":"DBParameterGroupStatus", + "locationName":"DBParameterGroup" + } + }, + "DBParameterGroupsMessage":{ + "type":"structure", + "members":{ + "Marker":{"shape":"String"}, + "DBParameterGroups":{"shape":"DBParameterGroupList"} + } + }, + "DBSecurityGroup":{ + "type":"structure", + "members":{ + "OwnerId":{"shape":"String"}, + "DBSecurityGroupName":{"shape":"String"}, + "DBSecurityGroupDescription":{"shape":"String"}, + "VpcId":{"shape":"String"}, + "EC2SecurityGroups":{"shape":"EC2SecurityGroupList"}, + "IPRanges":{"shape":"IPRangeList"} + }, + "wrapper":true + }, + "DBSecurityGroupAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSecurityGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBSecurityGroupMembership":{ + "type":"structure", + "members":{ + "DBSecurityGroupName":{"shape":"String"}, + "Status":{"shape":"String"} + } + }, + "DBSecurityGroupMembershipList":{ + "type":"list", + "member":{ + "shape":"DBSecurityGroupMembership", + "locationName":"DBSecurityGroup" + } + }, + "DBSecurityGroupMessage":{ + "type":"structure", + "members":{ + "Marker":{"shape":"String"}, + "DBSecurityGroups":{"shape":"DBSecurityGroups"} + } + }, + "DBSecurityGroupNameList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"DBSecurityGroupName" + } + }, + "DBSecurityGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSecurityGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "DBSecurityGroupNotSupportedFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSecurityGroupNotSupported", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBSecurityGroupQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"QuotaExceeded.DBSecurityGroup", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBSecurityGroups":{ + "type":"list", + "member":{ + "shape":"DBSecurityGroup", + "locationName":"DBSecurityGroup" + } + }, + "DBSnapshot":{ + "type":"structure", + "members":{ + "DBSnapshotIdentifier":{"shape":"String"}, + "DBInstanceIdentifier":{"shape":"String"}, + "SnapshotCreateTime":{"shape":"TStamp"}, + "Engine":{"shape":"String"}, + "AllocatedStorage":{"shape":"Integer"}, + "Status":{"shape":"String"}, + "Port":{"shape":"Integer"}, + "AvailabilityZone":{"shape":"String"}, + "VpcId":{"shape":"String"}, + "InstanceCreateTime":{"shape":"TStamp"}, + "MasterUsername":{"shape":"String"}, + "EngineVersion":{"shape":"String"}, + "LicenseModel":{"shape":"String"}, + "SnapshotType":{"shape":"String"}, + "Iops":{"shape":"IntegerOptional"}, + "OptionGroupName":{"shape":"String"}, + "PercentProgress":{"shape":"Integer"}, + "SourceRegion":{"shape":"String"}, + "StorageType":{"shape":"String"}, + "TdeCredentialArn":{"shape":"String"} + }, + "wrapper":true + }, + "DBSnapshotAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSnapshotAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBSnapshotList":{ + "type":"list", + "member":{ + "shape":"DBSnapshot", + "locationName":"DBSnapshot" + } + }, + "DBSnapshotMessage":{ + "type":"structure", + "members":{ + "Marker":{"shape":"String"}, + "DBSnapshots":{"shape":"DBSnapshotList"} + } + }, + "DBSnapshotNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSnapshotNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "DBSubnetGroup":{ + "type":"structure", + "members":{ + "DBSubnetGroupName":{"shape":"String"}, + "DBSubnetGroupDescription":{"shape":"String"}, + "VpcId":{"shape":"String"}, + "SubnetGroupStatus":{"shape":"String"}, + "Subnets":{"shape":"SubnetList"} + }, + "wrapper":true + }, + "DBSubnetGroupAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSubnetGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBSubnetGroupDoesNotCoverEnoughAZs":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSubnetGroupDoesNotCoverEnoughAZs", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBSubnetGroupMessage":{ + "type":"structure", + "members":{ + "Marker":{"shape":"String"}, + "DBSubnetGroups":{"shape":"DBSubnetGroups"} + } + }, + "DBSubnetGroupNotAllowedFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSubnetGroupNotAllowedFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBSubnetGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSubnetGroupNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "DBSubnetGroupQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSubnetGroupQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBSubnetGroups":{ + "type":"list", + "member":{ + "shape":"DBSubnetGroup", + "locationName":"DBSubnetGroup" + } + }, + "DBSubnetQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSubnetQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBUpgradeDependencyFailureFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBUpgradeDependencyFailure", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DeleteDBInstanceMessage":{ + "type":"structure", + "required":["DBInstanceIdentifier"], + "members":{ + "DBInstanceIdentifier":{"shape":"String"}, + "SkipFinalSnapshot":{"shape":"Boolean"}, + "FinalDBSnapshotIdentifier":{"shape":"String"} + } + }, + "DeleteDBInstanceResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "DeleteDBParameterGroupMessage":{ + "type":"structure", + "required":["DBParameterGroupName"], + "members":{ + "DBParameterGroupName":{"shape":"String"} + } + }, + "DeleteDBSecurityGroupMessage":{ + "type":"structure", + "required":["DBSecurityGroupName"], + "members":{ + "DBSecurityGroupName":{"shape":"String"} + } + }, + "DeleteDBSnapshotMessage":{ + "type":"structure", + "required":["DBSnapshotIdentifier"], + "members":{ + "DBSnapshotIdentifier":{"shape":"String"} + } + }, + "DeleteDBSnapshotResult":{ + "type":"structure", + "members":{ + "DBSnapshot":{"shape":"DBSnapshot"} + } + }, + "DeleteDBSubnetGroupMessage":{ + "type":"structure", + "required":["DBSubnetGroupName"], + "members":{ + "DBSubnetGroupName":{"shape":"String"} + } + }, + "DeleteEventSubscriptionMessage":{ + "type":"structure", + "required":["SubscriptionName"], + "members":{ + "SubscriptionName":{"shape":"String"} + } + }, + "DeleteEventSubscriptionResult":{ + "type":"structure", + "members":{ + "EventSubscription":{"shape":"EventSubscription"} + } + }, + "DeleteOptionGroupMessage":{ + "type":"structure", + "required":["OptionGroupName"], + "members":{ + "OptionGroupName":{"shape":"String"} + } + }, + "DescribeDBEngineVersionsMessage":{ + "type":"structure", + "members":{ + "Engine":{"shape":"String"}, + "EngineVersion":{"shape":"String"}, + "DBParameterGroupFamily":{"shape":"String"}, + "Filters":{"shape":"FilterList"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"}, + "DefaultOnly":{"shape":"Boolean"}, + "ListSupportedCharacterSets":{"shape":"BooleanOptional"} + } + }, + "DescribeDBInstancesMessage":{ + "type":"structure", + "members":{ + "DBInstanceIdentifier":{"shape":"String"}, + "Filters":{"shape":"FilterList"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "DescribeDBLogFilesDetails":{ + "type":"structure", + "members":{ + "LogFileName":{"shape":"String"}, + "LastWritten":{"shape":"Long"}, + "Size":{"shape":"Long"} + } + }, + "DescribeDBLogFilesList":{ + "type":"list", + "member":{ + "shape":"DescribeDBLogFilesDetails", + "locationName":"DescribeDBLogFilesDetails" + } + }, + "DescribeDBLogFilesMessage":{ + "type":"structure", + "required":["DBInstanceIdentifier"], + "members":{ + "DBInstanceIdentifier":{"shape":"String"}, + "FilenameContains":{"shape":"String"}, + "FileLastWritten":{"shape":"Long"}, + "FileSize":{"shape":"Long"}, + "Filters":{"shape":"FilterList"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "DescribeDBLogFilesResponse":{ + "type":"structure", + "members":{ + "DescribeDBLogFiles":{"shape":"DescribeDBLogFilesList"}, + "Marker":{"shape":"String"} + } + }, + "DescribeDBParameterGroupsMessage":{ + "type":"structure", + "members":{ + "DBParameterGroupName":{"shape":"String"}, + "Filters":{"shape":"FilterList"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "DescribeDBParametersMessage":{ + "type":"structure", + "required":["DBParameterGroupName"], + "members":{ + "DBParameterGroupName":{"shape":"String"}, + "Source":{"shape":"String"}, + "Filters":{"shape":"FilterList"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "DescribeDBSecurityGroupsMessage":{ + "type":"structure", + "members":{ + "DBSecurityGroupName":{"shape":"String"}, + "Filters":{"shape":"FilterList"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "DescribeDBSnapshotsMessage":{ + "type":"structure", + "members":{ + "DBInstanceIdentifier":{"shape":"String"}, + "DBSnapshotIdentifier":{"shape":"String"}, + "SnapshotType":{"shape":"String"}, + "Filters":{"shape":"FilterList"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "DescribeDBSubnetGroupsMessage":{ + "type":"structure", + "members":{ + "DBSubnetGroupName":{"shape":"String"}, + "Filters":{"shape":"FilterList"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "DescribeEngineDefaultParametersMessage":{ + "type":"structure", + "required":["DBParameterGroupFamily"], + "members":{ + "DBParameterGroupFamily":{"shape":"String"}, + "Filters":{"shape":"FilterList"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "DescribeEngineDefaultParametersResult":{ + "type":"structure", + "members":{ + "EngineDefaults":{"shape":"EngineDefaults"} + } + }, + "DescribeEventCategoriesMessage":{ + "type":"structure", + "members":{ + "SourceType":{"shape":"String"}, + "Filters":{"shape":"FilterList"} + } + }, + "DescribeEventSubscriptionsMessage":{ + "type":"structure", + "members":{ + "SubscriptionName":{"shape":"String"}, + "Filters":{"shape":"FilterList"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "DescribeEventsMessage":{ + "type":"structure", + "members":{ + "SourceIdentifier":{"shape":"String"}, + "SourceType":{"shape":"SourceType"}, + "StartTime":{"shape":"TStamp"}, + "EndTime":{"shape":"TStamp"}, + "Duration":{"shape":"IntegerOptional"}, + "EventCategories":{"shape":"EventCategoriesList"}, + "Filters":{"shape":"FilterList"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "DescribeOptionGroupOptionsMessage":{ + "type":"structure", + "required":["EngineName"], + "members":{ + "EngineName":{"shape":"String"}, + "MajorEngineVersion":{"shape":"String"}, + "Filters":{"shape":"FilterList"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "DescribeOptionGroupsMessage":{ + "type":"structure", + "members":{ + "OptionGroupName":{"shape":"String"}, + "Filters":{"shape":"FilterList"}, + "Marker":{"shape":"String"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "EngineName":{"shape":"String"}, + "MajorEngineVersion":{"shape":"String"} + } + }, + "DescribeOrderableDBInstanceOptionsMessage":{ + "type":"structure", + "required":["Engine"], + "members":{ + "Engine":{"shape":"String"}, + "EngineVersion":{"shape":"String"}, + "DBInstanceClass":{"shape":"String"}, + "LicenseModel":{"shape":"String"}, + "Vpc":{"shape":"BooleanOptional"}, + "Filters":{"shape":"FilterList"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "DescribeReservedDBInstancesMessage":{ + "type":"structure", + "members":{ + "ReservedDBInstanceId":{"shape":"String"}, + "ReservedDBInstancesOfferingId":{"shape":"String"}, + "DBInstanceClass":{"shape":"String"}, + "Duration":{"shape":"String"}, + "ProductDescription":{"shape":"String"}, + "OfferingType":{"shape":"String"}, + "MultiAZ":{"shape":"BooleanOptional"}, + "Filters":{"shape":"FilterList"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "DescribeReservedDBInstancesOfferingsMessage":{ + "type":"structure", + "members":{ + "ReservedDBInstancesOfferingId":{"shape":"String"}, + "DBInstanceClass":{"shape":"String"}, + "Duration":{"shape":"String"}, + "ProductDescription":{"shape":"String"}, + "OfferingType":{"shape":"String"}, + "MultiAZ":{"shape":"BooleanOptional"}, + "Filters":{"shape":"FilterList"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "Double":{"type":"double"}, + "DownloadDBLogFilePortionDetails":{ + "type":"structure", + "members":{ + "LogFileData":{"shape":"String"}, + "Marker":{"shape":"String"}, + "AdditionalDataPending":{"shape":"Boolean"} + } + }, + "DownloadDBLogFilePortionMessage":{ + "type":"structure", + "required":[ + "DBInstanceIdentifier", + "LogFileName" + ], + "members":{ + "DBInstanceIdentifier":{"shape":"String"}, + "LogFileName":{"shape":"String"}, + "Marker":{"shape":"String"}, + "NumberOfLines":{"shape":"Integer"} + } + }, + "EC2SecurityGroup":{ + "type":"structure", + "members":{ + "Status":{"shape":"String"}, + "EC2SecurityGroupName":{"shape":"String"}, + "EC2SecurityGroupId":{"shape":"String"}, + "EC2SecurityGroupOwnerId":{"shape":"String"} + } + }, + "EC2SecurityGroupList":{ + "type":"list", + "member":{ + "shape":"EC2SecurityGroup", + "locationName":"EC2SecurityGroup" + } + }, + "Endpoint":{ + "type":"structure", + "members":{ + "Address":{"shape":"String"}, + "Port":{"shape":"Integer"} + } + }, + "EngineDefaults":{ + "type":"structure", + "members":{ + "DBParameterGroupFamily":{"shape":"String"}, + "Marker":{"shape":"String"}, + "Parameters":{"shape":"ParametersList"} + }, + "wrapper":true + }, + "Event":{ + "type":"structure", + "members":{ + "SourceIdentifier":{"shape":"String"}, + "SourceType":{"shape":"SourceType"}, + "Message":{"shape":"String"}, + "EventCategories":{"shape":"EventCategoriesList"}, + "Date":{"shape":"TStamp"} + } + }, + "EventCategoriesList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"EventCategory" + } + }, + "EventCategoriesMap":{ + "type":"structure", + "members":{ + "SourceType":{"shape":"String"}, + "EventCategories":{"shape":"EventCategoriesList"} + }, + "wrapper":true + }, + "EventCategoriesMapList":{ + "type":"list", + "member":{ + "shape":"EventCategoriesMap", + "locationName":"EventCategoriesMap" + } + }, + "EventCategoriesMessage":{ + "type":"structure", + "members":{ + "EventCategoriesMapList":{"shape":"EventCategoriesMapList"} + } + }, + "EventList":{ + "type":"list", + "member":{ + "shape":"Event", + "locationName":"Event" + } + }, + "EventSubscription":{ + "type":"structure", + "members":{ + "CustomerAwsId":{"shape":"String"}, + "CustSubscriptionId":{"shape":"String"}, + "SnsTopicArn":{"shape":"String"}, + "Status":{"shape":"String"}, + "SubscriptionCreationTime":{"shape":"String"}, + "SourceType":{"shape":"String"}, + "SourceIdsList":{"shape":"SourceIdsList"}, + "EventCategoriesList":{"shape":"EventCategoriesList"}, + "Enabled":{"shape":"Boolean"} + }, + "wrapper":true + }, + "EventSubscriptionQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"EventSubscriptionQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "EventSubscriptionsList":{ + "type":"list", + "member":{ + "shape":"EventSubscription", + "locationName":"EventSubscription" + } + }, + "EventSubscriptionsMessage":{ + "type":"structure", + "members":{ + "Marker":{"shape":"String"}, + "EventSubscriptionsList":{"shape":"EventSubscriptionsList"} + } + }, + "EventsMessage":{ + "type":"structure", + "members":{ + "Marker":{"shape":"String"}, + "Events":{"shape":"EventList"} + } + }, + "Filter":{ + "type":"structure", + "required":[ + "Name", + "Values" + ], + "members":{ + "Name":{"shape":"String"}, + "Values":{"shape":"FilterValueList"} + } + }, + "FilterList":{ + "type":"list", + "member":{ + "shape":"Filter", + "locationName":"Filter" + } + }, + "FilterValueList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"Value" + } + }, + "IPRange":{ + "type":"structure", + "members":{ + "Status":{"shape":"String"}, + "CIDRIP":{"shape":"String"} + } + }, + "IPRangeList":{ + "type":"list", + "member":{ + "shape":"IPRange", + "locationName":"IPRange" + } + }, + "InstanceQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InstanceQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InsufficientDBInstanceCapacityFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InsufficientDBInstanceCapacity", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "Integer":{"type":"integer"}, + "IntegerOptional":{"type":"integer"}, + "InvalidDBInstanceStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidDBInstanceState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidDBParameterGroupStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidDBParameterGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidDBSecurityGroupStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidDBSecurityGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidDBSnapshotStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidDBSnapshotState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidDBSubnetGroupFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidDBSubnetGroupFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidDBSubnetGroupStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidDBSubnetGroupStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidDBSubnetStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidDBSubnetStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidEventSubscriptionStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidEventSubscriptionState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidOptionGroupStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidOptionGroupStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidRestoreFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidRestoreFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidSubnet":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidSubnet", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidVPCNetworkStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidVPCNetworkStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "KeyList":{ + "type":"list", + "member":{"shape":"String"} + }, + "ListTagsForResourceMessage":{ + "type":"structure", + "required":["ResourceName"], + "members":{ + "ResourceName":{"shape":"String"}, + "Filters":{"shape":"FilterList"} + } + }, + "Long":{"type":"long"}, + "ModifyDBInstanceMessage":{ + "type":"structure", + "required":["DBInstanceIdentifier"], + "members":{ + "DBInstanceIdentifier":{"shape":"String"}, + "AllocatedStorage":{"shape":"IntegerOptional"}, + "DBInstanceClass":{"shape":"String"}, + "DBSecurityGroups":{"shape":"DBSecurityGroupNameList"}, + "VpcSecurityGroupIds":{"shape":"VpcSecurityGroupIdList"}, + "ApplyImmediately":{"shape":"Boolean"}, + "MasterUserPassword":{"shape":"String"}, + "DBParameterGroupName":{"shape":"String"}, + "BackupRetentionPeriod":{"shape":"IntegerOptional"}, + "PreferredBackupWindow":{"shape":"String"}, + "PreferredMaintenanceWindow":{"shape":"String"}, + "MultiAZ":{"shape":"BooleanOptional"}, + "EngineVersion":{"shape":"String"}, + "AllowMajorVersionUpgrade":{"shape":"Boolean"}, + "AutoMinorVersionUpgrade":{"shape":"BooleanOptional"}, + "Iops":{"shape":"IntegerOptional"}, + "OptionGroupName":{"shape":"String"}, + "NewDBInstanceIdentifier":{"shape":"String"}, + "StorageType":{"shape":"String"}, + "TdeCredentialArn":{"shape":"String"}, + "TdeCredentialPassword":{"shape":"String"} + } + }, + "ModifyDBInstanceResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "ModifyDBParameterGroupMessage":{ + "type":"structure", + "required":[ + "DBParameterGroupName", + "Parameters" + ], + "members":{ + "DBParameterGroupName":{"shape":"String"}, + "Parameters":{"shape":"ParametersList"} + } + }, + "ModifyDBSubnetGroupMessage":{ + "type":"structure", + "required":[ + "DBSubnetGroupName", + "SubnetIds" + ], + "members":{ + "DBSubnetGroupName":{"shape":"String"}, + "DBSubnetGroupDescription":{"shape":"String"}, + "SubnetIds":{"shape":"SubnetIdentifierList"} + } + }, + "ModifyDBSubnetGroupResult":{ + "type":"structure", + "members":{ + "DBSubnetGroup":{"shape":"DBSubnetGroup"} + } + }, + "ModifyEventSubscriptionMessage":{ + "type":"structure", + "required":["SubscriptionName"], + "members":{ + "SubscriptionName":{"shape":"String"}, + "SnsTopicArn":{"shape":"String"}, + "SourceType":{"shape":"String"}, + "EventCategories":{"shape":"EventCategoriesList"}, + "Enabled":{"shape":"BooleanOptional"} + } + }, + "ModifyEventSubscriptionResult":{ + "type":"structure", + "members":{ + "EventSubscription":{"shape":"EventSubscription"} + } + }, + "ModifyOptionGroupMessage":{ + "type":"structure", + "required":["OptionGroupName"], + "members":{ + "OptionGroupName":{"shape":"String"}, + "OptionsToInclude":{"shape":"OptionConfigurationList"}, + "OptionsToRemove":{"shape":"OptionNamesList"}, + "ApplyImmediately":{"shape":"Boolean"} + } + }, + "ModifyOptionGroupResult":{ + "type":"structure", + "members":{ + "OptionGroup":{"shape":"OptionGroup"} + } + }, + "Option":{ + "type":"structure", + "members":{ + "OptionName":{"shape":"String"}, + "OptionDescription":{"shape":"String"}, + "Persistent":{"shape":"Boolean"}, + "Permanent":{"shape":"Boolean"}, + "Port":{"shape":"IntegerOptional"}, + "OptionSettings":{"shape":"OptionSettingConfigurationList"}, + "DBSecurityGroupMemberships":{"shape":"DBSecurityGroupMembershipList"}, + "VpcSecurityGroupMemberships":{"shape":"VpcSecurityGroupMembershipList"} + } + }, + "OptionConfiguration":{ + "type":"structure", + "required":["OptionName"], + "members":{ + "OptionName":{"shape":"String"}, + "Port":{"shape":"IntegerOptional"}, + "DBSecurityGroupMemberships":{"shape":"DBSecurityGroupNameList"}, + "VpcSecurityGroupMemberships":{"shape":"VpcSecurityGroupIdList"}, + "OptionSettings":{"shape":"OptionSettingsList"} + } + }, + "OptionConfigurationList":{ + "type":"list", + "member":{ + "shape":"OptionConfiguration", + "locationName":"OptionConfiguration" + } + }, + "OptionGroup":{ + "type":"structure", + "members":{ + "OptionGroupName":{"shape":"String"}, + "OptionGroupDescription":{"shape":"String"}, + "EngineName":{"shape":"String"}, + "MajorEngineVersion":{"shape":"String"}, + "Options":{"shape":"OptionsList"}, + "AllowsVpcAndNonVpcInstanceMemberships":{"shape":"Boolean"}, + "VpcId":{"shape":"String"} + }, + "wrapper":true + }, + "OptionGroupAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"OptionGroupAlreadyExistsFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "OptionGroupMembership":{ + "type":"structure", + "members":{ + "OptionGroupName":{"shape":"String"}, + "Status":{"shape":"String"} + } + }, + "OptionGroupMembershipList":{ + "type":"list", + "member":{ + "shape":"OptionGroupMembership", + "locationName":"OptionGroupMembership" + } + }, + "OptionGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"OptionGroupNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "OptionGroupOption":{ + "type":"structure", + "members":{ + "Name":{"shape":"String"}, + "Description":{"shape":"String"}, + "EngineName":{"shape":"String"}, + "MajorEngineVersion":{"shape":"String"}, + "MinimumRequiredMinorEngineVersion":{"shape":"String"}, + "PortRequired":{"shape":"Boolean"}, + "DefaultPort":{"shape":"IntegerOptional"}, + "OptionsDependedOn":{"shape":"OptionsDependedOn"}, + "Persistent":{"shape":"Boolean"}, + "Permanent":{"shape":"Boolean"}, + "OptionGroupOptionSettings":{"shape":"OptionGroupOptionSettingsList"} + } + }, + "OptionGroupOptionSetting":{ + "type":"structure", + "members":{ + "SettingName":{"shape":"String"}, + "SettingDescription":{"shape":"String"}, + "DefaultValue":{"shape":"String"}, + "ApplyType":{"shape":"String"}, + "AllowedValues":{"shape":"String"}, + "IsModifiable":{"shape":"Boolean"} + } + }, + "OptionGroupOptionSettingsList":{ + "type":"list", + "member":{ + "shape":"OptionGroupOptionSetting", + "locationName":"OptionGroupOptionSetting" + } + }, + "OptionGroupOptionsList":{ + "type":"list", + "member":{ + "shape":"OptionGroupOption", + "locationName":"OptionGroupOption" + } + }, + "OptionGroupOptionsMessage":{ + "type":"structure", + "members":{ + "OptionGroupOptions":{"shape":"OptionGroupOptionsList"}, + "Marker":{"shape":"String"} + } + }, + "OptionGroupQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"OptionGroupQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "OptionGroups":{ + "type":"structure", + "members":{ + "OptionGroupsList":{"shape":"OptionGroupsList"}, + "Marker":{"shape":"String"} + } + }, + "OptionGroupsList":{ + "type":"list", + "member":{ + "shape":"OptionGroup", + "locationName":"OptionGroup" + } + }, + "OptionNamesList":{ + "type":"list", + "member":{"shape":"String"} + }, + "OptionSetting":{ + "type":"structure", + "members":{ + "Name":{"shape":"String"}, + "Value":{"shape":"String"}, + "DefaultValue":{"shape":"String"}, + "Description":{"shape":"String"}, + "ApplyType":{"shape":"String"}, + "DataType":{"shape":"String"}, + "AllowedValues":{"shape":"String"}, + "IsModifiable":{"shape":"Boolean"}, + "IsCollection":{"shape":"Boolean"} + } + }, + "OptionSettingConfigurationList":{ + "type":"list", + "member":{ + "shape":"OptionSetting", + "locationName":"OptionSetting" + } + }, + "OptionSettingsList":{ + "type":"list", + "member":{ + "shape":"OptionSetting", + "locationName":"OptionSetting" + } + }, + "OptionsDependedOn":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"OptionName" + } + }, + "OptionsList":{ + "type":"list", + "member":{ + "shape":"Option", + "locationName":"Option" + } + }, + "OrderableDBInstanceOption":{ + "type":"structure", + "members":{ + "Engine":{"shape":"String"}, + "EngineVersion":{"shape":"String"}, + "DBInstanceClass":{"shape":"String"}, + "LicenseModel":{"shape":"String"}, + "AvailabilityZones":{"shape":"AvailabilityZoneList"}, + "MultiAZCapable":{"shape":"Boolean"}, + "ReadReplicaCapable":{"shape":"Boolean"}, + "Vpc":{"shape":"Boolean"}, + "StorageType":{"shape":"String"}, + "SupportsIops":{"shape":"Boolean"} + }, + "wrapper":true + }, + "OrderableDBInstanceOptionsList":{ + "type":"list", + "member":{ + "shape":"OrderableDBInstanceOption", + "locationName":"OrderableDBInstanceOption" + } + }, + "OrderableDBInstanceOptionsMessage":{ + "type":"structure", + "members":{ + "OrderableDBInstanceOptions":{"shape":"OrderableDBInstanceOptionsList"}, + "Marker":{"shape":"String"} + } + }, + "Parameter":{ + "type":"structure", + "members":{ + "ParameterName":{"shape":"String"}, + "ParameterValue":{"shape":"String"}, + "Description":{"shape":"String"}, + "Source":{"shape":"String"}, + "ApplyType":{"shape":"String"}, + "DataType":{"shape":"String"}, + "AllowedValues":{"shape":"String"}, + "IsModifiable":{"shape":"Boolean"}, + "MinimumEngineVersion":{"shape":"String"}, + "ApplyMethod":{"shape":"ApplyMethod"} + } + }, + "ParametersList":{ + "type":"list", + "member":{ + "shape":"Parameter", + "locationName":"Parameter" + } + }, + "PendingModifiedValues":{ + "type":"structure", + "members":{ + "DBInstanceClass":{"shape":"String"}, + "AllocatedStorage":{"shape":"IntegerOptional"}, + "MasterUserPassword":{"shape":"String"}, + "Port":{"shape":"IntegerOptional"}, + "BackupRetentionPeriod":{"shape":"IntegerOptional"}, + "MultiAZ":{"shape":"BooleanOptional"}, + "EngineVersion":{"shape":"String"}, + "Iops":{"shape":"IntegerOptional"}, + "DBInstanceIdentifier":{"shape":"String"}, + "StorageType":{"shape":"String"} + } + }, + "PointInTimeRestoreNotEnabledFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"PointInTimeRestoreNotEnabled", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "PromoteReadReplicaMessage":{ + "type":"structure", + "required":["DBInstanceIdentifier"], + "members":{ + "DBInstanceIdentifier":{"shape":"String"}, + "BackupRetentionPeriod":{"shape":"IntegerOptional"}, + "PreferredBackupWindow":{"shape":"String"} + } + }, + "PromoteReadReplicaResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "ProvisionedIopsNotAvailableInAZFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ProvisionedIopsNotAvailableInAZFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "PurchaseReservedDBInstancesOfferingMessage":{ + "type":"structure", + "required":["ReservedDBInstancesOfferingId"], + "members":{ + "ReservedDBInstancesOfferingId":{"shape":"String"}, + "ReservedDBInstanceId":{"shape":"String"}, + "DBInstanceCount":{"shape":"IntegerOptional"}, + "Tags":{"shape":"TagList"} + } + }, + "PurchaseReservedDBInstancesOfferingResult":{ + "type":"structure", + "members":{ + "ReservedDBInstance":{"shape":"ReservedDBInstance"} + } + }, + "ReadReplicaDBInstanceIdentifierList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ReadReplicaDBInstanceIdentifier" + } + }, + "RebootDBInstanceMessage":{ + "type":"structure", + "required":["DBInstanceIdentifier"], + "members":{ + "DBInstanceIdentifier":{"shape":"String"}, + "ForceFailover":{"shape":"BooleanOptional"} + } + }, + "RebootDBInstanceResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "RecurringCharge":{ + "type":"structure", + "members":{ + "RecurringChargeAmount":{"shape":"Double"}, + "RecurringChargeFrequency":{"shape":"String"} + }, + "wrapper":true + }, + "RecurringChargeList":{ + "type":"list", + "member":{ + "shape":"RecurringCharge", + "locationName":"RecurringCharge" + } + }, + "RemoveSourceIdentifierFromSubscriptionMessage":{ + "type":"structure", + "required":[ + "SubscriptionName", + "SourceIdentifier" + ], + "members":{ + "SubscriptionName":{"shape":"String"}, + "SourceIdentifier":{"shape":"String"} + } + }, + "RemoveSourceIdentifierFromSubscriptionResult":{ + "type":"structure", + "members":{ + "EventSubscription":{"shape":"EventSubscription"} + } + }, + "RemoveTagsFromResourceMessage":{ + "type":"structure", + "required":[ + "ResourceName", + "TagKeys" + ], + "members":{ + "ResourceName":{"shape":"String"}, + "TagKeys":{"shape":"KeyList"} + } + }, + "ReservedDBInstance":{ + "type":"structure", + "members":{ + "ReservedDBInstanceId":{"shape":"String"}, + "ReservedDBInstancesOfferingId":{"shape":"String"}, + "DBInstanceClass":{"shape":"String"}, + "StartTime":{"shape":"TStamp"}, + "Duration":{"shape":"Integer"}, + "FixedPrice":{"shape":"Double"}, + "UsagePrice":{"shape":"Double"}, + "CurrencyCode":{"shape":"String"}, + "DBInstanceCount":{"shape":"Integer"}, + "ProductDescription":{"shape":"String"}, + "OfferingType":{"shape":"String"}, + "MultiAZ":{"shape":"Boolean"}, + "State":{"shape":"String"}, + "RecurringCharges":{"shape":"RecurringChargeList"} + }, + "wrapper":true + }, + "ReservedDBInstanceAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ReservedDBInstanceAlreadyExists", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ReservedDBInstanceList":{ + "type":"list", + "member":{ + "shape":"ReservedDBInstance", + "locationName":"ReservedDBInstance" + } + }, + "ReservedDBInstanceMessage":{ + "type":"structure", + "members":{ + "Marker":{"shape":"String"}, + "ReservedDBInstances":{"shape":"ReservedDBInstanceList"} + } + }, + "ReservedDBInstanceNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ReservedDBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ReservedDBInstanceQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ReservedDBInstanceQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ReservedDBInstancesOffering":{ + "type":"structure", + "members":{ + "ReservedDBInstancesOfferingId":{"shape":"String"}, + "DBInstanceClass":{"shape":"String"}, + "Duration":{"shape":"Integer"}, + "FixedPrice":{"shape":"Double"}, + "UsagePrice":{"shape":"Double"}, + "CurrencyCode":{"shape":"String"}, + "ProductDescription":{"shape":"String"}, + "OfferingType":{"shape":"String"}, + "MultiAZ":{"shape":"Boolean"}, + "RecurringCharges":{"shape":"RecurringChargeList"} + }, + "wrapper":true + }, + "ReservedDBInstancesOfferingList":{ + "type":"list", + "member":{ + "shape":"ReservedDBInstancesOffering", + "locationName":"ReservedDBInstancesOffering" + } + }, + "ReservedDBInstancesOfferingMessage":{ + "type":"structure", + "members":{ + "Marker":{"shape":"String"}, + "ReservedDBInstancesOfferings":{"shape":"ReservedDBInstancesOfferingList"} + } + }, + "ReservedDBInstancesOfferingNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ReservedDBInstancesOfferingNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ResetDBParameterGroupMessage":{ + "type":"structure", + "required":["DBParameterGroupName"], + "members":{ + "DBParameterGroupName":{"shape":"String"}, + "ResetAllParameters":{"shape":"Boolean"}, + "Parameters":{"shape":"ParametersList"} + } + }, + "RestoreDBInstanceFromDBSnapshotMessage":{ + "type":"structure", + "required":[ + "DBInstanceIdentifier", + "DBSnapshotIdentifier" + ], + "members":{ + "DBInstanceIdentifier":{"shape":"String"}, + "DBSnapshotIdentifier":{"shape":"String"}, + "DBInstanceClass":{"shape":"String"}, + "Port":{"shape":"IntegerOptional"}, + "AvailabilityZone":{"shape":"String"}, + "DBSubnetGroupName":{"shape":"String"}, + "MultiAZ":{"shape":"BooleanOptional"}, + "PubliclyAccessible":{"shape":"BooleanOptional"}, + "AutoMinorVersionUpgrade":{"shape":"BooleanOptional"}, + "LicenseModel":{"shape":"String"}, + "DBName":{"shape":"String"}, + "Engine":{"shape":"String"}, + "Iops":{"shape":"IntegerOptional"}, + "OptionGroupName":{"shape":"String"}, + "Tags":{"shape":"TagList"}, + "StorageType":{"shape":"String"}, + "TdeCredentialArn":{"shape":"String"}, + "TdeCredentialPassword":{"shape":"String"} + } + }, + "RestoreDBInstanceFromDBSnapshotResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "RestoreDBInstanceToPointInTimeMessage":{ + "type":"structure", + "required":[ + "SourceDBInstanceIdentifier", + "TargetDBInstanceIdentifier" + ], + "members":{ + "SourceDBInstanceIdentifier":{"shape":"String"}, + "TargetDBInstanceIdentifier":{"shape":"String"}, + "RestoreTime":{"shape":"TStamp"}, + "UseLatestRestorableTime":{"shape":"Boolean"}, + "DBInstanceClass":{"shape":"String"}, + "Port":{"shape":"IntegerOptional"}, + "AvailabilityZone":{"shape":"String"}, + "DBSubnetGroupName":{"shape":"String"}, + "MultiAZ":{"shape":"BooleanOptional"}, + "PubliclyAccessible":{"shape":"BooleanOptional"}, + "AutoMinorVersionUpgrade":{"shape":"BooleanOptional"}, + "LicenseModel":{"shape":"String"}, + "DBName":{"shape":"String"}, + "Engine":{"shape":"String"}, + "Iops":{"shape":"IntegerOptional"}, + "OptionGroupName":{"shape":"String"}, + "Tags":{"shape":"TagList"}, + "StorageType":{"shape":"String"}, + "TdeCredentialArn":{"shape":"String"}, + "TdeCredentialPassword":{"shape":"String"} + } + }, + "RestoreDBInstanceToPointInTimeResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "RevokeDBSecurityGroupIngressMessage":{ + "type":"structure", + "required":["DBSecurityGroupName"], + "members":{ + "DBSecurityGroupName":{"shape":"String"}, + "CIDRIP":{"shape":"String"}, + "EC2SecurityGroupName":{"shape":"String"}, + "EC2SecurityGroupId":{"shape":"String"}, + "EC2SecurityGroupOwnerId":{"shape":"String"} + } + }, + "RevokeDBSecurityGroupIngressResult":{ + "type":"structure", + "members":{ + "DBSecurityGroup":{"shape":"DBSecurityGroup"} + } + }, + "SNSInvalidTopicFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SNSInvalidTopic", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "SNSNoAuthorizationFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SNSNoAuthorization", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "SNSTopicArnNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SNSTopicArnNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "SnapshotQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SnapshotQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "SourceIdsList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SourceId" + } + }, + "SourceNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SourceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "SourceType":{ + "type":"string", + "enum":[ + "db-instance", + "db-parameter-group", + "db-security-group", + "db-snapshot" + ] + }, + "StorageQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"StorageQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "StorageTypeNotSupportedFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"StorageTypeNotSupported", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "String":{"type":"string"}, + "Subnet":{ + "type":"structure", + "members":{ + "SubnetIdentifier":{"shape":"String"}, + "SubnetAvailabilityZone":{"shape":"AvailabilityZone"}, + "SubnetStatus":{"shape":"String"} + } + }, + "SubnetAlreadyInUse":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SubnetAlreadyInUse", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "SubnetIdentifierList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SubnetIdentifier" + } + }, + "SubnetList":{ + "type":"list", + "member":{ + "shape":"Subnet", + "locationName":"Subnet" + } + }, + "SubscriptionAlreadyExistFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SubscriptionAlreadyExist", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "SubscriptionCategoryNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SubscriptionCategoryNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "SubscriptionNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SubscriptionNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "SupportedCharacterSetsList":{ + "type":"list", + "member":{ + "shape":"CharacterSet", + "locationName":"CharacterSet" + } + }, + "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"} + } + }, + "VpcSecurityGroupIdList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"VpcSecurityGroupId" + } + }, + "VpcSecurityGroupMembership":{ + "type":"structure", + "members":{ + "VpcSecurityGroupId":{"shape":"String"}, + "Status":{"shape":"String"} + } + }, + "VpcSecurityGroupMembershipList":{ + "type":"list", + "member":{ + "shape":"VpcSecurityGroupMembership", + "locationName":"VpcSecurityGroupMembership" + } + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/rds/2014-09-01/docs-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/rds/2014-09-01/docs-2.json new file mode 100644 index 000000000..7c321267f --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/rds/2014-09-01/docs-2.json @@ -0,0 +1,1932 @@ +{ + "version": "2.0", + "service": "Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and scale a relational database in the cloud. It provides cost-efficient, resizable capacity for an industry-standard relational database and manages common database administration tasks, freeing up developers to focus on what makes their applications and businesses unique.
Amazon RDS gives you access to the capabilities of a MySQL, PostgreSQL, Microsoft SQL Server, or Oracle database server. This means the code, applications, and tools you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS is flexible: you can scale your database instance's compute resources and storage capacity to meet your application's demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for the resources you use.
This is an interface reference for Amazon RDS. It contains documentation for a programming or command line interface you can use to manage Amazon RDS. Note that Amazon RDS is asynchronous, which means that some interfaces may require techniques such as polling or callback functions to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, or during the maintenance window. For a summary of the Amazon RDS interfaces, go to Available RDS Interfaces.
", + "operations": { + "AddSourceIdentifierToSubscription": "Adds a source identifier to an existing RDS event notification subscription.
", + "AddTagsToResource": "Adds metadata tags to an Amazon RDS resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon RDS resources, or used in Condition statement in IAM policy for Amazon RDS.
For an overview on tagging Amazon RDS resources, see Tagging Amazon RDS Resources.
", + "AuthorizeDBSecurityGroupIngress": "Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC instances. Second, IP ranges are available if the application accessing your database is running on the Internet. Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).
For an overview of CIDR ranges, go to the Wikipedia Tutorial.
", + "CopyDBParameterGroup": "Copies the specified DB parameter group.
", + "CopyDBSnapshot": "Copies the specified DBSnapshot. The source DBSnapshot must be in the \"available\" state.
", + "CopyOptionGroup": "Copies the specified option group.
", + "CreateDBInstance": "Creates a new DB instance.
", + "CreateDBInstanceReadReplica": "Creates a DB instance that acts as a Read Replica of a source DB instance.
All Read Replica DB instances are created as Single-AZ deployments with backups disabled. All other DB instance attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance, except as specified below.
The source DB instance must have backup retention enabled.
Creates a new DB parameter group.
A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup. Once you've created a DB parameter group, you need to associate it with your DB instance using ModifyDBInstance. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect.
After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.
Creates a new DB security group. DB security groups control access to a DB instance.
", + "CreateDBSnapshot": "Creates a DBSnapshot. The source DBInstance must be in \"available\" state.
", + "CreateDBSubnetGroup": "Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the region.
", + "CreateEventSubscription": "Creates an RDS event notification subscription. This action requires a topic ARN (Amazon Resource Name) created by either the RDS console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.
You can specify the type of source (SourceType) you want to be notified of, provide a list of RDS sources (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.
If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIdentifier = myDBInstance1, you will be notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you will receive notice of the events for that source type for all your RDS sources. If you do not specify either the SourceType nor the SourceIdentifier, you will be notified of events generated from all RDS sources belonging to your customer account.
", + "CreateOptionGroup": "Creates a new option group. You can create up to 20 option groups.
", + "DeleteDBInstance": "The DeleteDBInstance action deletes a previously provisioned DB instance. A successful response from the web service indicates the request was received correctly. When you delete a DB instance, all automated backups for that instance are deleted and cannot be recovered. Manual DB snapshots of the DB instance to be deleted are not deleted.
If a final DB snapshot is requested the status of the RDS instance will be \"deleting\" until the DB snapshot is created. The API action DescribeDBInstance is used to monitor the status of this operation. The action cannot be canceled or reverted once submitted.
Deletes a specified DBParameterGroup. The DBParameterGroup to be deleted cannot be associated with any DB instances.
Deletes a DB security group.
Deletes a DBSnapshot. If the snapshot is being copied, the copy operation is terminated.
available state to be deleted.Deletes a DB subnet group.
Deletes an RDS event notification subscription.
", + "DeleteOptionGroup": "Deletes an existing option group.
", + "DescribeDBEngineVersions": "Returns a list of the available DB engines.
", + "DescribeDBInstances": "Returns information about provisioned RDS instances. This API supports pagination.
", + "DescribeDBLogFiles": "Returns a list of DB log files for the DB instance.
", + "DescribeDBParameterGroups": " Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DB parameter group.
Returns the detailed parameter list for a particular DB parameter group.
", + "DescribeDBSecurityGroups": " Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified, the list will contain only the descriptions of the specified DB security group.
Returns information about DB snapshots. This API supports pagination.
", + "DescribeDBSubnetGroups": "Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.
For an overview of CIDR ranges, go to the Wikipedia Tutorial.
", + "DescribeEngineDefaultParameters": "Returns the default engine and system parameter information for the specified database engine.
", + "DescribeEventCategories": "Displays a list of categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in the Events topic in the Amazon RDS User Guide.
", + "DescribeEventSubscriptions": "Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.
If you specify a SubscriptionName, lists the description for that subscription.
", + "DescribeEvents": "Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.
", + "DescribeOptionGroupOptions": "Describes all available options.
", + "DescribeOptionGroups": "Describes the available option groups.
", + "DescribeOrderableDBInstanceOptions": "Returns a list of orderable DB instance options for the specified engine.
", + "DescribeReservedDBInstances": "Returns information about reserved DB instances for this account, or about a specified reserved DB instance.
", + "DescribeReservedDBInstancesOfferings": "Lists available reserved DB instance offerings.
", + "DownloadDBLogFilePortion": "Downloads all or a portion of the specified log file.
", + "ListTagsForResource": "Lists all tags on an Amazon RDS resource.
For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources.
", + "ModifyDBInstance": "Modify settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.
", + "ModifyDBParameterGroup": " Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.
Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB instance associated with the parameter group before the change can take effect.
After you modify a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the modify action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.
Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the region.
", + "ModifyEventSubscription": "Modifies an existing RDS event notification subscription. Note that you cannot modify the source identifiers using this call; to change source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.
You can see a list of the event categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.
", + "ModifyOptionGroup": "Modifies an existing option group.
", + "PromoteReadReplica": "Promotes a Read Replica DB instance to a standalone DB instance.
We recommend that you enable automated backups on your Read Replica before promoting the Read Replica. This ensures that no backup is taken during the promotion process. Once the instance is promoted to a primary instance, backups are taken based on your backup settings.
Purchases a reserved DB instance offering.
", + "RebootDBInstance": "Rebooting a DB instance restarts the database engine service. A reboot also applies to the DB instance any modifications to the associated DB parameter group that were pending. Rebooting a DB instance results in a momentary outage of the instance, during which the DB instance status is set to rebooting. If the RDS instance is configured for MultiAZ, it is possible that the reboot will be conducted through a failover. An Amazon RDS event is created when the reboot is completed.
If your DB instance is deployed in multiple Availability Zones, you can force a failover from one AZ to the other during the reboot. You might force a failover to test the availability of your DB instance deployment or to restore operations to the original AZ after a failover occurs.
The time required to reboot is a function of the specific database engine's crash recovery process. To improve the reboot time, we recommend that you reduce database activities as much as possible during the reboot process to reduce rollback activity for in-transit transactions.
", + "RemoveSourceIdentifierFromSubscription": "Removes a source identifier from an existing RDS event notification subscription.
", + "RemoveTagsFromResource": "Removes metadata tags from an Amazon RDS resource.
For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources.
", + "ResetDBParameterGroup": " Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request.
Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with the same configuration as the original source database, except that the new RDS instance is created with the default security group.
If your intent is to replace your original DB instance with the new, restored DB instance, then rename your original DB instance before you call the RestoreDBInstanceFromDBSnapshot action. RDS does not allow two DB instances with the same name. Once you have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. The result is that you will replace the original DB instance with the DB instance created from the snapshot.
", + "RestoreDBInstanceToPointInTime": "Restores a DB instance to an arbitrary point-in-time. Users can restore to any point in time before the LatestRestorableTime for up to BackupRetentionPeriod days. The target database is created from the source database with the same configuration as the original database except that the DB instance is created with the default DB security group.
", + "RevokeDBSecurityGroupIngress": "Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC Security Groups. Required parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId).
" + }, + "shapes": { + "AddSourceIdentifierToSubscriptionMessage": { + "base": "", + "refs": { + } + }, + "AddSourceIdentifierToSubscriptionResult": { + "base": null, + "refs": { + } + }, + "AddTagsToResourceMessage": { + "base": "", + "refs": { + } + }, + "ApplyMethod": { + "base": null, + "refs": { + "Parameter$ApplyMethod": "Indicates when to apply parameter updates.
" + } + }, + "AuthorizationAlreadyExistsFault": { + "base": "The specified CIDRIP or EC2 security group is already authorized for the specified DB security group.
", + "refs": { + } + }, + "AuthorizationNotFoundFault": { + "base": "Specified CIDRIP or EC2 security group is not authorized for the specified DB security group.
RDS may not also be authorized via IAM to perform necessary actions on your behalf.
", + "refs": { + } + }, + "AuthorizationQuotaExceededFault": { + "base": "DB security group authorization quota has been reached.
", + "refs": { + } + }, + "AuthorizeDBSecurityGroupIngressMessage": { + "base": "", + "refs": { + } + }, + "AuthorizeDBSecurityGroupIngressResult": { + "base": null, + "refs": { + } + }, + "AvailabilityZone": { + "base": "
Contains Availability Zone information.
This data type is used as an element in the following data type:
", + "refs": { + "AvailabilityZoneList$member": null, + "Subnet$SubnetAvailabilityZone": null + } + }, + "AvailabilityZoneList": { + "base": null, + "refs": { + "OrderableDBInstanceOption$AvailabilityZones": "A list of availability zones for the orderable DB instance.
" + } + }, + "Boolean": { + "base": null, + "refs": { + "DBInstance$MultiAZ": "Specifies if the DB instance is a Multi-AZ deployment.
", + "DBInstance$AutoMinorVersionUpgrade": "Indicates that minor version patches are applied automatically.
", + "DBInstance$PubliclyAccessible": "Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.
", + "DBInstanceStatusInfo$Normal": "Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.
", + "DeleteDBInstanceMessage$SkipFinalSnapshot": " Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted.
Specify true when deleting a Read Replica.
false.Default: false
Indicates that only the default version of the specified engine or engine and major version combination is returned.
", + "DownloadDBLogFilePortionDetails$AdditionalDataPending": "Boolean value that if true, indicates there is more data to be downloaded.
", + "EventSubscription$Enabled": "A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.
", + "ModifyDBInstanceMessage$ApplyImmediately": "Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB instance.
If this parameter is set to false, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage and will be applied on the next call to RebootDBInstance, or the next failure reboot. Review the table of parameters in Modifying a DB Instance and Using the Apply Immediately Parameter to see the impact that setting ApplyImmediately to true or false has for each modified parameter and to determine when the changes will be applied.
Default: false
Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.
Constraints: This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.
", + "ModifyOptionGroupMessage$ApplyImmediately": "Indicates whether the changes should be applied immediately, or during the next maintenance window for each instance associated with the option group.
", + "Option$Persistent": "Indicate if this option is persistent.
", + "Option$Permanent": "Indicate if this option is permanent.
", + "OptionGroup$AllowsVpcAndNonVpcInstanceMemberships": "Indicates whether this option group can be applied to both VPC and non-VPC instances. The value true indicates the option group can be applied to both VPC and non-VPC instances.
Specifies whether the option requires a port.
", + "OptionGroupOption$Persistent": "A persistent option cannot be removed from the option group once the option group is used, but this option can be removed from the db instance while modifying the related data and assigning another option group without this option.
", + "OptionGroupOption$Permanent": "A permanent option cannot be removed from the option group once the option group is used, and it cannot be removed from the db instance after assigning an option group with this permanent option.
", + "OptionGroupOptionSetting$IsModifiable": "Boolean value where true indicates that this option group option can be changed from the default value.
", + "OptionSetting$IsModifiable": "A Boolean value that, when true, indicates the option setting can be modified from the default.
", + "OptionSetting$IsCollection": "Indicates if the option setting is part of a collection.
", + "OrderableDBInstanceOption$MultiAZCapable": "Indicates whether this orderable DB instance is multi-AZ capable.
", + "OrderableDBInstanceOption$ReadReplicaCapable": "Indicates whether this orderable DB instance can have a Read Replica.
", + "OrderableDBInstanceOption$Vpc": "Indicates whether this is a VPC orderable DB instance.
", + "OrderableDBInstanceOption$SupportsIops": "Indicates whether this orderable DB instance supports provisioned IOPS.
", + "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.
Indicates if the reservation applies to Multi-AZ deployments.
", + "ReservedDBInstancesOffering$MultiAZ": "Indicates if the offering applies to Multi-AZ deployments.
", + "ResetDBParameterGroupMessage$ResetAllParameters": " Specifies whether (true) or not (false) to reset all parameters in the DB parameter group to default values.
Default: true
Specifies whether (true) or not (false) the DB instance is restored from the latest backup time.
Default: false
Constraints: Cannot be specified if RestoreTime parameter is provided.
" + } + }, + "BooleanOptional": { + "base": null, + "refs": { + "CreateDBInstanceMessage$MultiAZ": "Specifies if the DB instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the MultiAZ parameter is set to true.
", + "CreateDBInstanceMessage$AutoMinorVersionUpgrade": "Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window.
Default: true
Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.
", + "CreateDBInstanceReadReplicaMessage$AutoMinorVersionUpgrade": "Indicates that minor engine upgrades will be applied automatically to the Read Replica during the maintenance window.
Default: Inherits from the source DB instance
", + "CreateDBInstanceReadReplicaMessage$PubliclyAccessible": "Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.
", + "CreateEventSubscriptionMessage$Enabled": "A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.
", + "DescribeDBEngineVersionsMessage$ListSupportedCharacterSets": "If this parameter is specified, and if the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.
", + "DescribeOrderableDBInstanceOptionsMessage$Vpc": "The VPC filter value. Specify this parameter to show only the available VPC or non-VPC offerings.
", + "DescribeReservedDBInstancesMessage$MultiAZ": "The Multi-AZ filter value. Specify this parameter to show only those reservations matching the specified Multi-AZ parameter.
", + "DescribeReservedDBInstancesOfferingsMessage$MultiAZ": "The Multi-AZ filter value. Specify this parameter to show only the available offerings matching the specified Multi-AZ parameter.
", + "ModifyDBInstanceMessage$MultiAZ": " Specifies if the DB instance is a Multi-AZ deployment. Changing this parameter does not result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.
Constraints: Cannot be specified if the DB instance is a Read Replica.
", + "ModifyDBInstanceMessage$AutoMinorVersionUpgrade": " Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window. Changing this parameter does not result in an outage except in the following case and the change is asynchronously applied as soon as possible. An outage will result if this parameter is set to true during the maintenance window, and a newer minor version is available, and RDS has enabled auto patching for that engine version.
A Boolean value; set to true to activate the subscription.
", + "PendingModifiedValues$MultiAZ": "Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.
", + "RebootDBInstanceMessage$ForceFailover": " When true, the reboot will be conducted through a MultiAZ failover.
Constraint: You cannot specify true if the instance is not configured for MultiAZ.
Specifies if the DB instance is a Multi-AZ deployment.
Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.
Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.
", + "RestoreDBInstanceFromDBSnapshotMessage$AutoMinorVersionUpgrade": "Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window.
", + "RestoreDBInstanceToPointInTimeMessage$MultiAZ": "Specifies if the DB instance is a Multi-AZ deployment.
Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.
Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.
", + "RestoreDBInstanceToPointInTimeMessage$AutoMinorVersionUpgrade": "Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window.
" + } + }, + "CharacterSet": { + "base": "This data type is used as a response element in the action DescribeDBEngineVersions.
", + "refs": { + "DBEngineVersion$DefaultCharacterSet": " The default character set for new instances of this engine version, if the CharacterSetName parameter of the CreateDBInstance API is not specified.
", + "refs": { + } + }, + "CopyDBParameterGroupResult": { + "base": null, + "refs": { + } + }, + "CopyDBSnapshotMessage": { + "base": "
", + "refs": { + } + }, + "CopyDBSnapshotResult": { + "base": null, + "refs": { + } + }, + "CopyOptionGroupMessage": { + "base": "
", + "refs": { + } + }, + "CopyOptionGroupResult": { + "base": null, + "refs": { + } + }, + "CreateDBInstanceMessage": { + "base": "
", + "refs": { + } + }, + "CreateDBInstanceReadReplicaMessage": { + "base": null, + "refs": { + } + }, + "CreateDBInstanceReadReplicaResult": { + "base": null, + "refs": { + } + }, + "CreateDBInstanceResult": { + "base": null, + "refs": { + } + }, + "CreateDBParameterGroupMessage": { + "base": "
", + "refs": { + } + }, + "CreateDBParameterGroupResult": { + "base": null, + "refs": { + } + }, + "CreateDBSecurityGroupMessage": { + "base": "
", + "refs": { + } + }, + "CreateDBSecurityGroupResult": { + "base": null, + "refs": { + } + }, + "CreateDBSnapshotMessage": { + "base": "
", + "refs": { + } + }, + "CreateDBSnapshotResult": { + "base": null, + "refs": { + } + }, + "CreateDBSubnetGroupMessage": { + "base": "
", + "refs": { + } + }, + "CreateDBSubnetGroupResult": { + "base": null, + "refs": { + } + }, + "CreateEventSubscriptionMessage": { + "base": "", + "refs": { + } + }, + "CreateEventSubscriptionResult": { + "base": null, + "refs": { + } + }, + "CreateOptionGroupMessage": { + "base": "", + "refs": { + } + }, + "CreateOptionGroupResult": { + "base": null, + "refs": { + } + }, + "DBEngineVersion": { + "base": "
This data type is used as a response element in the action DescribeDBEngineVersions.
", + "refs": { + "DBEngineVersionList$member": null + } + }, + "DBEngineVersionList": { + "base": null, + "refs": { + "DBEngineVersionMessage$DBEngineVersions": " A list of DBEngineVersion elements.
Contains the result of a successful invocation of the DescribeDBEngineVersions action.
", + "refs": { + } + }, + "DBInstance": { + "base": "Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBInstances action.
", + "refs": { + "CreateDBInstanceReadReplicaResult$DBInstance": null, + "CreateDBInstanceResult$DBInstance": null, + "DBInstanceList$member": null, + "DeleteDBInstanceResult$DBInstance": null, + "ModifyDBInstanceResult$DBInstance": null, + "PromoteReadReplicaResult$DBInstance": null, + "RebootDBInstanceResult$DBInstance": null, + "RestoreDBInstanceFromDBSnapshotResult$DBInstance": null, + "RestoreDBInstanceToPointInTimeResult$DBInstance": null + } + }, + "DBInstanceAlreadyExistsFault": { + "base": "User already has a DB instance with the given identifier.
", + "refs": { + } + }, + "DBInstanceList": { + "base": null, + "refs": { + "DBInstanceMessage$DBInstances": "A list of DBInstance instances.
" + } + }, + "DBInstanceMessage": { + "base": "Contains the result of a successful invocation of the DescribeDBInstances action.
", + "refs": { + } + }, + "DBInstanceNotFoundFault": { + "base": "DBInstanceIdentifier does not refer to an existing DB instance.
", + "refs": { + } + }, + "DBInstanceStatusInfo": { + "base": "Provides a list of status information for a DB instance.
", + "refs": { + "DBInstanceStatusInfoList$member": null + } + }, + "DBInstanceStatusInfoList": { + "base": null, + "refs": { + "DBInstance$StatusInfos": "The status of a Read Replica. If the instance is not a Read Replica, this will be blank.
" + } + }, + "DBLogFileNotFoundFault": { + "base": "LogFileName does not refer to an existing DB log file.
", + "refs": { + } + }, + "DBParameterGroup": { + "base": "Contains the result of a successful invocation of the CreateDBParameterGroup action.
This data type is used as a request parameter in the DeleteDBParameterGroup action, and as a response element in the DescribeDBParameterGroups action.
", + "refs": { + "CopyDBParameterGroupResult$DBParameterGroup": null, + "CreateDBParameterGroupResult$DBParameterGroup": null, + "DBParameterGroupList$member": null + } + }, + "DBParameterGroupAlreadyExistsFault": { + "base": "A DB parameter group with the same name exists.
", + "refs": { + } + }, + "DBParameterGroupDetails": { + "base": "Contains the result of a successful invocation of the DescribeDBParameters action.
", + "refs": { + } + }, + "DBParameterGroupList": { + "base": null, + "refs": { + "DBParameterGroupsMessage$DBParameterGroups": "A list of DBParameterGroup instances.
" + } + }, + "DBParameterGroupNameMessage": { + "base": "Contains the result of a successful invocation of the ModifyDBParameterGroup or ResetDBParameterGroup action.
", + "refs": { + } + }, + "DBParameterGroupNotFoundFault": { + "base": "DBParameterGroupName does not refer to an existing DB parameter group.
", + "refs": { + } + }, + "DBParameterGroupQuotaExceededFault": { + "base": "Request would result in user exceeding the allowed number of DB parameter groups.
", + "refs": { + } + }, + "DBParameterGroupStatus": { + "base": "The status of the DB parameter group.
This data type is used as a response element in the following actions:
Provides the list of DB parameter groups applied to this DB instance.
" + } + }, + "DBParameterGroupsMessage": { + "base": "Contains the result of a successful invocation of the DescribeDBParameterGroups action.
", + "refs": { + } + }, + "DBSecurityGroup": { + "base": "Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBSecurityGroups action.
", + "refs": { + "AuthorizeDBSecurityGroupIngressResult$DBSecurityGroup": null, + "CreateDBSecurityGroupResult$DBSecurityGroup": null, + "DBSecurityGroups$member": null, + "RevokeDBSecurityGroupIngressResult$DBSecurityGroup": null + } + }, + "DBSecurityGroupAlreadyExistsFault": { + "base": "A DB security group with the name specified in DBSecurityGroupName already exists.
", + "refs": { + } + }, + "DBSecurityGroupMembership": { + "base": "This data type is used as a response element in the following actions:
", + "refs": { + "DBSecurityGroupMembershipList$member": null + } + }, + "DBSecurityGroupMembershipList": { + "base": null, + "refs": { + "DBInstance$DBSecurityGroups": " Provides List of DB security group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.
If the option requires access to a port, then this DB security group allows access to the port.
" + } + }, + "DBSecurityGroupMessage": { + "base": "Contains the result of a successful invocation of the DescribeDBSecurityGroups action.
", + "refs": { + } + }, + "DBSecurityGroupNameList": { + "base": null, + "refs": { + "CreateDBInstanceMessage$DBSecurityGroups": "A list of DB security groups to associate with this DB instance.
Default: The default DB security group for the database engine.
", + "ModifyDBInstanceMessage$DBSecurityGroups": "A list of DB security groups to authorize on this DB instance. Changing this setting does not result in an outage and the change is asynchronously applied as soon as possible.
Constraints:
A list of DBSecurityGroupMemebrship name strings used for this option.
" + } + }, + "DBSecurityGroupNotFoundFault": { + "base": "DBSecurityGroupName does not refer to an existing DB security group.
", + "refs": { + } + }, + "DBSecurityGroupNotSupportedFault": { + "base": "A DB security group is not allowed for this action.
", + "refs": { + } + }, + "DBSecurityGroupQuotaExceededFault": { + "base": "Request would result in user exceeding the allowed number of DB security groups.
", + "refs": { + } + }, + "DBSecurityGroups": { + "base": null, + "refs": { + "DBSecurityGroupMessage$DBSecurityGroups": "A list of DBSecurityGroup instances.
" + } + }, + "DBSnapshot": { + "base": "Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBSnapshots action.
", + "refs": { + "CopyDBSnapshotResult$DBSnapshot": null, + "CreateDBSnapshotResult$DBSnapshot": null, + "DBSnapshotList$member": null, + "DeleteDBSnapshotResult$DBSnapshot": null + } + }, + "DBSnapshotAlreadyExistsFault": { + "base": "DBSnapshotIdentifier is already used by an existing snapshot.
", + "refs": { + } + }, + "DBSnapshotList": { + "base": null, + "refs": { + "DBSnapshotMessage$DBSnapshots": "A list of DBSnapshot instances.
" + } + }, + "DBSnapshotMessage": { + "base": "Contains the result of a successful invocation of the DescribeDBSnapshots action.
", + "refs": { + } + }, + "DBSnapshotNotFoundFault": { + "base": "DBSnapshotIdentifier does not refer to an existing DB snapshot.
", + "refs": { + } + }, + "DBSubnetGroup": { + "base": "Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBSubnetGroups action.
", + "refs": { + "CreateDBSubnetGroupResult$DBSubnetGroup": null, + "DBInstance$DBSubnetGroup": "Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
", + "DBSubnetGroups$member": null, + "ModifyDBSubnetGroupResult$DBSubnetGroup": null + } + }, + "DBSubnetGroupAlreadyExistsFault": { + "base": "DBSubnetGroupName is already used by an existing DB subnet group.
", + "refs": { + } + }, + "DBSubnetGroupDoesNotCoverEnoughAZs": { + "base": "Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
", + "refs": { + } + }, + "DBSubnetGroupMessage": { + "base": "Contains the result of a successful invocation of the DescribeDBSubnetGroups action.
", + "refs": { + } + }, + "DBSubnetGroupNotAllowedFault": { + "base": "Indicates that the DBSubnetGroup should not be specified while creating read replicas that lie in the same region as the source instance.
", + "refs": { + } + }, + "DBSubnetGroupNotFoundFault": { + "base": "DBSubnetGroupName does not refer to an existing DB subnet group.
", + "refs": { + } + }, + "DBSubnetGroupQuotaExceededFault": { + "base": "Request would result in user exceeding the allowed number of DB subnet groups.
", + "refs": { + } + }, + "DBSubnetGroups": { + "base": null, + "refs": { + "DBSubnetGroupMessage$DBSubnetGroups": "A list of DBSubnetGroup instances.
" + } + }, + "DBSubnetQuotaExceededFault": { + "base": "Request would result in user exceeding the allowed number of subnets in a DB subnet groups.
", + "refs": { + } + }, + "DBUpgradeDependencyFailureFault": { + "base": "The DB upgrade failed because a resource the DB depends on could not be modified.
", + "refs": { + } + }, + "DeleteDBInstanceMessage": { + "base": "", + "refs": { + } + }, + "DeleteDBInstanceResult": { + "base": null, + "refs": { + } + }, + "DeleteDBParameterGroupMessage": { + "base": "
", + "refs": { + } + }, + "DeleteDBSecurityGroupMessage": { + "base": "
", + "refs": { + } + }, + "DeleteDBSnapshotMessage": { + "base": "
", + "refs": { + } + }, + "DeleteDBSnapshotResult": { + "base": null, + "refs": { + } + }, + "DeleteDBSubnetGroupMessage": { + "base": "
", + "refs": { + } + }, + "DeleteEventSubscriptionMessage": { + "base": "", + "refs": { + } + }, + "DeleteEventSubscriptionResult": { + "base": null, + "refs": { + } + }, + "DeleteOptionGroupMessage": { + "base": "
", + "refs": { + } + }, + "DescribeDBEngineVersionsMessage": { + "base": null, + "refs": { + } + }, + "DescribeDBInstancesMessage": { + "base": "
", + "refs": { + } + }, + "DescribeDBLogFilesDetails": { + "base": "
This data type is used as a response element to DescribeDBLogFiles.
", + "refs": { + "DescribeDBLogFilesList$member": null + } + }, + "DescribeDBLogFilesList": { + "base": null, + "refs": { + "DescribeDBLogFilesResponse$DescribeDBLogFiles": "The DB log files returned.
" + } + }, + "DescribeDBLogFilesMessage": { + "base": "", + "refs": { + } + }, + "DescribeDBLogFilesResponse": { + "base": "
The response from a call to DescribeDBLogFiles.
", + "refs": { + } + }, + "DescribeDBParameterGroupsMessage": { + "base": "", + "refs": { + } + }, + "DescribeDBParametersMessage": { + "base": null, + "refs": { + } + }, + "DescribeDBSecurityGroupsMessage": { + "base": "
", + "refs": { + } + }, + "DescribeDBSnapshotsMessage": { + "base": "
", + "refs": { + } + }, + "DescribeDBSubnetGroupsMessage": { + "base": "
", + "refs": { + } + }, + "DescribeEngineDefaultParametersMessage": { + "base": "
", + "refs": { + } + }, + "DescribeEngineDefaultParametersResult": { + "base": null, + "refs": { + } + }, + "DescribeEventCategoriesMessage": { + "base": "", + "refs": { + } + }, + "DescribeEventSubscriptionsMessage": { + "base": "", + "refs": { + } + }, + "DescribeEventsMessage": { + "base": "
", + "refs": { + } + }, + "DescribeOptionGroupOptionsMessage": { + "base": "
", + "refs": { + } + }, + "DescribeOptionGroupsMessage": { + "base": "
", + "refs": { + } + }, + "DescribeOrderableDBInstanceOptionsMessage": { + "base": "
", + "refs": { + } + }, + "DescribeReservedDBInstancesMessage": { + "base": "
", + "refs": { + } + }, + "DescribeReservedDBInstancesOfferingsMessage": { + "base": "
", + "refs": { + } + }, + "Double": { + "base": null, + "refs": { + "RecurringCharge$RecurringChargeAmount": "
The amount of the recurring charge.
", + "ReservedDBInstance$FixedPrice": "The fixed price charged for this reserved DB instance.
", + "ReservedDBInstance$UsagePrice": "The hourly price charged for this reserved DB instance.
", + "ReservedDBInstancesOffering$FixedPrice": "The fixed price charged for this offering.
", + "ReservedDBInstancesOffering$UsagePrice": "The hourly price charged for this offering.
" + } + }, + "DownloadDBLogFilePortionDetails": { + "base": "This data type is used as a response element to DownloadDBLogFilePortion.
", + "refs": { + } + }, + "DownloadDBLogFilePortionMessage": { + "base": "", + "refs": { + } + }, + "EC2SecurityGroup": { + "base": "
This data type is used as a response element in the following actions:
", + "refs": { + "EC2SecurityGroupList$member": null + } + }, + "EC2SecurityGroupList": { + "base": null, + "refs": { + "DBSecurityGroup$EC2SecurityGroups": "Contains a list of EC2SecurityGroup elements.
" + } + }, + "Endpoint": { + "base": "This data type is used as a response element in the following actions:
", + "refs": { + "DBInstance$Endpoint": "Specifies the connection endpoint.
" + } + }, + "EngineDefaults": { + "base": "Contains the result of a successful invocation of the DescribeEngineDefaultParameters action.
", + "refs": { + "DescribeEngineDefaultParametersResult$EngineDefaults": null + } + }, + "Event": { + "base": "This data type is used as a response element in the DescribeEvents action.
", + "refs": { + "EventList$member": null + } + }, + "EventCategoriesList": { + "base": null, + "refs": { + "CreateEventSubscriptionMessage$EventCategories": "A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.
", + "DescribeEventsMessage$EventCategories": "A list of event categories that trigger notifications for a event notification subscription.
", + "Event$EventCategories": "Specifies the category for the event.
", + "EventCategoriesMap$EventCategories": "The event categories for the specified source type
", + "EventSubscription$EventCategoriesList": "A list of event categories for the RDS event notification subscription.
", + "ModifyEventSubscriptionMessage$EventCategories": "A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.
" + } + }, + "EventCategoriesMap": { + "base": "Contains the results of a successful invocation of the DescribeEventCategories action.
", + "refs": { + "EventCategoriesMapList$member": null + } + }, + "EventCategoriesMapList": { + "base": null, + "refs": { + "EventCategoriesMessage$EventCategoriesMapList": "A list of EventCategoriesMap data types.
" + } + }, + "EventCategoriesMessage": { + "base": "Data returned from the DescribeEventCategories action.
", + "refs": { + } + }, + "EventList": { + "base": null, + "refs": { + "EventsMessage$Events": "A list of Event instances.
" + } + }, + "EventSubscription": { + "base": "Contains the results of a successful invocation of the DescribeEventSubscriptions action.
", + "refs": { + "AddSourceIdentifierToSubscriptionResult$EventSubscription": null, + "CreateEventSubscriptionResult$EventSubscription": null, + "DeleteEventSubscriptionResult$EventSubscription": null, + "EventSubscriptionsList$member": null, + "ModifyEventSubscriptionResult$EventSubscription": null, + "RemoveSourceIdentifierFromSubscriptionResult$EventSubscription": null + } + }, + "EventSubscriptionQuotaExceededFault": { + "base": "You have reached the maximum number of event subscriptions.
", + "refs": { + } + }, + "EventSubscriptionsList": { + "base": null, + "refs": { + "EventSubscriptionsMessage$EventSubscriptionsList": "A list of EventSubscriptions data types.
" + } + }, + "EventSubscriptionsMessage": { + "base": "Data returned by the DescribeEventSubscriptions action.
", + "refs": { + } + }, + "EventsMessage": { + "base": "Contains the result of a successful invocation of the DescribeEvents action.
", + "refs": { + } + }, + "Filter": { + "base": null, + "refs": { + "FilterList$member": null + } + }, + "FilterList": { + "base": null, + "refs": { + "DescribeDBEngineVersionsMessage$Filters": "Not currently supported.
", + "DescribeDBInstancesMessage$Filters": "This parameter is not currently supported.
", + "DescribeDBLogFilesMessage$Filters": "This parameter is not currently supported.
", + "DescribeDBParameterGroupsMessage$Filters": "This parameter is not currently supported.
", + "DescribeDBParametersMessage$Filters": "This parameter is not currently supported.
", + "DescribeDBSecurityGroupsMessage$Filters": "This parameter is not currently supported.
", + "DescribeDBSnapshotsMessage$Filters": "This parameter is not currently supported.
", + "DescribeDBSubnetGroupsMessage$Filters": "This parameter is not currently supported.
", + "DescribeEngineDefaultParametersMessage$Filters": "Not currently supported.
", + "DescribeEventCategoriesMessage$Filters": "This parameter is not currently supported.
", + "DescribeEventSubscriptionsMessage$Filters": "This parameter is not currently supported.
", + "DescribeEventsMessage$Filters": "This parameter is not currently supported.
", + "DescribeOptionGroupOptionsMessage$Filters": "This parameter is not currently supported.
", + "DescribeOptionGroupsMessage$Filters": "This parameter is not currently supported.
", + "DescribeOrderableDBInstanceOptionsMessage$Filters": "This parameter is not currently supported.
", + "DescribeReservedDBInstancesMessage$Filters": "This parameter is not currently supported.
", + "DescribeReservedDBInstancesOfferingsMessage$Filters": "This parameter is not currently supported.
", + "ListTagsForResourceMessage$Filters": "This parameter is not currently supported.
" + } + }, + "FilterValueList": { + "base": null, + "refs": { + "Filter$Values": "This parameter is not currently supported.
" + } + }, + "IPRange": { + "base": "This data type is used as a response element in the DescribeDBSecurityGroups action.
", + "refs": { + "IPRangeList$member": null + } + }, + "IPRangeList": { + "base": null, + "refs": { + "DBSecurityGroup$IPRanges": "Contains a list of IPRange elements.
" + } + }, + "InstanceQuotaExceededFault": { + "base": "Request would result in user exceeding the allowed number of DB instances.
", + "refs": { + } + }, + "InsufficientDBInstanceCapacityFault": { + "base": "Specified DB instance class is not available in the specified Availability Zone.
", + "refs": { + } + }, + "Integer": { + "base": null, + "refs": { + "DBInstance$AllocatedStorage": "Specifies the allocated storage size specified in gigabytes.
", + "DBInstance$BackupRetentionPeriod": "Specifies the number of days for which automatic DB snapshots are retained.
", + "DBSnapshot$AllocatedStorage": "Specifies the allocated storage size in gigabytes (GB).
", + "DBSnapshot$Port": "Specifies the port that the database engine was listening on at the time of the snapshot.
", + "DBSnapshot$PercentProgress": "The percentage of the estimated data that has been transferred.
", + "DownloadDBLogFilePortionMessage$NumberOfLines": "The number of lines to download.
If the NumberOfLines parameter is specified, then the block of lines returned can be from the beginning or the end of the log file, depending on the value of the Marker parameter.
If neither Marker or NumberOfLines are specified, the entire log file is returned.
If NumberOfLines is specified and Marker is not specified, then the most recent lines from the end of the log file are returned.
If Marker is specified as \"0\", then the specified number of lines from the beginning of the log file are returned.
You can download the log file in blocks of lines by specifying the size of the block using the NumberOfLines parameter, and by specifying a value of \"0\" for the Marker parameter in your first request. Include the Marker value returned in the response as the Marker value for the next request, continuing until the AdditionalDataPending response element returns false.
Specifies the port that the database engine is listening on.
", + "ReservedDBInstance$Duration": "The duration of the reservation in seconds.
", + "ReservedDBInstance$DBInstanceCount": "The number of reserved DB instances.
", + "ReservedDBInstancesOffering$Duration": "The duration of the offering in seconds.
" + } + }, + "IntegerOptional": { + "base": null, + "refs": { + "CreateDBInstanceMessage$AllocatedStorage": "The amount of storage (in gigabytes) to be initially allocated for the database instance.
Type: Integer
MySQL
Constraints: Must be an integer from 5 to 3072.
PostgreSQL
Constraints: Must be an integer from 5 to 3072.
Oracle
Constraints: Must be an integer from 10 to 3072.
SQL Server
Constraints: Must be an integer from 200 to 1024 (Standard Edition and Enterprise Edition) or from 20 to 1024 (Express Edition and Web Edition)
", + "CreateDBInstanceMessage$BackupRetentionPeriod": "The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
Default: 1
Constraints:
The port number on which the database accepts connections.
MySQL
Default: 3306
Valid Values: 1150-65535
Type: Integer
PostgreSQL
Default: 5432
Valid Values: 1150-65535
Type: Integer
Oracle
Default: 1521
Valid Values: 1150-65535
SQL Server
Default: 1433
Valid Values: 1150-65535 except for 1434, 3389, 47001, 49152, and 49152 through 49156.
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
Constraints: To use PIOPS, this value must be an integer greater than 1000.
", + "CreateDBInstanceReadReplicaMessage$Port": "The port number that the DB instance uses for connections.
Default: Inherits from the source DB instance
Valid Values: 1150-65535
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
", + "DBInstance$Iops": "Specifies the Provisioned IOPS (I/O operations per second) value.
", + "DBSnapshot$Iops": "Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
", + "DescribeDBEngineVersionsMessage$MaxRecords": " The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
", + "DescribeDBInstancesMessage$MaxRecords": " The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
", + "DescribeDBLogFilesMessage$MaxRecords": "The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
", + "DescribeDBParameterGroupsMessage$MaxRecords": " The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
", + "DescribeDBParametersMessage$MaxRecords": " The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
", + "DescribeDBSecurityGroupsMessage$MaxRecords": " The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
", + "DescribeDBSnapshotsMessage$MaxRecords": " The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
", + "DescribeDBSubnetGroupsMessage$MaxRecords": " The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may 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 pagination token called a marker is included in the response so that the remaining results may be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
", + "DescribeEventSubscriptionsMessage$MaxRecords": " The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called 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 to retrieve events for.
Default: 60
", + "DescribeEventsMessage$MaxRecords": " The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
", + "DescribeOptionGroupOptionsMessage$MaxRecords": " The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
", + "DescribeOptionGroupsMessage$MaxRecords": " The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
", + "DescribeOrderableDBInstanceOptionsMessage$MaxRecords": " The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
", + "DescribeReservedDBInstancesMessage$MaxRecords": " The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
", + "DescribeReservedDBInstancesOfferingsMessage$MaxRecords": " The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
", + "ModifyDBInstanceMessage$AllocatedStorage": " The new storage capacity of the RDS instance. Changing this setting does not result in an outage and the change is applied during the next maintenance window unless ApplyImmediately is set to true for this request.
MySQL
Default: Uses existing setting
Valid Values: 5-3072
Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
Type: Integer
PostgreSQL
Default: Uses existing setting
Valid Values: 5-3072
Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
Type: Integer
Oracle
Default: Uses existing setting
Valid Values: 10-3072
Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
SQL Server
Cannot be modified.
If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance will be available for use, but may experience performance degradation. While the migration takes place, nightly backups for the instance will be suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and creating a DB snapshot of the instance.
", + "ModifyDBInstanceMessage$BackupRetentionPeriod": "The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
Changing this parameter can result in an outage if you change from 0 to a non-zero value or from a non-zero value to 0. These changes are applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously applied as soon as possible.
Default: Uses existing setting
Constraints:
The new Provisioned IOPS (I/O operations per second) value for the RDS instance. Changing this setting does not result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.
Default: Uses existing setting
Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value. If you are migrating from Provisioned IOPS to standard storage, set this value to 0. The DB instance will require a reboot for the change in storage type to take effect.
SQL Server
Setting the IOPS value for the SQL Server database engine is not supported.
Type: Integer
If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance will be available for use, but may experience performance degradation. While the migration takes place, nightly backups for the instance will be suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and creating a DB snapshot of the instance.
", + "Option$Port": "If required, the port configured for this option to use.
", + "OptionConfiguration$Port": "The optional port for the option.
", + "OptionGroupOption$DefaultPort": "If the option requires a port, specifies the default port for the option.
", + "PendingModifiedValues$AllocatedStorage": " Contains the new AllocatedStorage size for the DB instance that will be applied or is in progress.
Specifies the pending port for the DB instance.
", + "PendingModifiedValues$BackupRetentionPeriod": "Specifies the pending number of days for which automated backups are retained.
", + "PendingModifiedValues$Iops": "Specifies the new Provisioned IOPS value for the DB instance that will be applied or is being applied.
", + "PromoteReadReplicaMessage$BackupRetentionPeriod": "The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
Default: 1
Constraints:
The number of instances to reserve.
Default: 1
The port number on which the database accepts connections.
Default: The same port as the original DB instance
Constraints: Value must be 1150-65535
Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. If this parameter is not specified, the IOPS value will be taken from the backup. If this parameter is set to 0, the new instance will be converted to a non-PIOPS instance, which will take additional time, though your DB instance will be available for connections before the conversion starts.
Constraints: Must be an integer greater than 1000.
SQL Server
Setting the IOPS value for the SQL Server database engine is not supported.
", + "RestoreDBInstanceToPointInTimeMessage$Port": "The port number on which the database accepts connections.
Constraints: Value must be 1150-65535
Default: The same port as the original DB instance.
", + "RestoreDBInstanceToPointInTimeMessage$Iops": "The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
Constraints: Must be an integer greater than 1000.
SQL Server
Setting the IOPS value for the SQL Server database engine is not supported.
" + } + }, + "InvalidDBInstanceStateFault": { + "base": "The specified DB instance is not in the available state.
", + "refs": { + } + }, + "InvalidDBParameterGroupStateFault": { + "base": "The DB parameter group cannot be deleted because it is in use.
", + "refs": { + } + }, + "InvalidDBSecurityGroupStateFault": { + "base": "The state of the DB security group does not allow deletion.
", + "refs": { + } + }, + "InvalidDBSnapshotStateFault": { + "base": "The state of the DB snapshot does not allow deletion.
", + "refs": { + } + }, + "InvalidDBSubnetGroupFault": { + "base": "Indicates the DBSubnetGroup does not belong to the same VPC as that of an existing cross region read replica of the same source instance.
", + "refs": { + } + }, + "InvalidDBSubnetGroupStateFault": { + "base": "The DB subnet group cannot be deleted because it is in use.
", + "refs": { + } + }, + "InvalidDBSubnetStateFault": { + "base": "The DB subnet is not in the available state.
", + "refs": { + } + }, + "InvalidEventSubscriptionStateFault": { + "base": "This error can occur if someone else is modifying a subscription. You should retry the action.
", + "refs": { + } + }, + "InvalidOptionGroupStateFault": { + "base": "The option group is not in the available state.
", + "refs": { + } + }, + "InvalidRestoreFault": { + "base": "Cannot restore from vpc backup to non-vpc DB instance.
", + "refs": { + } + }, + "InvalidSubnet": { + "base": "The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
", + "refs": { + } + }, + "InvalidVPCNetworkStateFault": { + "base": "DB subnet group does not cover all Availability Zones after it is created because users' change.
", + "refs": { + } + }, + "KeyList": { + "base": null, + "refs": { + "RemoveTagsFromResourceMessage$TagKeys": "The tag key (name) of the tag to be removed.
" + } + }, + "ListTagsForResourceMessage": { + "base": "", + "refs": { + } + }, + "Long": { + "base": null, + "refs": { + "DescribeDBLogFilesDetails$LastWritten": "A POSIX timestamp when the last log entry was written.
", + "DescribeDBLogFilesDetails$Size": "The size, in bytes, of the log file for the specified DB instance.
", + "DescribeDBLogFilesMessage$FileLastWritten": "Filters the available log files for files written since the specified date, in POSIX timestamp format.
", + "DescribeDBLogFilesMessage$FileSize": "Filters the available log files for files larger than the specified size.
" + } + }, + "ModifyDBInstanceMessage": { + "base": "", + "refs": { + } + }, + "ModifyDBInstanceResult": { + "base": null, + "refs": { + } + }, + "ModifyDBParameterGroupMessage": { + "base": "
", + "refs": { + } + }, + "ModifyDBSubnetGroupMessage": { + "base": "
", + "refs": { + } + }, + "ModifyDBSubnetGroupResult": { + "base": null, + "refs": { + } + }, + "ModifyEventSubscriptionMessage": { + "base": "", + "refs": { + } + }, + "ModifyEventSubscriptionResult": { + "base": null, + "refs": { + } + }, + "ModifyOptionGroupMessage": { + "base": "
", + "refs": { + } + }, + "ModifyOptionGroupResult": { + "base": null, + "refs": { + } + }, + "Option": { + "base": "
Option details.
", + "refs": { + "OptionsList$member": null + } + }, + "OptionConfiguration": { + "base": "A list of all available options
", + "refs": { + "OptionConfigurationList$member": null + } + }, + "OptionConfigurationList": { + "base": null, + "refs": { + "ModifyOptionGroupMessage$OptionsToInclude": "Options in this list are added to the option group or, if already present, the specified configuration is used to update the existing configuration.
" + } + }, + "OptionGroup": { + "base": "", + "refs": { + "CopyOptionGroupResult$OptionGroup": null, + "CreateOptionGroupResult$OptionGroup": null, + "ModifyOptionGroupResult$OptionGroup": null, + "OptionGroupsList$member": null + } + }, + "OptionGroupAlreadyExistsFault": { + "base": "
The option group you are trying to create already exists.
", + "refs": { + } + }, + "OptionGroupMembership": { + "base": "Provides information on the option groups the DB instance is a member of.
", + "refs": { + "OptionGroupMembershipList$member": null + } + }, + "OptionGroupMembershipList": { + "base": null, + "refs": { + "DBInstance$OptionGroupMemberships": "Provides the list of option group memberships for this DB instance.
" + } + }, + "OptionGroupNotFoundFault": { + "base": "The specified option group could not be found.
", + "refs": { + } + }, + "OptionGroupOption": { + "base": "Available option.
", + "refs": { + "OptionGroupOptionsList$member": null + } + }, + "OptionGroupOptionSetting": { + "base": "Option group option settings are used to display settings available for each option with their default values and other information. These values are used with the DescribeOptionGroupOptions action.
", + "refs": { + "OptionGroupOptionSettingsList$member": null + } + }, + "OptionGroupOptionSettingsList": { + "base": null, + "refs": { + "OptionGroupOption$OptionGroupOptionSettings": "Specifies the option settings that are available (and the default value) for each option in an option group.
" + } + }, + "OptionGroupOptionsList": { + "base": "List of available option group options.
", + "refs": { + "OptionGroupOptionsMessage$OptionGroupOptions": null + } + }, + "OptionGroupOptionsMessage": { + "base": "", + "refs": { + } + }, + "OptionGroupQuotaExceededFault": { + "base": "
The quota of 20 option groups was exceeded for this AWS account.
", + "refs": { + } + }, + "OptionGroups": { + "base": "List of option groups.
", + "refs": { + } + }, + "OptionGroupsList": { + "base": null, + "refs": { + "OptionGroups$OptionGroupsList": "List of option groups.
" + } + }, + "OptionNamesList": { + "base": null, + "refs": { + "ModifyOptionGroupMessage$OptionsToRemove": "Options in this list are removed from the option group.
" + } + }, + "OptionSetting": { + "base": "Option settings are the actual settings being applied or configured for that option. It is used when you modify an option group or describe option groups. For example, the NATIVE_NETWORK_ENCRYPTION option has a setting called SQLNET.ENCRYPTION_SERVER that can have several different values.
", + "refs": { + "OptionSettingConfigurationList$member": null, + "OptionSettingsList$member": null + } + }, + "OptionSettingConfigurationList": { + "base": null, + "refs": { + "Option$OptionSettings": "The option settings for this option.
" + } + }, + "OptionSettingsList": { + "base": null, + "refs": { + "OptionConfiguration$OptionSettings": "The option settings to include in an option group.
" + } + }, + "OptionsDependedOn": { + "base": null, + "refs": { + "OptionGroupOption$OptionsDependedOn": "List of all options that are prerequisites for this option.
" + } + }, + "OptionsList": { + "base": null, + "refs": { + "OptionGroup$Options": "Indicates what options are available in the option group.
" + } + }, + "OrderableDBInstanceOption": { + "base": "Contains a list of available options for a DB instance
This data type is used as a response element in the DescribeOrderableDBInstanceOptions action.
", + "refs": { + "OrderableDBInstanceOptionsList$member": null + } + }, + "OrderableDBInstanceOptionsList": { + "base": null, + "refs": { + "OrderableDBInstanceOptionsMessage$OrderableDBInstanceOptions": "An OrderableDBInstanceOption structure containing information about orderable options for the DB instance.
" + } + }, + "OrderableDBInstanceOptionsMessage": { + "base": "Contains the result of a successful invocation of the DescribeOrderableDBInstanceOptions action.
", + "refs": { + } + }, + "Parameter": { + "base": "This data type is used as a request parameter in the ModifyDBParameterGroup and ResetDBParameterGroup actions.
This data type is used as a response element in the DescribeEngineDefaultParameters and DescribeDBParameters actions.
", + "refs": { + "ParametersList$member": null + } + }, + "ParametersList": { + "base": null, + "refs": { + "DBParameterGroupDetails$Parameters": "A list of Parameter values.
", + "EngineDefaults$Parameters": "Contains a list of engine default parameters.
", + "ModifyDBParameterGroupMessage$Parameters": "An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters may be modified in a single request.
Valid Values (for the application method): immediate | pending-reboot
An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters may be modified in a single request.
MySQL
Valid Values (for Apply method): immediate | pending-reboot
You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when DB instance reboots.
Oracle
Valid Values (for Apply method): pending-reboot
This data type is used as a response element in the ModifyDBInstance action.
", + "refs": { + "DBInstance$PendingModifiedValues": "Specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
" + } + }, + "PointInTimeRestoreNotEnabledFault": { + "base": "SourceDBInstanceIdentifier refers to a DB instance with BackupRetentionPeriod equal to 0.
", + "refs": { + } + }, + "PromoteReadReplicaMessage": { + "base": "", + "refs": { + } + }, + "PromoteReadReplicaResult": { + "base": null, + "refs": { + } + }, + "ProvisionedIopsNotAvailableInAZFault": { + "base": "
Provisioned IOPS not available in the specified Availability Zone.
", + "refs": { + } + }, + "PurchaseReservedDBInstancesOfferingMessage": { + "base": "", + "refs": { + } + }, + "PurchaseReservedDBInstancesOfferingResult": { + "base": null, + "refs": { + } + }, + "ReadReplicaDBInstanceIdentifierList": { + "base": null, + "refs": { + "DBInstance$ReadReplicaDBInstanceIdentifiers": "
Contains one or more identifiers of the Read Replicas associated with this DB instance.
" + } + }, + "RebootDBInstanceMessage": { + "base": "", + "refs": { + } + }, + "RebootDBInstanceResult": { + "base": null, + "refs": { + } + }, + "RecurringCharge": { + "base": "
This data type is used as a response element in the DescribeReservedDBInstances and DescribeReservedDBInstancesOfferings actions.
", + "refs": { + "RecurringChargeList$member": null + } + }, + "RecurringChargeList": { + "base": null, + "refs": { + "ReservedDBInstance$RecurringCharges": "The recurring price charged to run this reserved DB instance.
", + "ReservedDBInstancesOffering$RecurringCharges": "The recurring price charged to run this reserved DB instance.
" + } + }, + "RemoveSourceIdentifierFromSubscriptionMessage": { + "base": "", + "refs": { + } + }, + "RemoveSourceIdentifierFromSubscriptionResult": { + "base": null, + "refs": { + } + }, + "RemoveTagsFromResourceMessage": { + "base": "", + "refs": { + } + }, + "ReservedDBInstance": { + "base": "This data type is used as a response element in the DescribeReservedDBInstances and PurchaseReservedDBInstancesOffering actions.
", + "refs": { + "PurchaseReservedDBInstancesOfferingResult$ReservedDBInstance": null, + "ReservedDBInstanceList$member": null + } + }, + "ReservedDBInstanceAlreadyExistsFault": { + "base": "User already has a reservation with the given identifier.
", + "refs": { + } + }, + "ReservedDBInstanceList": { + "base": null, + "refs": { + "ReservedDBInstanceMessage$ReservedDBInstances": "A list of reserved DB instances.
" + } + }, + "ReservedDBInstanceMessage": { + "base": "Contains the result of a successful invocation of the DescribeReservedDBInstances action.
", + "refs": { + } + }, + "ReservedDBInstanceNotFoundFault": { + "base": "The specified reserved DB Instance not found.
", + "refs": { + } + }, + "ReservedDBInstanceQuotaExceededFault": { + "base": "Request would exceed the user's DB Instance quota.
", + "refs": { + } + }, + "ReservedDBInstancesOffering": { + "base": "This data type is used as a response element in the DescribeReservedDBInstancesOfferings action.
", + "refs": { + "ReservedDBInstancesOfferingList$member": null + } + }, + "ReservedDBInstancesOfferingList": { + "base": null, + "refs": { + "ReservedDBInstancesOfferingMessage$ReservedDBInstancesOfferings": "A list of reserved DB instance offerings.
" + } + }, + "ReservedDBInstancesOfferingMessage": { + "base": "Contains the result of a successful invocation of the DescribeReservedDBInstancesOfferings action.
", + "refs": { + } + }, + "ReservedDBInstancesOfferingNotFoundFault": { + "base": "Specified offering does not exist.
", + "refs": { + } + }, + "ResetDBParameterGroupMessage": { + "base": "", + "refs": { + } + }, + "RestoreDBInstanceFromDBSnapshotMessage": { + "base": "
", + "refs": { + } + }, + "RestoreDBInstanceFromDBSnapshotResult": { + "base": null, + "refs": { + } + }, + "RestoreDBInstanceToPointInTimeMessage": { + "base": "
", + "refs": { + } + }, + "RestoreDBInstanceToPointInTimeResult": { + "base": null, + "refs": { + } + }, + "RevokeDBSecurityGroupIngressMessage": { + "base": "
", + "refs": { + } + }, + "RevokeDBSecurityGroupIngressResult": { + "base": null, + "refs": { + } + }, + "SNSInvalidTopicFault": { + "base": "
SNS has responded that there is a problem with the SND topic specified.
", + "refs": { + } + }, + "SNSNoAuthorizationFault": { + "base": "You do not have permission to publish to the SNS topic ARN.
", + "refs": { + } + }, + "SNSTopicArnNotFoundFault": { + "base": "The SNS topic ARN does not exist.
", + "refs": { + } + }, + "SnapshotQuotaExceededFault": { + "base": "Request would result in user exceeding the allowed number of DB snapshots.
", + "refs": { + } + }, + "SourceIdsList": { + "base": null, + "refs": { + "CreateEventSubscriptionMessage$SourceIds": "The list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens.
Constraints:
DBInstanceIdentifier must be supplied.DBSecurityGroupName must be supplied.DBParameterGroupName must be supplied.DBSnapshotIdentifier must be supplied.A list of source IDs for the RDS event notification subscription.
" + } + }, + "SourceNotFoundFault": { + "base": "The requested source could not be found.
", + "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 source type for this event.
" + } + }, + "StorageQuotaExceededFault": { + "base": "Request would result in user exceeding the allowed amount of storage available across all DB instances.
", + "refs": { + } + }, + "StorageTypeNotSupportedFault": { + "base": "StorageType specified cannot be associated with the DB Instance.
", + "refs": { + } + }, + "String": { + "base": null, + "refs": { + "AddSourceIdentifierToSubscriptionMessage$SubscriptionName": "The name of the RDS event notification subscription you want to add a source identifier to.
", + "AddSourceIdentifierToSubscriptionMessage$SourceIdentifier": "The identifier of the event source to be added. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens.
Constraints:
DBInstanceIdentifier must be supplied.DBSecurityGroupName must be supplied.DBParameterGroupName must be supplied.DBSnapshotIdentifier must be supplied.The Amazon RDS resource the tags will be added to. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).
", + "AuthorizeDBSecurityGroupIngressMessage$DBSecurityGroupName": "The name of the DB security group to add authorization to.
", + "AuthorizeDBSecurityGroupIngressMessage$CIDRIP": "The IP range to authorize.
", + "AuthorizeDBSecurityGroupIngressMessage$EC2SecurityGroupName": " Name of the EC2 security group to authorize. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
Id of the EC2 security group to authorize. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
AWS Account Number of the owner of the EC2 security group specified in the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
The name of the availability zone.
", + "CharacterSet$CharacterSetName": "The name of the character set.
", + "CharacterSet$CharacterSetDescription": "The description of the character set.
", + "CopyDBParameterGroupMessage$SourceDBParameterGroupIdentifier": "The identifier or ARN for the source DB parameter group.
Constraints:
my-db-param-group, or a valid ARN.arn:aws:rds:us-west-2:123456789012:pg:special-parameters.The identifier for the copied DB parameter group.
Constraints:
Example: my-db-parameter-group
A description for the copied DB parameter group.
", + "CopyDBSnapshotMessage$SourceDBSnapshotIdentifier": "The identifier for the source DB snapshot.
Constraints:
Example: rds:mydb-2012-04-02-00-01
Example: arn:aws:rds:rr-regn-1:123456789012:snapshot:mysql-instance1-snapshot-20130805
The identifier for the copied snapshot.
Constraints:
Example: my-db-snapshot
The identifier or ARN for the source option group.
Constraints:
my-option-group, or a valid ARN.arn:aws:rds:us-west-2:123456789012:og:special-options.The identifier for the copied option group.
Constraints:
Example: my-option-group
The description for the copied option group.
", + "CreateDBInstanceMessage$DBName": "The meaning of this parameter differs according to the database engine you use.
Type: String
MySQL
The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.
Constraints:
PostgreSQL
The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.
Constraints:
Oracle
The Oracle System ID (SID) of the created DB instance.
Default: ORCL
Constraints:
SQL Server
Not applicable. Must be null.
", + "CreateDBInstanceMessage$DBInstanceIdentifier": "The DB instance identifier. This parameter is stored as a lowercase string.
Constraints:
Example: mydbinstance
The compute and memory capacity of the DB instance.
Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium
The name of the database engine to be used for this instance.
Valid Values: MySQL | oracle-se1 | oracle-se | oracle-ee | sqlserver-ee | sqlserver-se | sqlserver-ex | sqlserver-web | postgres
Not every database engine is available for every AWS region.
", + "CreateDBInstanceMessage$MasterUsername": "The name of master user for the client DB instance.
MySQL
Constraints:
Type: String
Oracle
Constraints:
SQL Server
Constraints:
The password for the master database user. Can be any printable ASCII character except \"/\", \"\"\", or \"@\".
Type: String
MySQL
Constraints: Must contain from 8 to 41 characters.
Oracle
Constraints: Must contain from 8 to 30 characters.
SQL Server
Constraints: Must contain from 8 to 128 characters.
", + "CreateDBInstanceMessage$AvailabilityZone": "The EC2 Availability Zone that the database instance will be created in. For information on regions and Availability Zones, see Regions and Availability Zones.
Default: A random, system-chosen Availability Zone in the endpoint's region.
Example: us-east-1d
Constraint: The AvailabilityZone parameter cannot be specified if the MultiAZ parameter is set to true. The specified Availability Zone must be in the same region as the current endpoint.
A DB subnet group to associate with this DB instance.
If there is no DB subnet group, then it is a non-VPC DB instance.
", + "CreateDBInstanceMessage$PreferredMaintenanceWindow": "The weekly time range (in UTC) during which system maintenance can occur. For more information, see DB Instance Maintenance.
Format: ddd:hh24:mi-ddd:hh24:mi
Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
", + "CreateDBInstanceMessage$DBParameterGroupName": "The name of the DB parameter group to associate with this DB instance. If this argument is omitted, the default DBParameterGroup for the specified engine will be used.
Constraints:
The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. For more information, see DB Instance Backups.
Default: A 30-minute window selected at random from an 8-hour block of time per region. See the Amazon RDS User Guide for the time blocks for each region from which the default backup windows are assigned.
Constraints: Must be in the format hh24:mi-hh24:mi. Times should be Universal Time Coordinated (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes.
The version number of the database engine to use.
The following are the database engines and major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS region.
MySQL
5.1.45 | 5.1.49 | 5.1.50 | 5.1.57 | 5.1.61 | 5.1.62 | 5.1.63 | 5.1.69 | 5.1.71 | 5.1.73 5.5.12 | 5.5.20 | 5.5.23 | 5.5.25a | 5.5.27 | 5.5.31 | 5.5.33 | 5.5.37 | 5.5.38 | 5.5.8 5.6.12 | 5.6.13 | 5.6.17 | 5.6.19 | 5.6.21Oracle Database Enterprise Edition (oracle-ee)
11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7 | 11.2.0.3.v1 | 11.2.0.4.v1Oracle Database Standard Edition (oracle-se)
11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7 | 11.2.0.3.v1 | 11.2.0.4.v1Oracle Database Standard Edition One (oracle-se1)
11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7 | 11.2.0.3.v1 | 11.2.0.4.v1PostgreSQL
9.3.1 | 9.3.2 | 9.3.3Microsoft SQL Server Enterprise Edition (sqlserver-ee)
10.50.2789.0.v1 11.00.2100.60.v1Microsoft SQL Server Express Edition (sqlserver-ex)
10.50.2789.0.v1 11.00.2100.60.v1Microsoft SQL Server Standard Edition (sqlserver-se)
10.50.2789.0.v1 11.00.2100.60.v1Microsoft SQL Server Web Edition (sqlserver-web)
10.50.2789.0.v1 11.00.2100.60.v1License model information for this DB instance.
Valid values: license-included | bring-your-own-license | general-public-license
Indicates that the DB instance should be associated with the specified option group.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
", + "CreateDBInstanceMessage$CharacterSetName": "For supported engines, indicates that the DB instance should be associated with the specified CharacterSet.
", + "CreateDBInstanceMessage$StorageType": "Specifies storage type to be associated with the DB Instance.
Valid values: standard | gp2 | io1
If you specify io1, you must also include a value for the Iops parameter.
Default: io1 if the Iops parameter is specified; otherwise standard
The ARN from the Key Store with which to associate the instance for TDE encryption.
", + "CreateDBInstanceMessage$TdeCredentialPassword": "The password for the given ARN from the Key Store in order to access the device.
", + "CreateDBInstanceReadReplicaMessage$DBInstanceIdentifier": "The DB instance identifier of the Read Replica. This is the unique key that identifies a DB instance. This parameter is stored as a lowercase string.
", + "CreateDBInstanceReadReplicaMessage$SourceDBInstanceIdentifier": "The identifier of the DB instance that will act as the source for the Read Replica. Each DB instance can have up to five Read Replicas.
Constraints:
The compute and memory capacity of the Read Replica.
Valid Values: db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium
Default: Inherits from the source DB instance.
", + "CreateDBInstanceReadReplicaMessage$AvailabilityZone": "The Amazon EC2 Availability Zone that the Read Replica will be created in.
Default: A random, system-chosen Availability Zone in the endpoint's region.
Example: us-east-1d
The option group the DB instance will be associated with. If omitted, the default option group for the engine specified will be used.
", + "CreateDBInstanceReadReplicaMessage$DBSubnetGroupName": "Specifies a DB subnet group for the DB instance. The new DB instance will be created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance is not created in a VPC.
Constraints:
Specifies storage type to be associated with the DB Instance Read Replica.
Valid values: standard | gp2 | io1
If you specify io1, you must also include a value for the Iops parameter.
Default: io1 if the Iops parameter is specified; otherwise standard
The name of the DB parameter group.
Constraints:
The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family.
", + "CreateDBParameterGroupMessage$Description": "The description for the DB parameter group.
", + "CreateDBSecurityGroupMessage$DBSecurityGroupName": "The name for the DB security group. This value is stored as a lowercase string.
Constraints:
Example: mysecuritygroup
The description for the DB security group.
", + "CreateDBSnapshotMessage$DBSnapshotIdentifier": "The identifier for the DB snapshot.
Constraints:
Example: my-snapshot-id
The DB instance identifier. This is the unique key that identifies a DB instance.
Constraints:
The name for the DB subnet group. This value is stored as a lowercase string.
Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Must not be \"Default\".
Example: mySubnetgroup
The description for the DB subnet group.
", + "CreateEventSubscriptionMessage$SubscriptionName": "The name of the subscription.
Constraints: The name must be less than 255 characters.
", + "CreateEventSubscriptionMessage$SnsTopicArn": "The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.
", + "CreateEventSubscriptionMessage$SourceType": "The type of source that will be generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned.
Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot
", + "CreateOptionGroupMessage$OptionGroupName": "Specifies the name of the option group to be created.
Constraints:
Example: myoptiongroup
Specifies the name of the engine that this option group should be associated with.
", + "CreateOptionGroupMessage$MajorEngineVersion": "Specifies the major version of the engine that this option group should be associated with.
", + "CreateOptionGroupMessage$OptionGroupDescription": "The description of the option group.
", + "DBEngineVersion$Engine": "The name of the database engine.
", + "DBEngineVersion$EngineVersion": "The version number of the database engine.
", + "DBEngineVersion$DBParameterGroupFamily": "The name of the DB parameter group family for the database engine.
", + "DBEngineVersion$DBEngineDescription": "The description of the database engine.
", + "DBEngineVersion$DBEngineVersionDescription": "The description of the database engine version.
", + "DBEngineVersionMessage$Marker": " An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
Contains a user-supplied database identifier. This is the unique key that identifies a DB instance.
", + "DBInstance$DBInstanceClass": "Contains the name of the compute and memory capacity class of the DB instance.
", + "DBInstance$Engine": "Provides the name of the database engine to be used for this DB instance.
", + "DBInstance$DBInstanceStatus": "Specifies the current state of this database.
", + "DBInstance$MasterUsername": "Contains the master username for the DB instance.
", + "DBInstance$DBName": "The meaning of this parameter differs according to the database engine you use. For example, this value returns either MySQL or PostgreSQL information when returning values from CreateDBInstanceReadReplica since Read Replicas are only supported for MySQL and PostgreSQL.
MySQL, SQL Server, PostgreSQL
Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.
Type: String
Oracle
Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.
", + "DBInstance$PreferredBackupWindow": " Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
Specifies the name of the Availability Zone the DB instance is located in.
", + "DBInstance$PreferredMaintenanceWindow": "Specifies the weekly time range (in UTC) during which system maintenance can occur.
", + "DBInstance$EngineVersion": "Indicates the database engine version.
", + "DBInstance$ReadReplicaSourceDBInstanceIdentifier": "Contains the identifier of the source DB instance if this DB instance is a Read Replica.
", + "DBInstance$LicenseModel": "License model information for this DB instance.
", + "DBInstance$CharacterSetName": "If present, specifies the name of the character set that this instance is associated with.
", + "DBInstance$SecondaryAvailabilityZone": "If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
", + "DBInstance$StorageType": "Specifies storage type associated with DB Instance.
", + "DBInstance$TdeCredentialArn": "The ARN from the Key Store with which the instance is associated for TDE encryption.
", + "DBInstanceMessage$Marker": " An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
This value is currently \"read replication.\"
", + "DBInstanceStatusInfo$Status": "Status of the DB instance. For a StatusType of read replica, the values can be replicating, error, stopped, or terminated.
", + "DBInstanceStatusInfo$Message": "Details of the error if there is an error for the instance. If the instance is not in an error state, this value is blank.
", + "DBParameterGroup$DBParameterGroupName": "Provides the name of the DB parameter group.
", + "DBParameterGroup$DBParameterGroupFamily": "Provides the name of the DB parameter group family that this DB parameter group is compatible with.
", + "DBParameterGroup$Description": "Provides the customer-specified description for this DB parameter group.
", + "DBParameterGroupDetails$Marker": " An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of the DB parameter group.
", + "DBParameterGroupStatus$DBParameterGroupName": "The name of the DP parameter group.
", + "DBParameterGroupStatus$ParameterApplyStatus": "The status of parameter updates.
", + "DBParameterGroupsMessage$Marker": " An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
Provides the AWS ID of the owner of a specific DB security group.
", + "DBSecurityGroup$DBSecurityGroupName": "Specifies the name of the DB security group.
", + "DBSecurityGroup$DBSecurityGroupDescription": "Provides the description of the DB security group.
", + "DBSecurityGroup$VpcId": "Provides the VpcId of the DB security group.
", + "DBSecurityGroupMembership$DBSecurityGroupName": "The name of the DB security group.
", + "DBSecurityGroupMembership$Status": "The status of the DB security group.
", + "DBSecurityGroupMessage$Marker": " An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
Specifies the identifier for the DB snapshot.
", + "DBSnapshot$DBInstanceIdentifier": "Specifies the DB instance identifier of the DB instance this DB snapshot was created from.
", + "DBSnapshot$Engine": "Specifies the name of the database engine.
", + "DBSnapshot$Status": "Specifies the status of this DB snapshot.
", + "DBSnapshot$AvailabilityZone": "Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
", + "DBSnapshot$VpcId": "Provides the Vpc Id associated with the DB snapshot.
", + "DBSnapshot$MasterUsername": "Provides the master username for the DB snapshot.
", + "DBSnapshot$EngineVersion": "Specifies the version of the database engine.
", + "DBSnapshot$LicenseModel": "License model information for the restored DB instance.
", + "DBSnapshot$SnapshotType": "Provides the type of the DB snapshot.
", + "DBSnapshot$OptionGroupName": "Provides the option group name for the DB snapshot.
", + "DBSnapshot$SourceRegion": "The region that the DB snapshot was created in or copied from.
", + "DBSnapshot$StorageType": "Specifies storage type associated with DB Snapshot.
", + "DBSnapshot$TdeCredentialArn": "The ARN from the Key Store with which to associate the instance for TDE encryption.
", + "DBSnapshotMessage$Marker": " An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
Specifies the name of the DB subnet group.
", + "DBSubnetGroup$DBSubnetGroupDescription": "Provides the description of the DB subnet group.
", + "DBSubnetGroup$VpcId": "Provides the VpcId of the DB subnet group.
", + "DBSubnetGroup$SubnetGroupStatus": "Provides the status of the DB subnet group.
", + "DBSubnetGroupMessage$Marker": " An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The DB instance identifier for the DB instance to be deleted. This parameter isn't case sensitive.
Constraints:
The DBSnapshotIdentifier of the new DBSnapshot created when SkipFinalSnapshot is set to false.
Constraints:
The name of the DB parameter group.
Constraints:
The name of the DB security group to delete.
Constraints:
The DBSnapshot identifier.
Constraints: Must be the name of an existing DB snapshot in the available state.
The name of the database subnet group to delete.
Constraints:
The name of the RDS event notification subscription you want to delete.
", + "DeleteOptionGroupMessage$OptionGroupName": "The name of the option group to be deleted.
The database engine to return.
", + "DescribeDBEngineVersionsMessage$EngineVersion": "The database engine version to return.
Example: 5.1.49
The name of a specific DB parameter group family to return details for.
Constraints:
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The user-supplied instance identifier. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn't case sensitive.
Constraints:
An optional pagination token provided by a previous DescribeDBInstances request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
The name of the log file for the specified DB instance.
", + "DescribeDBLogFilesMessage$DBInstanceIdentifier": "The customer-assigned name of the DB instance that contains the log files you want to list.
Constraints:
Filters the available log files for log file names that contain the specified string.
", + "DescribeDBLogFilesMessage$Marker": "The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.
", + "DescribeDBLogFilesResponse$Marker": "A pagination token that can be used in a subsequent DescribeDBLogFiles request.
", + "DescribeDBParameterGroupsMessage$DBParameterGroupName": "The name of a specific DB parameter group to return details for.
Constraints:
An optional pagination token provided by a previous DescribeDBParameterGroups request. 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 DB parameter group to return details for.
Constraints:
The parameter types to return.
Default: All parameter types returned
Valid Values: user | system | engine-default
An optional pagination token provided by a previous DescribeDBParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of the DB security group to return details for.
", + "DescribeDBSecurityGroupsMessage$Marker": " An optional pagination token provided by a previous DescribeDBSecurityGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
A DB instance identifier to retrieve the list of DB snapshots for. Cannot be used in conjunction with DBSnapshotIdentifier. This parameter is not case sensitive.
Constraints:
A specific DB snapshot identifier to describe. Cannot be used in conjunction with DBInstanceIdentifier. This value is stored as a lowercase string.
Constraints:
SnapshotType parameter must also be specified.The type of snapshots that will be returned. Values can be \"automated\" or \"manual.\" If not specified, the returned results will include all snapshots types.
", + "DescribeDBSnapshotsMessage$Marker": " An optional pagination token provided by a previous DescribeDBSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of the DB subnet group to return details for.
", + "DescribeDBSubnetGroupsMessage$Marker": " An optional pagination token provided by a previous DescribeDBSubnetGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of the DB parameter group family.
", + "DescribeEngineDefaultParametersMessage$Marker": " An optional pagination token provided by a previous DescribeEngineDefaultParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The type of source that will be generating the events.
Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot
", + "DescribeEventSubscriptionsMessage$SubscriptionName": "The name of the RDS event notification subscription you want to describe.
", + "DescribeEventSubscriptionsMessage$Marker": " An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. 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 will be returned. If not specified, then all sources are included in the response.
Constraints:
DBInstance, then a DBInstanceIdentifier must be supplied.DBSecurityGroup, a DBSecurityGroupName must be supplied.DBParameterGroup, a DBParameterGroupName must be supplied.DBSnapshot, a DBSnapshotIdentifier must be supplied. An optional pagination token provided by a previous DescribeEvents request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
A required parameter. Options available for the given Engine name will be described.
", + "DescribeOptionGroupOptionsMessage$MajorEngineVersion": "If specified, filters the results to include only options for the specified major engine version.
", + "DescribeOptionGroupOptionsMessage$Marker": "An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of the option group to describe. Cannot be supplied together with EngineName or MajorEngineVersion.
", + "DescribeOptionGroupsMessage$Marker": " An optional pagination token provided by a previous DescribeOptionGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
Filters the list of option groups to only include groups associated with a specific database engine.
", + "DescribeOptionGroupsMessage$MajorEngineVersion": "Filters the list of option groups to only include groups associated with a specific database engine version. If specified, then EngineName must also be specified.
", + "DescribeOrderableDBInstanceOptionsMessage$Engine": "The name of the engine to retrieve DB instance options for.
", + "DescribeOrderableDBInstanceOptionsMessage$EngineVersion": "The engine version filter value. Specify this parameter to show only the available offerings matching the specified engine version.
", + "DescribeOrderableDBInstanceOptionsMessage$DBInstanceClass": "The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.
", + "DescribeOrderableDBInstanceOptionsMessage$LicenseModel": "The license model filter value. Specify this parameter to show only the available offerings matching the specified license model.
", + "DescribeOrderableDBInstanceOptionsMessage$Marker": " An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID.
", + "DescribeReservedDBInstancesMessage$ReservedDBInstancesOfferingId": "The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.
", + "DescribeReservedDBInstancesMessage$DBInstanceClass": "The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class.
", + "DescribeReservedDBInstancesMessage$Duration": "The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.
Valid Values: 1 | 3 | 31536000 | 94608000
The product description filter value. Specify this parameter to show only those reservations matching the specified product description.
", + "DescribeReservedDBInstancesMessage$OfferingType": "The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.
Valid Values: \"Light Utilization\" | \"Medium Utilization\" | \"Heavy Utilization\"
An optional pagination token provided by a previous request. 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. Specify this parameter to show only the available offering that matches the specified reservation identifier.
Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.
", + "DescribeReservedDBInstancesOfferingsMessage$Duration": "Duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.
Valid Values: 1 | 3 | 31536000 | 94608000
Product description filter value. Specify this parameter to show only the available offerings matching the specified product description.
", + "DescribeReservedDBInstancesOfferingsMessage$OfferingType": "The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.
Valid Values: \"Light Utilization\" | \"Medium Utilization\" | \"Heavy Utilization\"
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
Entries from the specified log file.
", + "DownloadDBLogFilePortionDetails$Marker": "A pagination token that can be used in a subsequent DownloadDBLogFilePortion request.
", + "DownloadDBLogFilePortionMessage$DBInstanceIdentifier": "The customer-assigned name of the DB instance that contains the log files you want to list.
Constraints:
The name of the log file to be downloaded.
", + "DownloadDBLogFilePortionMessage$Marker": "The pagination token provided in the previous request or \"0\". If the Marker parameter is specified the response includes only records beyond the marker until the end of the file or up to NumberOfLines.
", + "EC2SecurityGroup$Status": "Provides the status of the EC2 security group. Status can be \"authorizing\", \"authorized\", \"revoking\", and \"revoked\".
", + "EC2SecurityGroup$EC2SecurityGroupName": "Specifies the name of the EC2 security group.
", + "EC2SecurityGroup$EC2SecurityGroupId": "Specifies the id of the EC2 security group.
", + "EC2SecurityGroup$EC2SecurityGroupOwnerId": " Specifies the AWS ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field.
Specifies the DNS address of the DB instance.
", + "EngineDefaults$DBParameterGroupFamily": "Specifies the name of the DB parameter group family which the engine default parameters apply to.
", + "EngineDefaults$Marker": " An optional pagination token provided by a previous EngineDefaults request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
Provides the identifier for the source of the event.
", + "Event$Message": "Provides the text of this event.
", + "EventCategoriesList$member": null, + "EventCategoriesMap$SourceType": "The source type that the returned categories belong to
", + "EventSubscription$CustomerAwsId": "The AWS customer account associated with the RDS event notification subscription.
", + "EventSubscription$CustSubscriptionId": "The RDS event notification subscription Id.
", + "EventSubscription$SnsTopicArn": "The topic ARN of the RDS event notification subscription.
", + "EventSubscription$Status": "The status of the RDS event notification subscription.
Constraints:
Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist
The status \"no-permission\" indicates that RDS no longer has permission to post to the SNS topic. The status \"topic-not-exist\" indicates that the topic was deleted after the subscription was created.
", + "EventSubscription$SubscriptionCreationTime": "The time the RDS event notification subscription was created.
", + "EventSubscription$SourceType": "The source type for the RDS event notification subscription.
", + "EventSubscriptionsMessage$Marker": " An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
An optional pagination token provided by a previous Events request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
This parameter is not currently supported.
", + "FilterValueList$member": null, + "IPRange$Status": "Specifies the status of the IP range. Status can be \"authorizing\", \"authorized\", \"revoking\", and \"revoked\".
", + "IPRange$CIDRIP": "Specifies the IP range.
", + "KeyList$member": null, + "ListTagsForResourceMessage$ResourceName": "The Amazon RDS resource with tags to be listed. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).
", + "ModifyDBInstanceMessage$DBInstanceIdentifier": "The DB instance identifier. This value is stored as a lowercase string.
Constraints:
The new compute and memory capacity of the DB instance. To determine the instance classes that are available for a particular DB engine, use the DescribeOrderableDBInstanceOptions action.
Passing a value for this setting causes an outage during the change and is applied during the next maintenance window, unless ApplyImmediately is specified as true for this request.
Default: Uses existing setting
Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge | db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium
The new password for the DB instance master user. Can be any printable ASCII character except \"/\", \"\"\", or \"@\".
Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.
Default: Uses existing setting
Constraints: Must be 8 to 41 alphanumeric characters (MySQL), 8 to 30 alphanumeric characters (Oracle), or 8 to 128 alphanumeric characters (SQL Server).
The name of the DB parameter group to apply to the DB instance. Changing this setting does not result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. The db instance will NOT be rebooted automatically and the parameter changes will NOT be applied during the next maintenance window.
Default: Uses existing setting
Constraints: The DB parameter group must be in the same DB parameter group family as this DB instance.
", + "ModifyDBInstanceMessage$PreferredBackupWindow": " The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.
Constraints:
The weekly time range (in UTC) during which system maintenance can occur, which may result in an outage. Changing this parameter does not result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, then changing this parameter will cause a reboot of the DB instance. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied.
Default: Uses existing setting
Format: ddd:hh24:mi-ddd:hh24:mi
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Must be at least 30 minutes
", + "ModifyDBInstanceMessage$EngineVersion": " The version number of the database engine to upgrade to. Changing this parameter results in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.
For major version upgrades, if a non-default DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family.
For a list of valid engine versions, see CreateDBInstance.
", + "ModifyDBInstanceMessage$OptionGroupName": " Indicates that the DB instance should be associated with the specified option group. Changing this parameter does not result in an outage except in the following case and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
", + "ModifyDBInstanceMessage$NewDBInstanceIdentifier": " The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot will occur immediately if you set Apply Immediately to true, or will occur during the next maintenance window if Apply Immediately to false. This value is stored as a lowercase string.
Constraints:
Specifies storage type to be associated with the DB Instance.
Valid values: standard | gp2 | io1
If you specify io1, you must also include a value for the Iops parameter.
Default: io1 if the Iops parameter is specified; otherwise standard
The ARN from the Key Store with which to associate the instance for TDE encryption.
", + "ModifyDBInstanceMessage$TdeCredentialPassword": "The password for the given ARN from the Key Store in order to access the device.
", + "ModifyDBParameterGroupMessage$DBParameterGroupName": "The name of the DB parameter group.
Constraints:
The name for the DB subnet group. This value is stored as a lowercase string.
Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Must not be \"Default\".
Example: mySubnetgroup
The description for the DB subnet group.
", + "ModifyEventSubscriptionMessage$SubscriptionName": "The name of the RDS event notification subscription.
", + "ModifyEventSubscriptionMessage$SnsTopicArn": "The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.
", + "ModifyEventSubscriptionMessage$SourceType": "The type of source that will be generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned.
Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot
", + "ModifyOptionGroupMessage$OptionGroupName": "The name of the option group to be modified.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
", + "Option$OptionName": "The name of the option.
", + "Option$OptionDescription": "The description of the option.
", + "OptionConfiguration$OptionName": "The configuration of options to include in a group.
", + "OptionGroup$OptionGroupName": "Specifies the name of the option group.
", + "OptionGroup$OptionGroupDescription": "Provides a description of the option group.
", + "OptionGroup$EngineName": "Engine name that this option group can be applied to.
", + "OptionGroup$MajorEngineVersion": "Indicates the major engine version associated with this option group.
", + "OptionGroup$VpcId": "If AllowsVpcAndNonVpcInstanceMemberships is false, this field is blank. If AllowsVpcAndNonVpcInstanceMemberships is true and this field is blank, then this option group can be applied to both VPC and non-VPC instances. If this field contains a value, then this option group can only be applied to instances that are in the VPC indicated by this field.
The name of the option group that the instance belongs to.
", + "OptionGroupMembership$Status": "The status of the DB instance's option group membership (e.g. in-sync, pending, pending-maintenance, applying).
", + "OptionGroupOption$Name": "The name of the option.
", + "OptionGroupOption$Description": "The description of the option.
", + "OptionGroupOption$EngineName": "The name of the engine that this option can be applied to.
", + "OptionGroupOption$MajorEngineVersion": "Indicates the major engine version that the option is available for.
", + "OptionGroupOption$MinimumRequiredMinorEngineVersion": "The minimum required engine version for the option to be applied.
", + "OptionGroupOptionSetting$SettingName": "The name of the option group option.
", + "OptionGroupOptionSetting$SettingDescription": "The description of the option group option.
", + "OptionGroupOptionSetting$DefaultValue": "The default value for the option group option.
", + "OptionGroupOptionSetting$ApplyType": "The DB engine specific parameter type for the option group option.
", + "OptionGroupOptionSetting$AllowedValues": "Indicates the acceptable values for the option group option.
", + "OptionGroupOptionsMessage$Marker": "An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of the option that has settings that you can set.
", + "OptionSetting$Value": "The current value of the option setting.
", + "OptionSetting$DefaultValue": "The default value of the option setting.
", + "OptionSetting$Description": "The description of the option setting.
", + "OptionSetting$ApplyType": "The DB engine specific parameter type.
", + "OptionSetting$DataType": "The data type of the option setting.
", + "OptionSetting$AllowedValues": "The allowed values of the option setting.
", + "OptionsDependedOn$member": null, + "OrderableDBInstanceOption$Engine": "The engine type of the orderable DB instance.
", + "OrderableDBInstanceOption$EngineVersion": "The engine version of the orderable DB instance.
", + "OrderableDBInstanceOption$DBInstanceClass": "The DB instance Class for the orderable DB instance
", + "OrderableDBInstanceOption$LicenseModel": "The license model for the orderable DB instance.
", + "OrderableDBInstanceOption$StorageType": "The storage type for this orderable DB instance.
", + "OrderableDBInstanceOptionsMessage$Marker": " An optional pagination token provided by a previous OrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
Specifies the name of the parameter.
", + "Parameter$ParameterValue": "Specifies the value of the parameter.
", + "Parameter$Description": "Provides a description of the parameter.
", + "Parameter$Source": "Indicates the source of the parameter value.
", + "Parameter$ApplyType": "Specifies the engine specific parameters type.
", + "Parameter$DataType": "Specifies the valid data type for the parameter.
", + "Parameter$AllowedValues": "Specifies the valid range of values for the parameter.
", + "Parameter$MinimumEngineVersion": "The earliest engine version to which the parameter can apply.
", + "PendingModifiedValues$DBInstanceClass": " Contains the new DBInstanceClass for the DB instance that will be applied or is in progress.
Contains the pending or in-progress change of the master credentials for the DB instance.
", + "PendingModifiedValues$EngineVersion": "Indicates the database engine version.
", + "PendingModifiedValues$DBInstanceIdentifier": " Contains the new DBInstanceIdentifier for the DB instance that will be applied or is in progress.
Specifies storage type to be associated with the DB instance.
", + "PromoteReadReplicaMessage$DBInstanceIdentifier": "The DB instance identifier. This value is stored as a lowercase string.
Constraints:
Example:
The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.
Default: A 30-minute window selected at random from an 8-hour block of time per region. See the Amazon RDS User Guide for the time blocks for each region from which the default backup windows are assigned.
Constraints: Must be in the format hh24:mi-hh24:mi. Times should be Universal Time Coordinated (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes.
The ID of the Reserved DB instance offering to purchase.
Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
", + "PurchaseReservedDBInstancesOfferingMessage$ReservedDBInstanceId": "Customer-specified identifier to track this reservation.
Example: myreservationID
", + "ReadReplicaDBInstanceIdentifierList$member": null, + "RebootDBInstanceMessage$DBInstanceIdentifier": "The DB instance identifier. This parameter is stored as a lowercase string.
Constraints:
The frequency of the recurring charge.
", + "RemoveSourceIdentifierFromSubscriptionMessage$SubscriptionName": "The name of the RDS event notification subscription you want to remove a source identifier from.
", + "RemoveSourceIdentifierFromSubscriptionMessage$SourceIdentifier": "The source identifier to be removed from the subscription, such as the DB instance identifier for a DB instance or the name of a security group.
", + "RemoveTagsFromResourceMessage$ResourceName": "The Amazon RDS resource the tags will be removed from. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).
", + "ReservedDBInstance$ReservedDBInstanceId": "The unique identifier for the reservation.
", + "ReservedDBInstance$ReservedDBInstancesOfferingId": "The offering identifier.
", + "ReservedDBInstance$DBInstanceClass": "The DB instance class for the reserved DB instance.
", + "ReservedDBInstance$CurrencyCode": "The currency code for the reserved DB instance.
", + "ReservedDBInstance$ProductDescription": "The description of the reserved DB instance.
", + "ReservedDBInstance$OfferingType": "The offering type of this reserved DB instance.
", + "ReservedDBInstance$State": "The state of the reserved DB instance.
", + "ReservedDBInstanceMessage$Marker": " An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The offering identifier.
", + "ReservedDBInstancesOffering$DBInstanceClass": "The DB instance class for the reserved DB instance.
", + "ReservedDBInstancesOffering$CurrencyCode": "The currency code for the reserved DB instance offering.
", + "ReservedDBInstancesOffering$ProductDescription": "The database engine used by the offering.
", + "ReservedDBInstancesOffering$OfferingType": "The offering type.
", + "ReservedDBInstancesOfferingMessage$Marker": " An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of the DB parameter group.
Constraints:
Name of the DB instance to create from the DB snapshot. This parameter isn't case sensitive.
Constraints:
Example: my-snapshot-id
The identifier for the DB snapshot to restore from.
Constraints:
The compute and memory capacity of the Amazon RDS DB instance.
Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium
The EC2 Availability Zone that the database instance will be created in.
Default: A random, system-chosen Availability Zone.
Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.
Example: us-east-1a
The DB subnet group name to use for the new instance.
", + "RestoreDBInstanceFromDBSnapshotMessage$LicenseModel": "License model information for the restored DB instance.
Default: Same as source.
Valid values: license-included | bring-your-own-license | general-public-license
The database name for the restored DB instance.
This parameter doesn't apply to the MySQL engine.
The database engine to use for the new instance.
Default: The same as source
Constraint: Must be compatible with the engine of the source
Valid Values: MySQL | oracle-se1 | oracle-se | oracle-ee | sqlserver-ee | sqlserver-se | sqlserver-ex | sqlserver-web | postgres
The name of the option group to be used for the restored DB instance.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
", + "RestoreDBInstanceFromDBSnapshotMessage$StorageType": "Specifies storage type to be associated with the DB Instance.
Valid values: standard | gp2 | io1
If you specify io1, you must also include a value for the Iops parameter.
Default: io1 if the Iops parameter is specified; otherwise standard
The ARN from the Key Store with which to associate the instance for TDE encryption.
", + "RestoreDBInstanceFromDBSnapshotMessage$TdeCredentialPassword": "The password for the given ARN from the Key Store in order to access the device.
", + "RestoreDBInstanceToPointInTimeMessage$SourceDBInstanceIdentifier": "The identifier of the source DB instance from which to restore.
Constraints:
The name of the new database instance to be created.
Constraints:
The compute and memory capacity of the Amazon RDS DB instance.
Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium
Default: The same DBInstanceClass as the original DB instance.
", + "RestoreDBInstanceToPointInTimeMessage$AvailabilityZone": "The EC2 Availability Zone that the database instance will be created in.
Default: A random, system-chosen Availability Zone.
Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.
Example: us-east-1a
The DB subnet group name to use for the new instance.
", + "RestoreDBInstanceToPointInTimeMessage$LicenseModel": "License model information for the restored DB instance.
Default: Same as source.
Valid values: license-included | bring-your-own-license | general-public-license
The database name for the restored DB instance.
This parameter is not used for the MySQL engine.
The database engine to use for the new instance.
Default: The same as source
Constraint: Must be compatible with the engine of the source
Valid Values: MySQL | oracle-se1 | oracle-se | oracle-ee | sqlserver-ee | sqlserver-se | sqlserver-ex | sqlserver-web | postgres
The name of the option group to be used for the restored DB instance.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
", + "RestoreDBInstanceToPointInTimeMessage$StorageType": "Specifies storage type to be associated with the DB Instance.
Valid values: standard | gp2 | io1
If you specify io1, you must also include a value for the Iops parameter.
Default: io1 if the Iops parameter is specified; otherwise standard
The ARN from the Key Store with which to associate the instance for TDE encryption.
", + "RestoreDBInstanceToPointInTimeMessage$TdeCredentialPassword": "The password for the given ARN from the Key Store in order to access the device.
", + "RevokeDBSecurityGroupIngressMessage$DBSecurityGroupName": "The name of the DB security group to revoke ingress from.
", + "RevokeDBSecurityGroupIngressMessage$CIDRIP": " The IP range to revoke access from. Must be a valid CIDR range. If CIDRIP is specified, EC2SecurityGroupName, EC2SecurityGroupId and EC2SecurityGroupOwnerId cannot be provided.
The name of the EC2 security group to revoke access from. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
The id of the EC2 security group to revoke access from. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
The AWS Account Number of the owner of the EC2 security group specified in the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
Specifies the identifier of the subnet.
", + "Subnet$SubnetStatus": "Specifies the status of the subnet.
", + "SubnetIdentifierList$member": null, + "Tag$Key": "A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and cannot be prefixed with \"aws:\" or \"rds:\". The string may only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").
", + "Tag$Value": "A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and cannot be prefixed with \"aws:\" or \"rds:\". The string may only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").
", + "VpcSecurityGroupIdList$member": null, + "VpcSecurityGroupMembership$VpcSecurityGroupId": "The name of the VPC security group.
", + "VpcSecurityGroupMembership$Status": "The status of the VPC security group.
" + } + }, + "Subnet": { + "base": "This data type is used as a response element in the DescribeDBSubnetGroups action.
", + "refs": { + "SubnetList$member": null + } + }, + "SubnetAlreadyInUse": { + "base": "The DB subnet is already in use in the Availability Zone.
", + "refs": { + } + }, + "SubnetIdentifierList": { + "base": null, + "refs": { + "CreateDBSubnetGroupMessage$SubnetIds": "The EC2 Subnet IDs for the DB subnet group.
", + "ModifyDBSubnetGroupMessage$SubnetIds": "The EC2 subnet IDs for the DB subnet group.
" + } + }, + "SubnetList": { + "base": null, + "refs": { + "DBSubnetGroup$Subnets": "Contains a list of Subnet elements.
" + } + }, + "SubscriptionAlreadyExistFault": { + "base": "The supplied subscription name already exists.
", + "refs": { + } + }, + "SubscriptionCategoryNotFoundFault": { + "base": "The supplied category does not exist.
", + "refs": { + } + }, + "SubscriptionNotFoundFault": { + "base": "The subscription name does not exist.
", + "refs": { + } + }, + "SupportedCharacterSetsList": { + "base": null, + "refs": { + "DBEngineVersion$SupportedCharacterSets": " A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance API.
Provides the date and time the DB instance was created.
", + "DBInstance$LatestRestorableTime": "Specifies the latest time to which a database can be restored with point-in-time restore.
", + "DBSnapshot$SnapshotCreateTime": "Provides the time (UTC) when the snapshot was taken.
", + "DBSnapshot$InstanceCreateTime": "Specifies the time (UTC) when the snapshot was taken.
", + "DescribeEventsMessage$StartTime": "The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2009-07-08T18:00Z
", + "DescribeEventsMessage$EndTime": "The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2009-07-08T18:00Z
", + "Event$Date": "Specifies the date and time of the event.
", + "ReservedDBInstance$StartTime": "The time the reservation started.
", + "RestoreDBInstanceToPointInTimeMessage$RestoreTime": "The date and time to restore from.
Valid Values: Value must be a UTC time
Constraints:
Example: 2009-09-07T23:45:00Z
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
", + "refs": { + "TagList$member": null + } + }, + "TagList": { + "base": "A list of tags.
", + "refs": { + "AddTagsToResourceMessage$Tags": "The tags to be assigned to the Amazon RDS resource.
", + "CopyDBParameterGroupMessage$Tags": null, + "CopyDBSnapshotMessage$Tags": null, + "CopyOptionGroupMessage$Tags": null, + "CreateDBInstanceMessage$Tags": null, + "CreateDBInstanceReadReplicaMessage$Tags": null, + "CreateDBParameterGroupMessage$Tags": null, + "CreateDBSecurityGroupMessage$Tags": null, + "CreateDBSnapshotMessage$Tags": null, + "CreateDBSubnetGroupMessage$Tags": null, + "CreateEventSubscriptionMessage$Tags": null, + "CreateOptionGroupMessage$Tags": null, + "PurchaseReservedDBInstancesOfferingMessage$Tags": null, + "RestoreDBInstanceFromDBSnapshotMessage$Tags": null, + "RestoreDBInstanceToPointInTimeMessage$Tags": null, + "TagListMessage$TagList": "List of tags returned by the ListTagsForResource operation.
" + } + }, + "TagListMessage": { + "base": "", + "refs": { + } + }, + "VpcSecurityGroupIdList": { + "base": null, + "refs": { + "CreateDBInstanceMessage$VpcSecurityGroupIds": "A list of EC2 VPC security groups to associate with this DB instance.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
", + "ModifyDBInstanceMessage$VpcSecurityGroupIds": "A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible.
Constraints:
A list of VpcSecurityGroupMemebrship name strings used for this option.
" + } + }, + "VpcSecurityGroupMembership": { + "base": "This data type is used as a response element for queries on VPC security group membership.
", + "refs": { + "VpcSecurityGroupMembershipList$member": null + } + }, + "VpcSecurityGroupMembershipList": { + "base": null, + "refs": { + "DBInstance$VpcSecurityGroups": "Provides List of VPC security group elements that the DB instance belongs to.
", + "Option$VpcSecurityGroupMemberships": "If the option requires access to a port, then this VPC security group allows access to the port.
" + } + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/rds/2014-09-01/examples-1.json b/vendor/github.com/aws/aws-sdk-go/models/apis/rds/2014-09-01/examples-1.json new file mode 100644 index 000000000..0ea7e3b0b --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/rds/2014-09-01/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/rds/2014-10-31/api-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/rds/2014-10-31/api-2.json new file mode 100644 index 000000000..ba34a1b94 --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/rds/2014-10-31/api-2.json @@ -0,0 +1,4720 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2014-10-31", + "endpointPrefix":"rds", + "protocol":"query", + "serviceAbbreviation":"Amazon RDS", + "serviceFullName":"Amazon Relational Database Service", + "signatureVersion":"v4", + "xmlNamespace":"http://rds.amazonaws.com/doc/2014-10-31/" + }, + "operations":{ + "AddSourceIdentifierToSubscription":{ + "name":"AddSourceIdentifierToSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddSourceIdentifierToSubscriptionMessage"}, + "output":{ + "shape":"AddSourceIdentifierToSubscriptionResult", + "resultWrapper":"AddSourceIdentifierToSubscriptionResult" + }, + "errors":[ + {"shape":"SubscriptionNotFoundFault"}, + {"shape":"SourceNotFoundFault"} + ] + }, + "AddTagsToResource":{ + "name":"AddTagsToResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddTagsToResourceMessage"}, + "errors":[ + {"shape":"DBInstanceNotFoundFault"}, + {"shape":"DBSnapshotNotFoundFault"} + ] + }, + "ApplyPendingMaintenanceAction":{ + "name":"ApplyPendingMaintenanceAction", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ApplyPendingMaintenanceActionMessage"}, + "output":{ + "shape":"ApplyPendingMaintenanceActionResult", + "resultWrapper":"ApplyPendingMaintenanceActionResult" + }, + "errors":[ + {"shape":"ResourceNotFoundFault"} + ] + }, + "AuthorizeDBSecurityGroupIngress":{ + "name":"AuthorizeDBSecurityGroupIngress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AuthorizeDBSecurityGroupIngressMessage"}, + "output":{ + "shape":"AuthorizeDBSecurityGroupIngressResult", + "resultWrapper":"AuthorizeDBSecurityGroupIngressResult" + }, + "errors":[ + {"shape":"DBSecurityGroupNotFoundFault"}, + {"shape":"InvalidDBSecurityGroupStateFault"}, + {"shape":"AuthorizationAlreadyExistsFault"}, + {"shape":"AuthorizationQuotaExceededFault"} + ] + }, + "CopyDBClusterSnapshot":{ + "name":"CopyDBClusterSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CopyDBClusterSnapshotMessage"}, + "output":{ + "shape":"CopyDBClusterSnapshotResult", + "resultWrapper":"CopyDBClusterSnapshotResult" + }, + "errors":[ + {"shape":"DBClusterSnapshotAlreadyExistsFault"}, + {"shape":"DBClusterSnapshotNotFoundFault"}, + {"shape":"InvalidDBClusterStateFault"} + ] + }, + "CopyDBParameterGroup":{ + "name":"CopyDBParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CopyDBParameterGroupMessage"}, + "output":{ + "shape":"CopyDBParameterGroupResult", + "resultWrapper":"CopyDBParameterGroupResult" + }, + "errors":[ + {"shape":"DBParameterGroupNotFoundFault"}, + {"shape":"DBParameterGroupAlreadyExistsFault"}, + {"shape":"DBParameterGroupQuotaExceededFault"} + ] + }, + "CopyDBSnapshot":{ + "name":"CopyDBSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CopyDBSnapshotMessage"}, + "output":{ + "shape":"CopyDBSnapshotResult", + "resultWrapper":"CopyDBSnapshotResult" + }, + "errors":[ + {"shape":"DBSnapshotAlreadyExistsFault"}, + {"shape":"DBSnapshotNotFoundFault"}, + {"shape":"InvalidDBSnapshotStateFault"}, + {"shape":"SnapshotQuotaExceededFault"}, + {"shape":"KMSKeyNotAccessibleFault"} + ] + }, + "CopyOptionGroup":{ + "name":"CopyOptionGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CopyOptionGroupMessage"}, + "output":{ + "shape":"CopyOptionGroupResult", + "resultWrapper":"CopyOptionGroupResult" + }, + "errors":[ + {"shape":"OptionGroupAlreadyExistsFault"}, + {"shape":"OptionGroupNotFoundFault"}, + {"shape":"OptionGroupQuotaExceededFault"} + ] + }, + "CreateDBCluster":{ + "name":"CreateDBCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDBClusterMessage"}, + "output":{ + "shape":"CreateDBClusterResult", + "resultWrapper":"CreateDBClusterResult" + }, + "errors":[ + {"shape":"DBClusterAlreadyExistsFault"}, + {"shape":"InsufficientStorageClusterCapacityFault"}, + {"shape":"DBClusterQuotaExceededFault"}, + {"shape":"StorageQuotaExceededFault"}, + {"shape":"DBSubnetGroupNotFoundFault"}, + {"shape":"InvalidVPCNetworkStateFault"}, + {"shape":"InvalidDBClusterStateFault"}, + {"shape":"InvalidDBSubnetGroupStateFault"}, + {"shape":"InvalidSubnet"}, + {"shape":"DBClusterParameterGroupNotFoundFault"}, + {"shape":"KMSKeyNotAccessibleFault"}, + {"shape":"DBClusterNotFoundFault"} + ] + }, + "CreateDBClusterParameterGroup":{ + "name":"CreateDBClusterParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDBClusterParameterGroupMessage"}, + "output":{ + "shape":"CreateDBClusterParameterGroupResult", + "resultWrapper":"CreateDBClusterParameterGroupResult" + }, + "errors":[ + {"shape":"DBParameterGroupQuotaExceededFault"}, + {"shape":"DBParameterGroupAlreadyExistsFault"} + ] + }, + "CreateDBClusterSnapshot":{ + "name":"CreateDBClusterSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDBClusterSnapshotMessage"}, + "output":{ + "shape":"CreateDBClusterSnapshotResult", + "resultWrapper":"CreateDBClusterSnapshotResult" + }, + "errors":[ + {"shape":"DBClusterSnapshotAlreadyExistsFault"}, + {"shape":"InvalidDBClusterStateFault"}, + {"shape":"DBClusterNotFoundFault"}, + {"shape":"SnapshotQuotaExceededFault"}, + {"shape":"InvalidDBClusterSnapshotStateFault"} + ] + }, + "CreateDBInstance":{ + "name":"CreateDBInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDBInstanceMessage"}, + "output":{ + "shape":"CreateDBInstanceResult", + "resultWrapper":"CreateDBInstanceResult" + }, + "errors":[ + {"shape":"DBInstanceAlreadyExistsFault"}, + {"shape":"InsufficientDBInstanceCapacityFault"}, + {"shape":"DBParameterGroupNotFoundFault"}, + {"shape":"DBSecurityGroupNotFoundFault"}, + {"shape":"InstanceQuotaExceededFault"}, + {"shape":"StorageQuotaExceededFault"}, + {"shape":"DBSubnetGroupNotFoundFault"}, + {"shape":"DBSubnetGroupDoesNotCoverEnoughAZs"}, + {"shape":"InvalidDBClusterStateFault"}, + {"shape":"InvalidSubnet"}, + {"shape":"InvalidVPCNetworkStateFault"}, + {"shape":"ProvisionedIopsNotAvailableInAZFault"}, + {"shape":"OptionGroupNotFoundFault"}, + {"shape":"DBClusterNotFoundFault"}, + {"shape":"StorageTypeNotSupportedFault"}, + {"shape":"AuthorizationNotFoundFault"}, + {"shape":"KMSKeyNotAccessibleFault"}, + {"shape":"DomainNotFoundFault"} + ] + }, + "CreateDBInstanceReadReplica":{ + "name":"CreateDBInstanceReadReplica", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDBInstanceReadReplicaMessage"}, + "output":{ + "shape":"CreateDBInstanceReadReplicaResult", + "resultWrapper":"CreateDBInstanceReadReplicaResult" + }, + "errors":[ + {"shape":"DBInstanceAlreadyExistsFault"}, + {"shape":"InsufficientDBInstanceCapacityFault"}, + {"shape":"DBParameterGroupNotFoundFault"}, + {"shape":"DBSecurityGroupNotFoundFault"}, + {"shape":"InstanceQuotaExceededFault"}, + {"shape":"StorageQuotaExceededFault"}, + {"shape":"DBInstanceNotFoundFault"}, + {"shape":"InvalidDBInstanceStateFault"}, + {"shape":"DBSubnetGroupNotFoundFault"}, + {"shape":"DBSubnetGroupDoesNotCoverEnoughAZs"}, + {"shape":"InvalidSubnet"}, + {"shape":"InvalidVPCNetworkStateFault"}, + {"shape":"ProvisionedIopsNotAvailableInAZFault"}, + {"shape":"OptionGroupNotFoundFault"}, + {"shape":"DBSubnetGroupNotAllowedFault"}, + {"shape":"InvalidDBSubnetGroupFault"}, + {"shape":"StorageTypeNotSupportedFault"}, + {"shape":"KMSKeyNotAccessibleFault"} + ] + }, + "CreateDBParameterGroup":{ + "name":"CreateDBParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDBParameterGroupMessage"}, + "output":{ + "shape":"CreateDBParameterGroupResult", + "resultWrapper":"CreateDBParameterGroupResult" + }, + "errors":[ + {"shape":"DBParameterGroupQuotaExceededFault"}, + {"shape":"DBParameterGroupAlreadyExistsFault"} + ] + }, + "CreateDBSecurityGroup":{ + "name":"CreateDBSecurityGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDBSecurityGroupMessage"}, + "output":{ + "shape":"CreateDBSecurityGroupResult", + "resultWrapper":"CreateDBSecurityGroupResult" + }, + "errors":[ + {"shape":"DBSecurityGroupAlreadyExistsFault"}, + {"shape":"DBSecurityGroupQuotaExceededFault"}, + {"shape":"DBSecurityGroupNotSupportedFault"} + ] + }, + "CreateDBSnapshot":{ + "name":"CreateDBSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDBSnapshotMessage"}, + "output":{ + "shape":"CreateDBSnapshotResult", + "resultWrapper":"CreateDBSnapshotResult" + }, + "errors":[ + {"shape":"DBSnapshotAlreadyExistsFault"}, + {"shape":"InvalidDBInstanceStateFault"}, + {"shape":"DBInstanceNotFoundFault"}, + {"shape":"SnapshotQuotaExceededFault"} + ] + }, + "CreateDBSubnetGroup":{ + "name":"CreateDBSubnetGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDBSubnetGroupMessage"}, + "output":{ + "shape":"CreateDBSubnetGroupResult", + "resultWrapper":"CreateDBSubnetGroupResult" + }, + "errors":[ + {"shape":"DBSubnetGroupAlreadyExistsFault"}, + {"shape":"DBSubnetGroupQuotaExceededFault"}, + {"shape":"DBSubnetQuotaExceededFault"}, + {"shape":"DBSubnetGroupDoesNotCoverEnoughAZs"}, + {"shape":"InvalidSubnet"} + ] + }, + "CreateEventSubscription":{ + "name":"CreateEventSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateEventSubscriptionMessage"}, + "output":{ + "shape":"CreateEventSubscriptionResult", + "resultWrapper":"CreateEventSubscriptionResult" + }, + "errors":[ + {"shape":"EventSubscriptionQuotaExceededFault"}, + {"shape":"SubscriptionAlreadyExistFault"}, + {"shape":"SNSInvalidTopicFault"}, + {"shape":"SNSNoAuthorizationFault"}, + {"shape":"SNSTopicArnNotFoundFault"}, + {"shape":"SubscriptionCategoryNotFoundFault"}, + {"shape":"SourceNotFoundFault"} + ] + }, + "CreateOptionGroup":{ + "name":"CreateOptionGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateOptionGroupMessage"}, + "output":{ + "shape":"CreateOptionGroupResult", + "resultWrapper":"CreateOptionGroupResult" + }, + "errors":[ + {"shape":"OptionGroupAlreadyExistsFault"}, + {"shape":"OptionGroupQuotaExceededFault"} + ] + }, + "DeleteDBCluster":{ + "name":"DeleteDBCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDBClusterMessage"}, + "output":{ + "shape":"DeleteDBClusterResult", + "resultWrapper":"DeleteDBClusterResult" + }, + "errors":[ + {"shape":"DBClusterNotFoundFault"}, + {"shape":"InvalidDBClusterStateFault"}, + {"shape":"DBClusterSnapshotAlreadyExistsFault"}, + {"shape":"SnapshotQuotaExceededFault"}, + {"shape":"InvalidDBClusterSnapshotStateFault"} + ] + }, + "DeleteDBClusterParameterGroup":{ + "name":"DeleteDBClusterParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDBClusterParameterGroupMessage"}, + "errors":[ + {"shape":"InvalidDBParameterGroupStateFault"}, + {"shape":"DBParameterGroupNotFoundFault"} + ] + }, + "DeleteDBClusterSnapshot":{ + "name":"DeleteDBClusterSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDBClusterSnapshotMessage"}, + "output":{ + "shape":"DeleteDBClusterSnapshotResult", + "resultWrapper":"DeleteDBClusterSnapshotResult" + }, + "errors":[ + {"shape":"InvalidDBClusterSnapshotStateFault"}, + {"shape":"DBClusterSnapshotNotFoundFault"} + ] + }, + "DeleteDBInstance":{ + "name":"DeleteDBInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDBInstanceMessage"}, + "output":{ + "shape":"DeleteDBInstanceResult", + "resultWrapper":"DeleteDBInstanceResult" + }, + "errors":[ + {"shape":"DBInstanceNotFoundFault"}, + {"shape":"InvalidDBInstanceStateFault"}, + {"shape":"DBSnapshotAlreadyExistsFault"}, + {"shape":"SnapshotQuotaExceededFault"}, + {"shape":"InvalidDBClusterStateFault"} + ] + }, + "DeleteDBParameterGroup":{ + "name":"DeleteDBParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDBParameterGroupMessage"}, + "errors":[ + {"shape":"InvalidDBParameterGroupStateFault"}, + {"shape":"DBParameterGroupNotFoundFault"} + ] + }, + "DeleteDBSecurityGroup":{ + "name":"DeleteDBSecurityGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDBSecurityGroupMessage"}, + "errors":[ + {"shape":"InvalidDBSecurityGroupStateFault"}, + {"shape":"DBSecurityGroupNotFoundFault"} + ] + }, + "DeleteDBSnapshot":{ + "name":"DeleteDBSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDBSnapshotMessage"}, + "output":{ + "shape":"DeleteDBSnapshotResult", + "resultWrapper":"DeleteDBSnapshotResult" + }, + "errors":[ + {"shape":"InvalidDBSnapshotStateFault"}, + {"shape":"DBSnapshotNotFoundFault"} + ] + }, + "DeleteDBSubnetGroup":{ + "name":"DeleteDBSubnetGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDBSubnetGroupMessage"}, + "errors":[ + {"shape":"InvalidDBSubnetGroupStateFault"}, + {"shape":"InvalidDBSubnetStateFault"}, + {"shape":"DBSubnetGroupNotFoundFault"} + ] + }, + "DeleteEventSubscription":{ + "name":"DeleteEventSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteEventSubscriptionMessage"}, + "output":{ + "shape":"DeleteEventSubscriptionResult", + "resultWrapper":"DeleteEventSubscriptionResult" + }, + "errors":[ + {"shape":"SubscriptionNotFoundFault"}, + {"shape":"InvalidEventSubscriptionStateFault"} + ] + }, + "DeleteOptionGroup":{ + "name":"DeleteOptionGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteOptionGroupMessage"}, + "errors":[ + {"shape":"OptionGroupNotFoundFault"}, + {"shape":"InvalidOptionGroupStateFault"} + ] + }, + "DescribeAccountAttributes":{ + "name":"DescribeAccountAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAccountAttributesMessage"}, + "output":{ + "shape":"AccountAttributesMessage", + "resultWrapper":"DescribeAccountAttributesResult" + } + }, + "DescribeCertificates":{ + "name":"DescribeCertificates", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeCertificatesMessage"}, + "output":{ + "shape":"CertificateMessage", + "resultWrapper":"DescribeCertificatesResult" + }, + "errors":[ + {"shape":"CertificateNotFoundFault"} + ] + }, + "DescribeDBClusterParameterGroups":{ + "name":"DescribeDBClusterParameterGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBClusterParameterGroupsMessage"}, + "output":{ + "shape":"DBClusterParameterGroupsMessage", + "resultWrapper":"DescribeDBClusterParameterGroupsResult" + }, + "errors":[ + {"shape":"DBParameterGroupNotFoundFault"} + ] + }, + "DescribeDBClusterParameters":{ + "name":"DescribeDBClusterParameters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBClusterParametersMessage"}, + "output":{ + "shape":"DBClusterParameterGroupDetails", + "resultWrapper":"DescribeDBClusterParametersResult" + }, + "errors":[ + {"shape":"DBParameterGroupNotFoundFault"} + ] + }, + "DescribeDBClusterSnapshotAttributes":{ + "name":"DescribeDBClusterSnapshotAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBClusterSnapshotAttributesMessage"}, + "output":{ + "shape":"DescribeDBClusterSnapshotAttributesResult", + "resultWrapper":"DescribeDBClusterSnapshotAttributesResult" + }, + "errors":[ + {"shape":"DBClusterSnapshotNotFoundFault"} + ] + }, + "DescribeDBClusterSnapshots":{ + "name":"DescribeDBClusterSnapshots", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBClusterSnapshotsMessage"}, + "output":{ + "shape":"DBClusterSnapshotMessage", + "resultWrapper":"DescribeDBClusterSnapshotsResult" + }, + "errors":[ + {"shape":"DBClusterSnapshotNotFoundFault"} + ] + }, + "DescribeDBClusters":{ + "name":"DescribeDBClusters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBClustersMessage"}, + "output":{ + "shape":"DBClusterMessage", + "resultWrapper":"DescribeDBClustersResult" + }, + "errors":[ + {"shape":"DBClusterNotFoundFault"} + ] + }, + "DescribeDBEngineVersions":{ + "name":"DescribeDBEngineVersions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBEngineVersionsMessage"}, + "output":{ + "shape":"DBEngineVersionMessage", + "resultWrapper":"DescribeDBEngineVersionsResult" + } + }, + "DescribeDBInstances":{ + "name":"DescribeDBInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBInstancesMessage"}, + "output":{ + "shape":"DBInstanceMessage", + "resultWrapper":"DescribeDBInstancesResult" + }, + "errors":[ + {"shape":"DBInstanceNotFoundFault"} + ] + }, + "DescribeDBLogFiles":{ + "name":"DescribeDBLogFiles", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBLogFilesMessage"}, + "output":{ + "shape":"DescribeDBLogFilesResponse", + "resultWrapper":"DescribeDBLogFilesResult" + }, + "errors":[ + {"shape":"DBInstanceNotFoundFault"} + ] + }, + "DescribeDBParameterGroups":{ + "name":"DescribeDBParameterGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBParameterGroupsMessage"}, + "output":{ + "shape":"DBParameterGroupsMessage", + "resultWrapper":"DescribeDBParameterGroupsResult" + }, + "errors":[ + {"shape":"DBParameterGroupNotFoundFault"} + ] + }, + "DescribeDBParameters":{ + "name":"DescribeDBParameters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBParametersMessage"}, + "output":{ + "shape":"DBParameterGroupDetails", + "resultWrapper":"DescribeDBParametersResult" + }, + "errors":[ + {"shape":"DBParameterGroupNotFoundFault"} + ] + }, + "DescribeDBSecurityGroups":{ + "name":"DescribeDBSecurityGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBSecurityGroupsMessage"}, + "output":{ + "shape":"DBSecurityGroupMessage", + "resultWrapper":"DescribeDBSecurityGroupsResult" + }, + "errors":[ + {"shape":"DBSecurityGroupNotFoundFault"} + ] + }, + "DescribeDBSnapshotAttributes":{ + "name":"DescribeDBSnapshotAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBSnapshotAttributesMessage"}, + "output":{ + "shape":"DescribeDBSnapshotAttributesResult", + "resultWrapper":"DescribeDBSnapshotAttributesResult" + }, + "errors":[ + {"shape":"DBSnapshotNotFoundFault"} + ] + }, + "DescribeDBSnapshots":{ + "name":"DescribeDBSnapshots", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBSnapshotsMessage"}, + "output":{ + "shape":"DBSnapshotMessage", + "resultWrapper":"DescribeDBSnapshotsResult" + }, + "errors":[ + {"shape":"DBSnapshotNotFoundFault"} + ] + }, + "DescribeDBSubnetGroups":{ + "name":"DescribeDBSubnetGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBSubnetGroupsMessage"}, + "output":{ + "shape":"DBSubnetGroupMessage", + "resultWrapper":"DescribeDBSubnetGroupsResult" + }, + "errors":[ + {"shape":"DBSubnetGroupNotFoundFault"} + ] + }, + "DescribeEngineDefaultClusterParameters":{ + "name":"DescribeEngineDefaultClusterParameters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEngineDefaultClusterParametersMessage"}, + "output":{ + "shape":"DescribeEngineDefaultClusterParametersResult", + "resultWrapper":"DescribeEngineDefaultClusterParametersResult" + } + }, + "DescribeEngineDefaultParameters":{ + "name":"DescribeEngineDefaultParameters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEngineDefaultParametersMessage"}, + "output":{ + "shape":"DescribeEngineDefaultParametersResult", + "resultWrapper":"DescribeEngineDefaultParametersResult" + } + }, + "DescribeEventCategories":{ + "name":"DescribeEventCategories", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEventCategoriesMessage"}, + "output":{ + "shape":"EventCategoriesMessage", + "resultWrapper":"DescribeEventCategoriesResult" + } + }, + "DescribeEventSubscriptions":{ + "name":"DescribeEventSubscriptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEventSubscriptionsMessage"}, + "output":{ + "shape":"EventSubscriptionsMessage", + "resultWrapper":"DescribeEventSubscriptionsResult" + }, + "errors":[ + {"shape":"SubscriptionNotFoundFault"} + ] + }, + "DescribeEvents":{ + "name":"DescribeEvents", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEventsMessage"}, + "output":{ + "shape":"EventsMessage", + "resultWrapper":"DescribeEventsResult" + } + }, + "DescribeOptionGroupOptions":{ + "name":"DescribeOptionGroupOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeOptionGroupOptionsMessage"}, + "output":{ + "shape":"OptionGroupOptionsMessage", + "resultWrapper":"DescribeOptionGroupOptionsResult" + } + }, + "DescribeOptionGroups":{ + "name":"DescribeOptionGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeOptionGroupsMessage"}, + "output":{ + "shape":"OptionGroups", + "resultWrapper":"DescribeOptionGroupsResult" + }, + "errors":[ + {"shape":"OptionGroupNotFoundFault"} + ] + }, + "DescribeOrderableDBInstanceOptions":{ + "name":"DescribeOrderableDBInstanceOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeOrderableDBInstanceOptionsMessage"}, + "output":{ + "shape":"OrderableDBInstanceOptionsMessage", + "resultWrapper":"DescribeOrderableDBInstanceOptionsResult" + } + }, + "DescribePendingMaintenanceActions":{ + "name":"DescribePendingMaintenanceActions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribePendingMaintenanceActionsMessage"}, + "output":{ + "shape":"PendingMaintenanceActionsMessage", + "resultWrapper":"DescribePendingMaintenanceActionsResult" + }, + "errors":[ + {"shape":"ResourceNotFoundFault"} + ] + }, + "DescribeReservedDBInstances":{ + "name":"DescribeReservedDBInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeReservedDBInstancesMessage"}, + "output":{ + "shape":"ReservedDBInstanceMessage", + "resultWrapper":"DescribeReservedDBInstancesResult" + }, + "errors":[ + {"shape":"ReservedDBInstanceNotFoundFault"} + ] + }, + "DescribeReservedDBInstancesOfferings":{ + "name":"DescribeReservedDBInstancesOfferings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeReservedDBInstancesOfferingsMessage"}, + "output":{ + "shape":"ReservedDBInstancesOfferingMessage", + "resultWrapper":"DescribeReservedDBInstancesOfferingsResult" + }, + "errors":[ + {"shape":"ReservedDBInstancesOfferingNotFoundFault"} + ] + }, + "DownloadDBLogFilePortion":{ + "name":"DownloadDBLogFilePortion", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DownloadDBLogFilePortionMessage"}, + "output":{ + "shape":"DownloadDBLogFilePortionDetails", + "resultWrapper":"DownloadDBLogFilePortionResult" + }, + "errors":[ + {"shape":"DBInstanceNotFoundFault"}, + {"shape":"DBLogFileNotFoundFault"} + ] + }, + "FailoverDBCluster":{ + "name":"FailoverDBCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"FailoverDBClusterMessage"}, + "output":{ + "shape":"FailoverDBClusterResult", + "resultWrapper":"FailoverDBClusterResult" + }, + "errors":[ + {"shape":"DBClusterNotFoundFault"}, + {"shape":"InvalidDBClusterStateFault"} + ] + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForResourceMessage"}, + "output":{ + "shape":"TagListMessage", + "resultWrapper":"ListTagsForResourceResult" + }, + "errors":[ + {"shape":"DBInstanceNotFoundFault"}, + {"shape":"DBSnapshotNotFoundFault"} + ] + }, + "ModifyDBCluster":{ + "name":"ModifyDBCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyDBClusterMessage"}, + "output":{ + "shape":"ModifyDBClusterResult", + "resultWrapper":"ModifyDBClusterResult" + }, + "errors":[ + {"shape":"DBClusterNotFoundFault"}, + {"shape":"InvalidDBClusterStateFault"}, + {"shape":"StorageQuotaExceededFault"}, + {"shape":"DBSubnetGroupNotFoundFault"}, + {"shape":"InvalidVPCNetworkStateFault"}, + {"shape":"InvalidDBSubnetGroupStateFault"}, + {"shape":"InvalidSubnet"}, + {"shape":"DBClusterParameterGroupNotFoundFault"}, + {"shape":"InvalidDBSecurityGroupStateFault"}, + {"shape":"InvalidDBInstanceStateFault"}, + {"shape":"DBClusterAlreadyExistsFault"} + ] + }, + "ModifyDBClusterParameterGroup":{ + "name":"ModifyDBClusterParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyDBClusterParameterGroupMessage"}, + "output":{ + "shape":"DBClusterParameterGroupNameMessage", + "resultWrapper":"ModifyDBClusterParameterGroupResult" + }, + "errors":[ + {"shape":"DBParameterGroupNotFoundFault"}, + {"shape":"InvalidDBParameterGroupStateFault"} + ] + }, + "ModifyDBClusterSnapshotAttribute":{ + "name":"ModifyDBClusterSnapshotAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyDBClusterSnapshotAttributeMessage"}, + "output":{ + "shape":"ModifyDBClusterSnapshotAttributeResult", + "resultWrapper":"ModifyDBClusterSnapshotAttributeResult" + }, + "errors":[ + {"shape":"DBClusterSnapshotNotFoundFault"}, + {"shape":"InvalidDBClusterSnapshotStateFault"}, + {"shape":"SharedSnapshotQuotaExceededFault"} + ] + }, + "ModifyDBInstance":{ + "name":"ModifyDBInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyDBInstanceMessage"}, + "output":{ + "shape":"ModifyDBInstanceResult", + "resultWrapper":"ModifyDBInstanceResult" + }, + "errors":[ + {"shape":"InvalidDBInstanceStateFault"}, + {"shape":"InvalidDBSecurityGroupStateFault"}, + {"shape":"DBInstanceAlreadyExistsFault"}, + {"shape":"DBInstanceNotFoundFault"}, + {"shape":"DBSecurityGroupNotFoundFault"}, + {"shape":"DBParameterGroupNotFoundFault"}, + {"shape":"InsufficientDBInstanceCapacityFault"}, + {"shape":"StorageQuotaExceededFault"}, + {"shape":"InvalidVPCNetworkStateFault"}, + {"shape":"ProvisionedIopsNotAvailableInAZFault"}, + {"shape":"OptionGroupNotFoundFault"}, + {"shape":"DBUpgradeDependencyFailureFault"}, + {"shape":"StorageTypeNotSupportedFault"}, + {"shape":"AuthorizationNotFoundFault"}, + {"shape":"CertificateNotFoundFault"}, + {"shape":"DomainNotFoundFault"} + ] + }, + "ModifyDBParameterGroup":{ + "name":"ModifyDBParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyDBParameterGroupMessage"}, + "output":{ + "shape":"DBParameterGroupNameMessage", + "resultWrapper":"ModifyDBParameterGroupResult" + }, + "errors":[ + {"shape":"DBParameterGroupNotFoundFault"}, + {"shape":"InvalidDBParameterGroupStateFault"} + ] + }, + "ModifyDBSnapshotAttribute":{ + "name":"ModifyDBSnapshotAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyDBSnapshotAttributeMessage"}, + "output":{ + "shape":"ModifyDBSnapshotAttributeResult", + "resultWrapper":"ModifyDBSnapshotAttributeResult" + }, + "errors":[ + {"shape":"DBSnapshotNotFoundFault"}, + {"shape":"InvalidDBSnapshotStateFault"}, + {"shape":"SharedSnapshotQuotaExceededFault"} + ] + }, + "ModifyDBSubnetGroup":{ + "name":"ModifyDBSubnetGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyDBSubnetGroupMessage"}, + "output":{ + "shape":"ModifyDBSubnetGroupResult", + "resultWrapper":"ModifyDBSubnetGroupResult" + }, + "errors":[ + {"shape":"DBSubnetGroupNotFoundFault"}, + {"shape":"DBSubnetQuotaExceededFault"}, + {"shape":"SubnetAlreadyInUse"}, + {"shape":"DBSubnetGroupDoesNotCoverEnoughAZs"}, + {"shape":"InvalidSubnet"} + ] + }, + "ModifyEventSubscription":{ + "name":"ModifyEventSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyEventSubscriptionMessage"}, + "output":{ + "shape":"ModifyEventSubscriptionResult", + "resultWrapper":"ModifyEventSubscriptionResult" + }, + "errors":[ + {"shape":"EventSubscriptionQuotaExceededFault"}, + {"shape":"SubscriptionNotFoundFault"}, + {"shape":"SNSInvalidTopicFault"}, + {"shape":"SNSNoAuthorizationFault"}, + {"shape":"SNSTopicArnNotFoundFault"}, + {"shape":"SubscriptionCategoryNotFoundFault"} + ] + }, + "ModifyOptionGroup":{ + "name":"ModifyOptionGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyOptionGroupMessage"}, + "output":{ + "shape":"ModifyOptionGroupResult", + "resultWrapper":"ModifyOptionGroupResult" + }, + "errors":[ + {"shape":"InvalidOptionGroupStateFault"}, + {"shape":"OptionGroupNotFoundFault"} + ] + }, + "PromoteReadReplica":{ + "name":"PromoteReadReplica", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PromoteReadReplicaMessage"}, + "output":{ + "shape":"PromoteReadReplicaResult", + "resultWrapper":"PromoteReadReplicaResult" + }, + "errors":[ + {"shape":"InvalidDBInstanceStateFault"}, + {"shape":"DBInstanceNotFoundFault"} + ] + }, + "PromoteReadReplicaDBCluster":{ + "name":"PromoteReadReplicaDBCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PromoteReadReplicaDBClusterMessage"}, + "output":{ + "shape":"PromoteReadReplicaDBClusterResult", + "resultWrapper":"PromoteReadReplicaDBClusterResult" + }, + "errors":[ + {"shape":"DBClusterNotFoundFault"}, + {"shape":"InvalidDBClusterStateFault"} + ] + }, + "PurchaseReservedDBInstancesOffering":{ + "name":"PurchaseReservedDBInstancesOffering", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PurchaseReservedDBInstancesOfferingMessage"}, + "output":{ + "shape":"PurchaseReservedDBInstancesOfferingResult", + "resultWrapper":"PurchaseReservedDBInstancesOfferingResult" + }, + "errors":[ + {"shape":"ReservedDBInstancesOfferingNotFoundFault"}, + {"shape":"ReservedDBInstanceAlreadyExistsFault"}, + {"shape":"ReservedDBInstanceQuotaExceededFault"} + ] + }, + "RebootDBInstance":{ + "name":"RebootDBInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RebootDBInstanceMessage"}, + "output":{ + "shape":"RebootDBInstanceResult", + "resultWrapper":"RebootDBInstanceResult" + }, + "errors":[ + {"shape":"InvalidDBInstanceStateFault"}, + {"shape":"DBInstanceNotFoundFault"} + ] + }, + "RemoveSourceIdentifierFromSubscription":{ + "name":"RemoveSourceIdentifierFromSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RemoveSourceIdentifierFromSubscriptionMessage"}, + "output":{ + "shape":"RemoveSourceIdentifierFromSubscriptionResult", + "resultWrapper":"RemoveSourceIdentifierFromSubscriptionResult" + }, + "errors":[ + {"shape":"SubscriptionNotFoundFault"}, + {"shape":"SourceNotFoundFault"} + ] + }, + "RemoveTagsFromResource":{ + "name":"RemoveTagsFromResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RemoveTagsFromResourceMessage"}, + "errors":[ + {"shape":"DBInstanceNotFoundFault"}, + {"shape":"DBSnapshotNotFoundFault"} + ] + }, + "ResetDBClusterParameterGroup":{ + "name":"ResetDBClusterParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResetDBClusterParameterGroupMessage"}, + "output":{ + "shape":"DBClusterParameterGroupNameMessage", + "resultWrapper":"ResetDBClusterParameterGroupResult" + }, + "errors":[ + {"shape":"InvalidDBParameterGroupStateFault"}, + {"shape":"DBParameterGroupNotFoundFault"} + ] + }, + "ResetDBParameterGroup":{ + "name":"ResetDBParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResetDBParameterGroupMessage"}, + "output":{ + "shape":"DBParameterGroupNameMessage", + "resultWrapper":"ResetDBParameterGroupResult" + }, + "errors":[ + {"shape":"InvalidDBParameterGroupStateFault"}, + {"shape":"DBParameterGroupNotFoundFault"} + ] + }, + "RestoreDBClusterFromSnapshot":{ + "name":"RestoreDBClusterFromSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RestoreDBClusterFromSnapshotMessage"}, + "output":{ + "shape":"RestoreDBClusterFromSnapshotResult", + "resultWrapper":"RestoreDBClusterFromSnapshotResult" + }, + "errors":[ + {"shape":"DBClusterAlreadyExistsFault"}, + {"shape":"DBClusterQuotaExceededFault"}, + {"shape":"StorageQuotaExceededFault"}, + {"shape":"DBSubnetGroupNotFoundFault"}, + {"shape":"DBSnapshotNotFoundFault"}, + {"shape":"DBClusterSnapshotNotFoundFault"}, + {"shape":"InsufficientDBClusterCapacityFault"}, + {"shape":"InsufficientStorageClusterCapacityFault"}, + {"shape":"InvalidDBSnapshotStateFault"}, + {"shape":"InvalidDBClusterSnapshotStateFault"}, + {"shape":"StorageQuotaExceededFault"}, + {"shape":"InvalidVPCNetworkStateFault"}, + {"shape":"InvalidRestoreFault"}, + {"shape":"DBSubnetGroupNotFoundFault"}, + {"shape":"InvalidSubnet"}, + {"shape":"OptionGroupNotFoundFault"}, + {"shape":"KMSKeyNotAccessibleFault"} + ] + }, + "RestoreDBClusterToPointInTime":{ + "name":"RestoreDBClusterToPointInTime", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RestoreDBClusterToPointInTimeMessage"}, + "output":{ + "shape":"RestoreDBClusterToPointInTimeResult", + "resultWrapper":"RestoreDBClusterToPointInTimeResult" + }, + "errors":[ + {"shape":"DBClusterAlreadyExistsFault"}, + {"shape":"DBClusterQuotaExceededFault"}, + {"shape":"StorageQuotaExceededFault"}, + {"shape":"DBSubnetGroupNotFoundFault"}, + {"shape":"DBClusterNotFoundFault"}, + {"shape":"DBClusterSnapshotNotFoundFault"}, + {"shape":"InsufficientDBClusterCapacityFault"}, + {"shape":"InvalidDBSnapshotStateFault"}, + {"shape":"InvalidDBClusterSnapshotStateFault"}, + {"shape":"StorageQuotaExceededFault"}, + {"shape":"InvalidVPCNetworkStateFault"}, + {"shape":"InvalidRestoreFault"}, + {"shape":"DBSubnetGroupNotFoundFault"}, + {"shape":"InvalidSubnet"}, + {"shape":"OptionGroupNotFoundFault"}, + {"shape":"KMSKeyNotAccessibleFault"} + ] + }, + "RestoreDBInstanceFromDBSnapshot":{ + "name":"RestoreDBInstanceFromDBSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RestoreDBInstanceFromDBSnapshotMessage"}, + "output":{ + "shape":"RestoreDBInstanceFromDBSnapshotResult", + "resultWrapper":"RestoreDBInstanceFromDBSnapshotResult" + }, + "errors":[ + {"shape":"DBInstanceAlreadyExistsFault"}, + {"shape":"DBSnapshotNotFoundFault"}, + {"shape":"InstanceQuotaExceededFault"}, + {"shape":"InsufficientDBInstanceCapacityFault"}, + {"shape":"InvalidDBSnapshotStateFault"}, + {"shape":"StorageQuotaExceededFault"}, + {"shape":"InvalidVPCNetworkStateFault"}, + {"shape":"InvalidRestoreFault"}, + {"shape":"DBSubnetGroupNotFoundFault"}, + {"shape":"DBSubnetGroupDoesNotCoverEnoughAZs"}, + {"shape":"InvalidSubnet"}, + {"shape":"ProvisionedIopsNotAvailableInAZFault"}, + {"shape":"OptionGroupNotFoundFault"}, + {"shape":"StorageTypeNotSupportedFault"}, + {"shape":"AuthorizationNotFoundFault"}, + {"shape":"KMSKeyNotAccessibleFault"}, + {"shape":"DBSecurityGroupNotFoundFault"}, + {"shape":"DomainNotFoundFault"} + ] + }, + "RestoreDBInstanceToPointInTime":{ + "name":"RestoreDBInstanceToPointInTime", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RestoreDBInstanceToPointInTimeMessage"}, + "output":{ + "shape":"RestoreDBInstanceToPointInTimeResult", + "resultWrapper":"RestoreDBInstanceToPointInTimeResult" + }, + "errors":[ + {"shape":"DBInstanceAlreadyExistsFault"}, + {"shape":"DBInstanceNotFoundFault"}, + {"shape":"InstanceQuotaExceededFault"}, + {"shape":"InsufficientDBInstanceCapacityFault"}, + {"shape":"InvalidDBInstanceStateFault"}, + {"shape":"PointInTimeRestoreNotEnabledFault"}, + {"shape":"StorageQuotaExceededFault"}, + {"shape":"InvalidVPCNetworkStateFault"}, + {"shape":"InvalidRestoreFault"}, + {"shape":"DBSubnetGroupNotFoundFault"}, + {"shape":"DBSubnetGroupDoesNotCoverEnoughAZs"}, + {"shape":"InvalidSubnet"}, + {"shape":"ProvisionedIopsNotAvailableInAZFault"}, + {"shape":"OptionGroupNotFoundFault"}, + {"shape":"StorageTypeNotSupportedFault"}, + {"shape":"AuthorizationNotFoundFault"}, + {"shape":"KMSKeyNotAccessibleFault"}, + {"shape":"DBSecurityGroupNotFoundFault"}, + {"shape":"DomainNotFoundFault"} + ] + }, + "RevokeDBSecurityGroupIngress":{ + "name":"RevokeDBSecurityGroupIngress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RevokeDBSecurityGroupIngressMessage"}, + "output":{ + "shape":"RevokeDBSecurityGroupIngressResult", + "resultWrapper":"RevokeDBSecurityGroupIngressResult" + }, + "errors":[ + {"shape":"DBSecurityGroupNotFoundFault"}, + {"shape":"AuthorizationNotFoundFault"}, + {"shape":"InvalidDBSecurityGroupStateFault"} + ] + } + }, + "shapes":{ + "AccountAttributesMessage":{ + "type":"structure", + "members":{ + "AccountQuotas":{"shape":"AccountQuotaList"} + } + }, + "AccountQuota":{ + "type":"structure", + "members":{ + "AccountQuotaName":{"shape":"String"}, + "Used":{"shape":"Long"}, + "Max":{"shape":"Long"} + }, + "wrapper":true + }, + "AccountQuotaList":{ + "type":"list", + "member":{ + "shape":"AccountQuota", + "locationName":"AccountQuota" + } + }, + "AddSourceIdentifierToSubscriptionMessage":{ + "type":"structure", + "required":[ + "SubscriptionName", + "SourceIdentifier" + ], + "members":{ + "SubscriptionName":{"shape":"String"}, + "SourceIdentifier":{"shape":"String"} + } + }, + "AddSourceIdentifierToSubscriptionResult":{ + "type":"structure", + "members":{ + "EventSubscription":{"shape":"EventSubscription"} + } + }, + "AddTagsToResourceMessage":{ + "type":"structure", + "required":[ + "ResourceName", + "Tags" + ], + "members":{ + "ResourceName":{"shape":"String"}, + "Tags":{"shape":"TagList"} + } + }, + "ApplyMethod":{ + "type":"string", + "enum":[ + "immediate", + "pending-reboot" + ] + }, + "ApplyPendingMaintenanceActionMessage":{ + "type":"structure", + "required":[ + "ResourceIdentifier", + "ApplyAction", + "OptInType" + ], + "members":{ + "ResourceIdentifier":{"shape":"String"}, + "ApplyAction":{"shape":"String"}, + "OptInType":{"shape":"String"} + } + }, + "ApplyPendingMaintenanceActionResult":{ + "type":"structure", + "members":{ + "ResourcePendingMaintenanceActions":{"shape":"ResourcePendingMaintenanceActions"} + } + }, + "AttributeValueList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"AttributeValue" + } + }, + "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 + }, + "AuthorizationQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"AuthorizationQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "AuthorizeDBSecurityGroupIngressMessage":{ + "type":"structure", + "required":["DBSecurityGroupName"], + "members":{ + "DBSecurityGroupName":{"shape":"String"}, + "CIDRIP":{"shape":"String"}, + "EC2SecurityGroupName":{"shape":"String"}, + "EC2SecurityGroupId":{"shape":"String"}, + "EC2SecurityGroupOwnerId":{"shape":"String"} + } + }, + "AuthorizeDBSecurityGroupIngressResult":{ + "type":"structure", + "members":{ + "DBSecurityGroup":{"shape":"DBSecurityGroup"} + } + }, + "AvailabilityZone":{ + "type":"structure", + "members":{ + "Name":{"shape":"String"} + }, + "wrapper":true + }, + "AvailabilityZoneList":{ + "type":"list", + "member":{ + "shape":"AvailabilityZone", + "locationName":"AvailabilityZone" + } + }, + "AvailabilityZones":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"AvailabilityZone" + } + }, + "Boolean":{"type":"boolean"}, + "BooleanOptional":{"type":"boolean"}, + "Certificate":{ + "type":"structure", + "members":{ + "CertificateIdentifier":{"shape":"String"}, + "CertificateType":{"shape":"String"}, + "Thumbprint":{"shape":"String"}, + "ValidFrom":{"shape":"TStamp"}, + "ValidTill":{"shape":"TStamp"} + }, + "wrapper":true + }, + "CertificateList":{ + "type":"list", + "member":{ + "shape":"Certificate", + "locationName":"Certificate" + } + }, + "CertificateMessage":{ + "type":"structure", + "members":{ + "Certificates":{"shape":"CertificateList"}, + "Marker":{"shape":"String"} + } + }, + "CertificateNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"CertificateNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "CharacterSet":{ + "type":"structure", + "members":{ + "CharacterSetName":{"shape":"String"}, + "CharacterSetDescription":{"shape":"String"} + } + }, + "CopyDBClusterSnapshotMessage":{ + "type":"structure", + "required":[ + "SourceDBClusterSnapshotIdentifier", + "TargetDBClusterSnapshotIdentifier" + ], + "members":{ + "SourceDBClusterSnapshotIdentifier":{"shape":"String"}, + "TargetDBClusterSnapshotIdentifier":{"shape":"String"}, + "Tags":{"shape":"TagList"} + } + }, + "CopyDBClusterSnapshotResult":{ + "type":"structure", + "members":{ + "DBClusterSnapshot":{"shape":"DBClusterSnapshot"} + } + }, + "CopyDBParameterGroupMessage":{ + "type":"structure", + "required":[ + "SourceDBParameterGroupIdentifier", + "TargetDBParameterGroupIdentifier", + "TargetDBParameterGroupDescription" + ], + "members":{ + "SourceDBParameterGroupIdentifier":{"shape":"String"}, + "TargetDBParameterGroupIdentifier":{"shape":"String"}, + "TargetDBParameterGroupDescription":{"shape":"String"}, + "Tags":{"shape":"TagList"} + } + }, + "CopyDBParameterGroupResult":{ + "type":"structure", + "members":{ + "DBParameterGroup":{"shape":"DBParameterGroup"} + } + }, + "CopyDBSnapshotMessage":{ + "type":"structure", + "required":[ + "SourceDBSnapshotIdentifier", + "TargetDBSnapshotIdentifier" + ], + "members":{ + "SourceDBSnapshotIdentifier":{"shape":"String"}, + "TargetDBSnapshotIdentifier":{"shape":"String"}, + "KmsKeyId":{"shape":"String"}, + "Tags":{"shape":"TagList"}, + "CopyTags":{"shape":"BooleanOptional"} + } + }, + "CopyDBSnapshotResult":{ + "type":"structure", + "members":{ + "DBSnapshot":{"shape":"DBSnapshot"} + } + }, + "CopyOptionGroupMessage":{ + "type":"structure", + "required":[ + "SourceOptionGroupIdentifier", + "TargetOptionGroupIdentifier", + "TargetOptionGroupDescription" + ], + "members":{ + "SourceOptionGroupIdentifier":{"shape":"String"}, + "TargetOptionGroupIdentifier":{"shape":"String"}, + "TargetOptionGroupDescription":{"shape":"String"}, + "Tags":{"shape":"TagList"} + } + }, + "CopyOptionGroupResult":{ + "type":"structure", + "members":{ + "OptionGroup":{"shape":"OptionGroup"} + } + }, + "CreateDBClusterMessage":{ + "type":"structure", + "required":[ + "DBClusterIdentifier", + "Engine", + "MasterUsername", + "MasterUserPassword" + ], + "members":{ + "AvailabilityZones":{"shape":"AvailabilityZones"}, + "BackupRetentionPeriod":{"shape":"IntegerOptional"}, + "CharacterSetName":{"shape":"String"}, + "DatabaseName":{"shape":"String"}, + "DBClusterIdentifier":{"shape":"String"}, + "DBClusterParameterGroupName":{"shape":"String"}, + "VpcSecurityGroupIds":{"shape":"VpcSecurityGroupIdList"}, + "DBSubnetGroupName":{"shape":"String"}, + "Engine":{"shape":"String"}, + "EngineVersion":{"shape":"String"}, + "Port":{"shape":"IntegerOptional"}, + "MasterUsername":{"shape":"String"}, + "MasterUserPassword":{"shape":"String"}, + "OptionGroupName":{"shape":"String"}, + "PreferredBackupWindow":{"shape":"String"}, + "PreferredMaintenanceWindow":{"shape":"String"}, + "ReplicationSourceIdentifier":{"shape":"String"}, + "Tags":{"shape":"TagList"}, + "StorageEncrypted":{"shape":"BooleanOptional"}, + "KmsKeyId":{"shape":"String"} + } + }, + "CreateDBClusterParameterGroupMessage":{ + "type":"structure", + "required":[ + "DBClusterParameterGroupName", + "DBParameterGroupFamily", + "Description" + ], + "members":{ + "DBClusterParameterGroupName":{"shape":"String"}, + "DBParameterGroupFamily":{"shape":"String"}, + "Description":{"shape":"String"}, + "Tags":{"shape":"TagList"} + } + }, + "CreateDBClusterParameterGroupResult":{ + "type":"structure", + "members":{ + "DBClusterParameterGroup":{"shape":"DBClusterParameterGroup"} + } + }, + "CreateDBClusterResult":{ + "type":"structure", + "members":{ + "DBCluster":{"shape":"DBCluster"} + } + }, + "CreateDBClusterSnapshotMessage":{ + "type":"structure", + "required":[ + "DBClusterSnapshotIdentifier", + "DBClusterIdentifier" + ], + "members":{ + "DBClusterSnapshotIdentifier":{"shape":"String"}, + "DBClusterIdentifier":{"shape":"String"}, + "Tags":{"shape":"TagList"} + } + }, + "CreateDBClusterSnapshotResult":{ + "type":"structure", + "members":{ + "DBClusterSnapshot":{"shape":"DBClusterSnapshot"} + } + }, + "CreateDBInstanceMessage":{ + "type":"structure", + "required":[ + "DBInstanceIdentifier", + "DBInstanceClass", + "Engine" + ], + "members":{ + "DBName":{"shape":"String"}, + "DBInstanceIdentifier":{"shape":"String"}, + "AllocatedStorage":{"shape":"IntegerOptional"}, + "DBInstanceClass":{"shape":"String"}, + "Engine":{"shape":"String"}, + "MasterUsername":{"shape":"String"}, + "MasterUserPassword":{"shape":"String"}, + "DBSecurityGroups":{"shape":"DBSecurityGroupNameList"}, + "VpcSecurityGroupIds":{"shape":"VpcSecurityGroupIdList"}, + "AvailabilityZone":{"shape":"String"}, + "DBSubnetGroupName":{"shape":"String"}, + "PreferredMaintenanceWindow":{"shape":"String"}, + "DBParameterGroupName":{"shape":"String"}, + "BackupRetentionPeriod":{"shape":"IntegerOptional"}, + "PreferredBackupWindow":{"shape":"String"}, + "Port":{"shape":"IntegerOptional"}, + "MultiAZ":{"shape":"BooleanOptional"}, + "EngineVersion":{"shape":"String"}, + "AutoMinorVersionUpgrade":{"shape":"BooleanOptional"}, + "LicenseModel":{"shape":"String"}, + "Iops":{"shape":"IntegerOptional"}, + "OptionGroupName":{"shape":"String"}, + "CharacterSetName":{"shape":"String"}, + "PubliclyAccessible":{"shape":"BooleanOptional"}, + "Tags":{"shape":"TagList"}, + "DBClusterIdentifier":{"shape":"String"}, + "StorageType":{"shape":"String"}, + "TdeCredentialArn":{"shape":"String"}, + "TdeCredentialPassword":{"shape":"String"}, + "StorageEncrypted":{"shape":"BooleanOptional"}, + "KmsKeyId":{"shape":"String"}, + "Domain":{"shape":"String"}, + "CopyTagsToSnapshot":{"shape":"BooleanOptional"}, + "MonitoringInterval":{"shape":"IntegerOptional"}, + "MonitoringRoleArn":{"shape":"String"}, + "DomainIAMRoleName":{"shape":"String"}, + "PromotionTier":{"shape":"IntegerOptional"} + } + }, + "CreateDBInstanceReadReplicaMessage":{ + "type":"structure", + "required":[ + "DBInstanceIdentifier", + "SourceDBInstanceIdentifier" + ], + "members":{ + "DBInstanceIdentifier":{"shape":"String"}, + "SourceDBInstanceIdentifier":{"shape":"String"}, + "DBInstanceClass":{"shape":"String"}, + "AvailabilityZone":{"shape":"String"}, + "Port":{"shape":"IntegerOptional"}, + "AutoMinorVersionUpgrade":{"shape":"BooleanOptional"}, + "Iops":{"shape":"IntegerOptional"}, + "OptionGroupName":{"shape":"String"}, + "PubliclyAccessible":{"shape":"BooleanOptional"}, + "Tags":{"shape":"TagList"}, + "DBSubnetGroupName":{"shape":"String"}, + "StorageType":{"shape":"String"}, + "CopyTagsToSnapshot":{"shape":"BooleanOptional"}, + "MonitoringInterval":{"shape":"IntegerOptional"}, + "MonitoringRoleArn":{"shape":"String"} + } + }, + "CreateDBInstanceReadReplicaResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "CreateDBInstanceResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "CreateDBParameterGroupMessage":{ + "type":"structure", + "required":[ + "DBParameterGroupName", + "DBParameterGroupFamily", + "Description" + ], + "members":{ + "DBParameterGroupName":{"shape":"String"}, + "DBParameterGroupFamily":{"shape":"String"}, + "Description":{"shape":"String"}, + "Tags":{"shape":"TagList"} + } + }, + "CreateDBParameterGroupResult":{ + "type":"structure", + "members":{ + "DBParameterGroup":{"shape":"DBParameterGroup"} + } + }, + "CreateDBSecurityGroupMessage":{ + "type":"structure", + "required":[ + "DBSecurityGroupName", + "DBSecurityGroupDescription" + ], + "members":{ + "DBSecurityGroupName":{"shape":"String"}, + "DBSecurityGroupDescription":{"shape":"String"}, + "Tags":{"shape":"TagList"} + } + }, + "CreateDBSecurityGroupResult":{ + "type":"structure", + "members":{ + "DBSecurityGroup":{"shape":"DBSecurityGroup"} + } + }, + "CreateDBSnapshotMessage":{ + "type":"structure", + "required":[ + "DBSnapshotIdentifier", + "DBInstanceIdentifier" + ], + "members":{ + "DBSnapshotIdentifier":{"shape":"String"}, + "DBInstanceIdentifier":{"shape":"String"}, + "Tags":{"shape":"TagList"} + } + }, + "CreateDBSnapshotResult":{ + "type":"structure", + "members":{ + "DBSnapshot":{"shape":"DBSnapshot"} + } + }, + "CreateDBSubnetGroupMessage":{ + "type":"structure", + "required":[ + "DBSubnetGroupName", + "DBSubnetGroupDescription", + "SubnetIds" + ], + "members":{ + "DBSubnetGroupName":{"shape":"String"}, + "DBSubnetGroupDescription":{"shape":"String"}, + "SubnetIds":{"shape":"SubnetIdentifierList"}, + "Tags":{"shape":"TagList"} + } + }, + "CreateDBSubnetGroupResult":{ + "type":"structure", + "members":{ + "DBSubnetGroup":{"shape":"DBSubnetGroup"} + } + }, + "CreateEventSubscriptionMessage":{ + "type":"structure", + "required":[ + "SubscriptionName", + "SnsTopicArn" + ], + "members":{ + "SubscriptionName":{"shape":"String"}, + "SnsTopicArn":{"shape":"String"}, + "SourceType":{"shape":"String"}, + "EventCategories":{"shape":"EventCategoriesList"}, + "SourceIds":{"shape":"SourceIdsList"}, + "Enabled":{"shape":"BooleanOptional"}, + "Tags":{"shape":"TagList"} + } + }, + "CreateEventSubscriptionResult":{ + "type":"structure", + "members":{ + "EventSubscription":{"shape":"EventSubscription"} + } + }, + "CreateOptionGroupMessage":{ + "type":"structure", + "required":[ + "OptionGroupName", + "EngineName", + "MajorEngineVersion", + "OptionGroupDescription" + ], + "members":{ + "OptionGroupName":{"shape":"String"}, + "EngineName":{"shape":"String"}, + "MajorEngineVersion":{"shape":"String"}, + "OptionGroupDescription":{"shape":"String"}, + "Tags":{"shape":"TagList"} + } + }, + "CreateOptionGroupResult":{ + "type":"structure", + "members":{ + "OptionGroup":{"shape":"OptionGroup"} + } + }, + "DBCluster":{ + "type":"structure", + "members":{ + "AllocatedStorage":{"shape":"IntegerOptional"}, + "AvailabilityZones":{"shape":"AvailabilityZones"}, + "BackupRetentionPeriod":{"shape":"IntegerOptional"}, + "CharacterSetName":{"shape":"String"}, + "DatabaseName":{"shape":"String"}, + "DBClusterIdentifier":{"shape":"String"}, + "DBClusterParameterGroup":{"shape":"String"}, + "DBSubnetGroup":{"shape":"String"}, + "Status":{"shape":"String"}, + "PercentProgress":{"shape":"String"}, + "EarliestRestorableTime":{"shape":"TStamp"}, + "Endpoint":{"shape":"String"}, + "Engine":{"shape":"String"}, + "EngineVersion":{"shape":"String"}, + "LatestRestorableTime":{"shape":"TStamp"}, + "Port":{"shape":"IntegerOptional"}, + "MasterUsername":{"shape":"String"}, + "DBClusterOptionGroupMemberships":{"shape":"DBClusterOptionGroupMemberships"}, + "PreferredBackupWindow":{"shape":"String"}, + "PreferredMaintenanceWindow":{"shape":"String"}, + "ReplicationSourceIdentifier":{"shape":"String"}, + "ReadReplicaIdentifiers":{"shape":"ReadReplicaIdentifierList"}, + "DBClusterMembers":{"shape":"DBClusterMemberList"}, + "VpcSecurityGroups":{"shape":"VpcSecurityGroupMembershipList"}, + "HostedZoneId":{"shape":"String"}, + "StorageEncrypted":{"shape":"Boolean"}, + "KmsKeyId":{"shape":"String"}, + "DbClusterResourceId":{"shape":"String"} + }, + "wrapper":true + }, + "DBClusterAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBClusterAlreadyExistsFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBClusterList":{ + "type":"list", + "member":{ + "shape":"DBCluster", + "locationName":"DBCluster" + } + }, + "DBClusterMember":{ + "type":"structure", + "members":{ + "DBInstanceIdentifier":{"shape":"String"}, + "IsClusterWriter":{"shape":"Boolean"}, + "DBClusterParameterGroupStatus":{"shape":"String"}, + "PromotionTier":{"shape":"IntegerOptional"} + }, + "wrapper":true + }, + "DBClusterMemberList":{ + "type":"list", + "member":{ + "shape":"DBClusterMember", + "locationName":"DBClusterMember" + } + }, + "DBClusterMessage":{ + "type":"structure", + "members":{ + "Marker":{"shape":"String"}, + "DBClusters":{"shape":"DBClusterList"} + } + }, + "DBClusterNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBClusterNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "DBClusterOptionGroupMemberships":{ + "type":"list", + "member":{ + "shape":"DBClusterOptionGroupStatus", + "locationName":"DBClusterOptionGroup" + } + }, + "DBClusterOptionGroupStatus":{ + "type":"structure", + "members":{ + "DBClusterOptionGroupName":{"shape":"String"}, + "Status":{"shape":"String"} + } + }, + "DBClusterParameterGroup":{ + "type":"structure", + "members":{ + "DBClusterParameterGroupName":{"shape":"String"}, + "DBParameterGroupFamily":{"shape":"String"}, + "Description":{"shape":"String"} + }, + "wrapper":true + }, + "DBClusterParameterGroupDetails":{ + "type":"structure", + "members":{ + "Parameters":{"shape":"ParametersList"}, + "Marker":{"shape":"String"} + } + }, + "DBClusterParameterGroupList":{ + "type":"list", + "member":{ + "shape":"DBClusterParameterGroup", + "locationName":"DBClusterParameterGroup" + } + }, + "DBClusterParameterGroupNameMessage":{ + "type":"structure", + "members":{ + "DBClusterParameterGroupName":{"shape":"String"} + } + }, + "DBClusterParameterGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBClusterParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "DBClusterParameterGroupsMessage":{ + "type":"structure", + "members":{ + "Marker":{"shape":"String"}, + "DBClusterParameterGroups":{"shape":"DBClusterParameterGroupList"} + } + }, + "DBClusterQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBClusterQuotaExceededFault", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "DBClusterSnapshot":{ + "type":"structure", + "members":{ + "AvailabilityZones":{"shape":"AvailabilityZones"}, + "DBClusterSnapshotIdentifier":{"shape":"String"}, + "DBClusterIdentifier":{"shape":"String"}, + "SnapshotCreateTime":{"shape":"TStamp"}, + "Engine":{"shape":"String"}, + "AllocatedStorage":{"shape":"Integer"}, + "Status":{"shape":"String"}, + "Port":{"shape":"Integer"}, + "VpcId":{"shape":"String"}, + "ClusterCreateTime":{"shape":"TStamp"}, + "MasterUsername":{"shape":"String"}, + "EngineVersion":{"shape":"String"}, + "LicenseModel":{"shape":"String"}, + "SnapshotType":{"shape":"String"}, + "PercentProgress":{"shape":"Integer"}, + "StorageEncrypted":{"shape":"Boolean"}, + "KmsKeyId":{"shape":"String"} + }, + "wrapper":true + }, + "DBClusterSnapshotAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBClusterSnapshotAlreadyExistsFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBClusterSnapshotAttribute":{ + "type":"structure", + "members":{ + "AttributeName":{"shape":"String"}, + "AttributeValues":{"shape":"AttributeValueList"} + } + }, + "DBClusterSnapshotAttributeList":{ + "type":"list", + "member":{ + "shape":"DBClusterSnapshotAttribute", + "locationName":"DBClusterSnapshotAttribute" + } + }, + "DBClusterSnapshotAttributesResult":{ + "type":"structure", + "members":{ + "DBClusterSnapshotIdentifier":{"shape":"String"}, + "DBClusterSnapshotAttributes":{"shape":"DBClusterSnapshotAttributeList"} + }, + "wrapper":true + }, + "DBClusterSnapshotList":{ + "type":"list", + "member":{ + "shape":"DBClusterSnapshot", + "locationName":"DBClusterSnapshot" + } + }, + "DBClusterSnapshotMessage":{ + "type":"structure", + "members":{ + "Marker":{"shape":"String"}, + "DBClusterSnapshots":{"shape":"DBClusterSnapshotList"} + } + }, + "DBClusterSnapshotNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBClusterSnapshotNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "DBEngineVersion":{ + "type":"structure", + "members":{ + "Engine":{"shape":"String"}, + "EngineVersion":{"shape":"String"}, + "DBParameterGroupFamily":{"shape":"String"}, + "DBEngineDescription":{"shape":"String"}, + "DBEngineVersionDescription":{"shape":"String"}, + "DefaultCharacterSet":{"shape":"CharacterSet"}, + "SupportedCharacterSets":{"shape":"SupportedCharacterSetsList"}, + "ValidUpgradeTarget":{"shape":"ValidUpgradeTargetList"} + } + }, + "DBEngineVersionList":{ + "type":"list", + "member":{ + "shape":"DBEngineVersion", + "locationName":"DBEngineVersion" + } + }, + "DBEngineVersionMessage":{ + "type":"structure", + "members":{ + "Marker":{"shape":"String"}, + "DBEngineVersions":{"shape":"DBEngineVersionList"} + } + }, + "DBInstance":{ + "type":"structure", + "members":{ + "DBInstanceIdentifier":{"shape":"String"}, + "DBInstanceClass":{"shape":"String"}, + "Engine":{"shape":"String"}, + "DBInstanceStatus":{"shape":"String"}, + "MasterUsername":{"shape":"String"}, + "DBName":{"shape":"String"}, + "Endpoint":{"shape":"Endpoint"}, + "AllocatedStorage":{"shape":"Integer"}, + "InstanceCreateTime":{"shape":"TStamp"}, + "PreferredBackupWindow":{"shape":"String"}, + "BackupRetentionPeriod":{"shape":"Integer"}, + "DBSecurityGroups":{"shape":"DBSecurityGroupMembershipList"}, + "VpcSecurityGroups":{"shape":"VpcSecurityGroupMembershipList"}, + "DBParameterGroups":{"shape":"DBParameterGroupStatusList"}, + "AvailabilityZone":{"shape":"String"}, + "DBSubnetGroup":{"shape":"DBSubnetGroup"}, + "PreferredMaintenanceWindow":{"shape":"String"}, + "PendingModifiedValues":{"shape":"PendingModifiedValues"}, + "LatestRestorableTime":{"shape":"TStamp"}, + "MultiAZ":{"shape":"Boolean"}, + "EngineVersion":{"shape":"String"}, + "AutoMinorVersionUpgrade":{"shape":"Boolean"}, + "ReadReplicaSourceDBInstanceIdentifier":{"shape":"String"}, + "ReadReplicaDBInstanceIdentifiers":{"shape":"ReadReplicaDBInstanceIdentifierList"}, + "LicenseModel":{"shape":"String"}, + "Iops":{"shape":"IntegerOptional"}, + "OptionGroupMemberships":{"shape":"OptionGroupMembershipList"}, + "CharacterSetName":{"shape":"String"}, + "SecondaryAvailabilityZone":{"shape":"String"}, + "PubliclyAccessible":{"shape":"Boolean"}, + "StatusInfos":{"shape":"DBInstanceStatusInfoList"}, + "StorageType":{"shape":"String"}, + "TdeCredentialArn":{"shape":"String"}, + "DbInstancePort":{"shape":"Integer"}, + "DBClusterIdentifier":{"shape":"String"}, + "StorageEncrypted":{"shape":"Boolean"}, + "KmsKeyId":{"shape":"String"}, + "DbiResourceId":{"shape":"String"}, + "CACertificateIdentifier":{"shape":"String"}, + "DomainMemberships":{"shape":"DomainMembershipList"}, + "CopyTagsToSnapshot":{"shape":"Boolean"}, + "MonitoringInterval":{"shape":"IntegerOptional"}, + "EnhancedMonitoringResourceArn":{"shape":"String"}, + "MonitoringRoleArn":{"shape":"String"}, + "PromotionTier":{"shape":"IntegerOptional"} + }, + "wrapper":true + }, + "DBInstanceAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBInstanceAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBInstanceList":{ + "type":"list", + "member":{ + "shape":"DBInstance", + "locationName":"DBInstance" + } + }, + "DBInstanceMessage":{ + "type":"structure", + "members":{ + "Marker":{"shape":"String"}, + "DBInstances":{"shape":"DBInstanceList"} + } + }, + "DBInstanceNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "DBInstanceStatusInfo":{ + "type":"structure", + "members":{ + "StatusType":{"shape":"String"}, + "Normal":{"shape":"Boolean"}, + "Status":{"shape":"String"}, + "Message":{"shape":"String"} + } + }, + "DBInstanceStatusInfoList":{ + "type":"list", + "member":{ + "shape":"DBInstanceStatusInfo", + "locationName":"DBInstanceStatusInfo" + } + }, + "DBLogFileNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBLogFileNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "DBParameterGroup":{ + "type":"structure", + "members":{ + "DBParameterGroupName":{"shape":"String"}, + "DBParameterGroupFamily":{"shape":"String"}, + "Description":{"shape":"String"} + }, + "wrapper":true + }, + "DBParameterGroupAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBParameterGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBParameterGroupDetails":{ + "type":"structure", + "members":{ + "Parameters":{"shape":"ParametersList"}, + "Marker":{"shape":"String"} + } + }, + "DBParameterGroupList":{ + "type":"list", + "member":{ + "shape":"DBParameterGroup", + "locationName":"DBParameterGroup" + } + }, + "DBParameterGroupNameMessage":{ + "type":"structure", + "members":{ + "DBParameterGroupName":{"shape":"String"} + } + }, + "DBParameterGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "DBParameterGroupQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBParameterGroupQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBParameterGroupStatus":{ + "type":"structure", + "members":{ + "DBParameterGroupName":{"shape":"String"}, + "ParameterApplyStatus":{"shape":"String"} + } + }, + "DBParameterGroupStatusList":{ + "type":"list", + "member":{ + "shape":"DBParameterGroupStatus", + "locationName":"DBParameterGroup" + } + }, + "DBParameterGroupsMessage":{ + "type":"structure", + "members":{ + "Marker":{"shape":"String"}, + "DBParameterGroups":{"shape":"DBParameterGroupList"} + } + }, + "DBSecurityGroup":{ + "type":"structure", + "members":{ + "OwnerId":{"shape":"String"}, + "DBSecurityGroupName":{"shape":"String"}, + "DBSecurityGroupDescription":{"shape":"String"}, + "VpcId":{"shape":"String"}, + "EC2SecurityGroups":{"shape":"EC2SecurityGroupList"}, + "IPRanges":{"shape":"IPRangeList"} + }, + "wrapper":true + }, + "DBSecurityGroupAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSecurityGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBSecurityGroupMembership":{ + "type":"structure", + "members":{ + "DBSecurityGroupName":{"shape":"String"}, + "Status":{"shape":"String"} + } + }, + "DBSecurityGroupMembershipList":{ + "type":"list", + "member":{ + "shape":"DBSecurityGroupMembership", + "locationName":"DBSecurityGroup" + } + }, + "DBSecurityGroupMessage":{ + "type":"structure", + "members":{ + "Marker":{"shape":"String"}, + "DBSecurityGroups":{"shape":"DBSecurityGroups"} + } + }, + "DBSecurityGroupNameList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"DBSecurityGroupName" + } + }, + "DBSecurityGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSecurityGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "DBSecurityGroupNotSupportedFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSecurityGroupNotSupported", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBSecurityGroupQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"QuotaExceeded.DBSecurityGroup", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBSecurityGroups":{ + "type":"list", + "member":{ + "shape":"DBSecurityGroup", + "locationName":"DBSecurityGroup" + } + }, + "DBSnapshot":{ + "type":"structure", + "members":{ + "DBSnapshotIdentifier":{"shape":"String"}, + "DBInstanceIdentifier":{"shape":"String"}, + "SnapshotCreateTime":{"shape":"TStamp"}, + "Engine":{"shape":"String"}, + "AllocatedStorage":{"shape":"Integer"}, + "Status":{"shape":"String"}, + "Port":{"shape":"Integer"}, + "AvailabilityZone":{"shape":"String"}, + "VpcId":{"shape":"String"}, + "InstanceCreateTime":{"shape":"TStamp"}, + "MasterUsername":{"shape":"String"}, + "EngineVersion":{"shape":"String"}, + "LicenseModel":{"shape":"String"}, + "SnapshotType":{"shape":"String"}, + "Iops":{"shape":"IntegerOptional"}, + "OptionGroupName":{"shape":"String"}, + "PercentProgress":{"shape":"Integer"}, + "SourceRegion":{"shape":"String"}, + "SourceDBSnapshotIdentifier":{"shape":"String"}, + "StorageType":{"shape":"String"}, + "TdeCredentialArn":{"shape":"String"}, + "Encrypted":{"shape":"Boolean"}, + "KmsKeyId":{"shape":"String"} + }, + "wrapper":true + }, + "DBSnapshotAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSnapshotAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBSnapshotAttribute":{ + "type":"structure", + "members":{ + "AttributeName":{"shape":"String"}, + "AttributeValues":{"shape":"AttributeValueList"} + }, + "wrapper":true + }, + "DBSnapshotAttributeList":{ + "type":"list", + "member":{ + "shape":"DBSnapshotAttribute", + "locationName":"DBSnapshotAttribute" + } + }, + "DBSnapshotAttributesResult":{ + "type":"structure", + "members":{ + "DBSnapshotIdentifier":{"shape":"String"}, + "DBSnapshotAttributes":{"shape":"DBSnapshotAttributeList"} + }, + "wrapper":true + }, + "DBSnapshotList":{ + "type":"list", + "member":{ + "shape":"DBSnapshot", + "locationName":"DBSnapshot" + } + }, + "DBSnapshotMessage":{ + "type":"structure", + "members":{ + "Marker":{"shape":"String"}, + "DBSnapshots":{"shape":"DBSnapshotList"} + } + }, + "DBSnapshotNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSnapshotNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "DBSubnetGroup":{ + "type":"structure", + "members":{ + "DBSubnetGroupName":{"shape":"String"}, + "DBSubnetGroupDescription":{"shape":"String"}, + "VpcId":{"shape":"String"}, + "SubnetGroupStatus":{"shape":"String"}, + "Subnets":{"shape":"SubnetList"} + }, + "wrapper":true + }, + "DBSubnetGroupAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSubnetGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBSubnetGroupDoesNotCoverEnoughAZs":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSubnetGroupDoesNotCoverEnoughAZs", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBSubnetGroupMessage":{ + "type":"structure", + "members":{ + "Marker":{"shape":"String"}, + "DBSubnetGroups":{"shape":"DBSubnetGroups"} + } + }, + "DBSubnetGroupNotAllowedFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSubnetGroupNotAllowedFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBSubnetGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSubnetGroupNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "DBSubnetGroupQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSubnetGroupQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBSubnetGroups":{ + "type":"list", + "member":{ + "shape":"DBSubnetGroup", + "locationName":"DBSubnetGroup" + } + }, + "DBSubnetQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSubnetQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBUpgradeDependencyFailureFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBUpgradeDependencyFailure", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DeleteDBClusterMessage":{ + "type":"structure", + "required":["DBClusterIdentifier"], + "members":{ + "DBClusterIdentifier":{"shape":"String"}, + "SkipFinalSnapshot":{"shape":"Boolean"}, + "FinalDBSnapshotIdentifier":{"shape":"String"} + } + }, + "DeleteDBClusterParameterGroupMessage":{ + "type":"structure", + "required":["DBClusterParameterGroupName"], + "members":{ + "DBClusterParameterGroupName":{"shape":"String"} + } + }, + "DeleteDBClusterResult":{ + "type":"structure", + "members":{ + "DBCluster":{"shape":"DBCluster"} + } + }, + "DeleteDBClusterSnapshotMessage":{ + "type":"structure", + "required":["DBClusterSnapshotIdentifier"], + "members":{ + "DBClusterSnapshotIdentifier":{"shape":"String"} + } + }, + "DeleteDBClusterSnapshotResult":{ + "type":"structure", + "members":{ + "DBClusterSnapshot":{"shape":"DBClusterSnapshot"} + } + }, + "DeleteDBInstanceMessage":{ + "type":"structure", + "required":["DBInstanceIdentifier"], + "members":{ + "DBInstanceIdentifier":{"shape":"String"}, + "SkipFinalSnapshot":{"shape":"Boolean"}, + "FinalDBSnapshotIdentifier":{"shape":"String"} + } + }, + "DeleteDBInstanceResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "DeleteDBParameterGroupMessage":{ + "type":"structure", + "required":["DBParameterGroupName"], + "members":{ + "DBParameterGroupName":{"shape":"String"} + } + }, + "DeleteDBSecurityGroupMessage":{ + "type":"structure", + "required":["DBSecurityGroupName"], + "members":{ + "DBSecurityGroupName":{"shape":"String"} + } + }, + "DeleteDBSnapshotMessage":{ + "type":"structure", + "required":["DBSnapshotIdentifier"], + "members":{ + "DBSnapshotIdentifier":{"shape":"String"} + } + }, + "DeleteDBSnapshotResult":{ + "type":"structure", + "members":{ + "DBSnapshot":{"shape":"DBSnapshot"} + } + }, + "DeleteDBSubnetGroupMessage":{ + "type":"structure", + "required":["DBSubnetGroupName"], + "members":{ + "DBSubnetGroupName":{"shape":"String"} + } + }, + "DeleteEventSubscriptionMessage":{ + "type":"structure", + "required":["SubscriptionName"], + "members":{ + "SubscriptionName":{"shape":"String"} + } + }, + "DeleteEventSubscriptionResult":{ + "type":"structure", + "members":{ + "EventSubscription":{"shape":"EventSubscription"} + } + }, + "DeleteOptionGroupMessage":{ + "type":"structure", + "required":["OptionGroupName"], + "members":{ + "OptionGroupName":{"shape":"String"} + } + }, + "DescribeAccountAttributesMessage":{ + "type":"structure", + "members":{ + } + }, + "DescribeCertificatesMessage":{ + "type":"structure", + "members":{ + "CertificateIdentifier":{"shape":"String"}, + "Filters":{"shape":"FilterList"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "DescribeDBClusterParameterGroupsMessage":{ + "type":"structure", + "members":{ + "DBClusterParameterGroupName":{"shape":"String"}, + "Filters":{"shape":"FilterList"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "DescribeDBClusterParametersMessage":{ + "type":"structure", + "required":["DBClusterParameterGroupName"], + "members":{ + "DBClusterParameterGroupName":{"shape":"String"}, + "Source":{"shape":"String"}, + "Filters":{"shape":"FilterList"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "DescribeDBClusterSnapshotAttributesMessage":{ + "type":"structure", + "required":["DBClusterSnapshotIdentifier"], + "members":{ + "DBClusterSnapshotIdentifier":{"shape":"String"} + } + }, + "DescribeDBClusterSnapshotAttributesResult":{ + "type":"structure", + "members":{ + "DBClusterSnapshotAttributesResult":{"shape":"DBClusterSnapshotAttributesResult"} + } + }, + "DescribeDBClusterSnapshotsMessage":{ + "type":"structure", + "members":{ + "DBClusterIdentifier":{"shape":"String"}, + "DBClusterSnapshotIdentifier":{"shape":"String"}, + "SnapshotType":{"shape":"String"}, + "Filters":{"shape":"FilterList"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"}, + "IncludeShared":{"shape":"Boolean"}, + "IncludePublic":{"shape":"Boolean"} + } + }, + "DescribeDBClustersMessage":{ + "type":"structure", + "members":{ + "DBClusterIdentifier":{"shape":"String"}, + "Filters":{"shape":"FilterList"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "DescribeDBEngineVersionsMessage":{ + "type":"structure", + "members":{ + "Engine":{"shape":"String"}, + "EngineVersion":{"shape":"String"}, + "DBParameterGroupFamily":{"shape":"String"}, + "Filters":{"shape":"FilterList"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"}, + "DefaultOnly":{"shape":"Boolean"}, + "ListSupportedCharacterSets":{"shape":"BooleanOptional"} + } + }, + "DescribeDBInstancesMessage":{ + "type":"structure", + "members":{ + "DBInstanceIdentifier":{"shape":"String"}, + "Filters":{"shape":"FilterList"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "DescribeDBLogFilesDetails":{ + "type":"structure", + "members":{ + "LogFileName":{"shape":"String"}, + "LastWritten":{"shape":"Long"}, + "Size":{"shape":"Long"} + } + }, + "DescribeDBLogFilesList":{ + "type":"list", + "member":{ + "shape":"DescribeDBLogFilesDetails", + "locationName":"DescribeDBLogFilesDetails" + } + }, + "DescribeDBLogFilesMessage":{ + "type":"structure", + "required":["DBInstanceIdentifier"], + "members":{ + "DBInstanceIdentifier":{"shape":"String"}, + "FilenameContains":{"shape":"String"}, + "FileLastWritten":{"shape":"Long"}, + "FileSize":{"shape":"Long"}, + "Filters":{"shape":"FilterList"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "DescribeDBLogFilesResponse":{ + "type":"structure", + "members":{ + "DescribeDBLogFiles":{"shape":"DescribeDBLogFilesList"}, + "Marker":{"shape":"String"} + } + }, + "DescribeDBParameterGroupsMessage":{ + "type":"structure", + "members":{ + "DBParameterGroupName":{"shape":"String"}, + "Filters":{"shape":"FilterList"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "DescribeDBParametersMessage":{ + "type":"structure", + "required":["DBParameterGroupName"], + "members":{ + "DBParameterGroupName":{"shape":"String"}, + "Source":{"shape":"String"}, + "Filters":{"shape":"FilterList"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "DescribeDBSecurityGroupsMessage":{ + "type":"structure", + "members":{ + "DBSecurityGroupName":{"shape":"String"}, + "Filters":{"shape":"FilterList"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "DescribeDBSnapshotAttributesMessage":{ + "type":"structure", + "required":["DBSnapshotIdentifier"], + "members":{ + "DBSnapshotIdentifier":{"shape":"String"} + } + }, + "DescribeDBSnapshotAttributesResult":{ + "type":"structure", + "members":{ + "DBSnapshotAttributesResult":{"shape":"DBSnapshotAttributesResult"} + } + }, + "DescribeDBSnapshotsMessage":{ + "type":"structure", + "members":{ + "DBInstanceIdentifier":{"shape":"String"}, + "DBSnapshotIdentifier":{"shape":"String"}, + "SnapshotType":{"shape":"String"}, + "Filters":{"shape":"FilterList"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"}, + "IncludeShared":{"shape":"Boolean"}, + "IncludePublic":{"shape":"Boolean"} + } + }, + "DescribeDBSubnetGroupsMessage":{ + "type":"structure", + "members":{ + "DBSubnetGroupName":{"shape":"String"}, + "Filters":{"shape":"FilterList"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "DescribeEngineDefaultClusterParametersMessage":{ + "type":"structure", + "required":["DBParameterGroupFamily"], + "members":{ + "DBParameterGroupFamily":{"shape":"String"}, + "Filters":{"shape":"FilterList"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "DescribeEngineDefaultClusterParametersResult":{ + "type":"structure", + "members":{ + "EngineDefaults":{"shape":"EngineDefaults"} + } + }, + "DescribeEngineDefaultParametersMessage":{ + "type":"structure", + "required":["DBParameterGroupFamily"], + "members":{ + "DBParameterGroupFamily":{"shape":"String"}, + "Filters":{"shape":"FilterList"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "DescribeEngineDefaultParametersResult":{ + "type":"structure", + "members":{ + "EngineDefaults":{"shape":"EngineDefaults"} + } + }, + "DescribeEventCategoriesMessage":{ + "type":"structure", + "members":{ + "SourceType":{"shape":"String"}, + "Filters":{"shape":"FilterList"} + } + }, + "DescribeEventSubscriptionsMessage":{ + "type":"structure", + "members":{ + "SubscriptionName":{"shape":"String"}, + "Filters":{"shape":"FilterList"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "DescribeEventsMessage":{ + "type":"structure", + "members":{ + "SourceIdentifier":{"shape":"String"}, + "SourceType":{"shape":"SourceType"}, + "StartTime":{"shape":"TStamp"}, + "EndTime":{"shape":"TStamp"}, + "Duration":{"shape":"IntegerOptional"}, + "EventCategories":{"shape":"EventCategoriesList"}, + "Filters":{"shape":"FilterList"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "DescribeOptionGroupOptionsMessage":{ + "type":"structure", + "required":["EngineName"], + "members":{ + "EngineName":{"shape":"String"}, + "MajorEngineVersion":{"shape":"String"}, + "Filters":{"shape":"FilterList"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "DescribeOptionGroupsMessage":{ + "type":"structure", + "members":{ + "OptionGroupName":{"shape":"String"}, + "Filters":{"shape":"FilterList"}, + "Marker":{"shape":"String"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "EngineName":{"shape":"String"}, + "MajorEngineVersion":{"shape":"String"} + } + }, + "DescribeOrderableDBInstanceOptionsMessage":{ + "type":"structure", + "required":["Engine"], + "members":{ + "Engine":{"shape":"String"}, + "EngineVersion":{"shape":"String"}, + "DBInstanceClass":{"shape":"String"}, + "LicenseModel":{"shape":"String"}, + "Vpc":{"shape":"BooleanOptional"}, + "Filters":{"shape":"FilterList"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "DescribePendingMaintenanceActionsMessage":{ + "type":"structure", + "members":{ + "ResourceIdentifier":{"shape":"String"}, + "Filters":{"shape":"FilterList"}, + "Marker":{"shape":"String"}, + "MaxRecords":{"shape":"IntegerOptional"} + } + }, + "DescribeReservedDBInstancesMessage":{ + "type":"structure", + "members":{ + "ReservedDBInstanceId":{"shape":"String"}, + "ReservedDBInstancesOfferingId":{"shape":"String"}, + "DBInstanceClass":{"shape":"String"}, + "Duration":{"shape":"String"}, + "ProductDescription":{"shape":"String"}, + "OfferingType":{"shape":"String"}, + "MultiAZ":{"shape":"BooleanOptional"}, + "Filters":{"shape":"FilterList"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "DescribeReservedDBInstancesOfferingsMessage":{ + "type":"structure", + "members":{ + "ReservedDBInstancesOfferingId":{"shape":"String"}, + "DBInstanceClass":{"shape":"String"}, + "Duration":{"shape":"String"}, + "ProductDescription":{"shape":"String"}, + "OfferingType":{"shape":"String"}, + "MultiAZ":{"shape":"BooleanOptional"}, + "Filters":{"shape":"FilterList"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "DomainMembership":{ + "type":"structure", + "members":{ + "Domain":{"shape":"String"}, + "Status":{"shape":"String"}, + "FQDN":{"shape":"String"}, + "IAMRoleName":{"shape":"String"} + } + }, + "DomainMembershipList":{ + "type":"list", + "member":{ + "shape":"DomainMembership", + "locationName":"DomainMembership" + } + }, + "DomainNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DomainNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "Double":{"type":"double"}, + "DownloadDBLogFilePortionDetails":{ + "type":"structure", + "members":{ + "LogFileData":{"shape":"String"}, + "Marker":{"shape":"String"}, + "AdditionalDataPending":{"shape":"Boolean"} + } + }, + "DownloadDBLogFilePortionMessage":{ + "type":"structure", + "required":[ + "DBInstanceIdentifier", + "LogFileName" + ], + "members":{ + "DBInstanceIdentifier":{"shape":"String"}, + "LogFileName":{"shape":"String"}, + "Marker":{"shape":"String"}, + "NumberOfLines":{"shape":"Integer"} + } + }, + "EC2SecurityGroup":{ + "type":"structure", + "members":{ + "Status":{"shape":"String"}, + "EC2SecurityGroupName":{"shape":"String"}, + "EC2SecurityGroupId":{"shape":"String"}, + "EC2SecurityGroupOwnerId":{"shape":"String"} + } + }, + "EC2SecurityGroupList":{ + "type":"list", + "member":{ + "shape":"EC2SecurityGroup", + "locationName":"EC2SecurityGroup" + } + }, + "Endpoint":{ + "type":"structure", + "members":{ + "Address":{"shape":"String"}, + "Port":{"shape":"Integer"}, + "HostedZoneId":{"shape":"String"} + } + }, + "EngineDefaults":{ + "type":"structure", + "members":{ + "DBParameterGroupFamily":{"shape":"String"}, + "Marker":{"shape":"String"}, + "Parameters":{"shape":"ParametersList"} + }, + "wrapper":true + }, + "Event":{ + "type":"structure", + "members":{ + "SourceIdentifier":{"shape":"String"}, + "SourceType":{"shape":"SourceType"}, + "Message":{"shape":"String"}, + "EventCategories":{"shape":"EventCategoriesList"}, + "Date":{"shape":"TStamp"} + } + }, + "EventCategoriesList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"EventCategory" + } + }, + "EventCategoriesMap":{ + "type":"structure", + "members":{ + "SourceType":{"shape":"String"}, + "EventCategories":{"shape":"EventCategoriesList"} + }, + "wrapper":true + }, + "EventCategoriesMapList":{ + "type":"list", + "member":{ + "shape":"EventCategoriesMap", + "locationName":"EventCategoriesMap" + } + }, + "EventCategoriesMessage":{ + "type":"structure", + "members":{ + "EventCategoriesMapList":{"shape":"EventCategoriesMapList"} + } + }, + "EventList":{ + "type":"list", + "member":{ + "shape":"Event", + "locationName":"Event" + } + }, + "EventSubscription":{ + "type":"structure", + "members":{ + "CustomerAwsId":{"shape":"String"}, + "CustSubscriptionId":{"shape":"String"}, + "SnsTopicArn":{"shape":"String"}, + "Status":{"shape":"String"}, + "SubscriptionCreationTime":{"shape":"String"}, + "SourceType":{"shape":"String"}, + "SourceIdsList":{"shape":"SourceIdsList"}, + "EventCategoriesList":{"shape":"EventCategoriesList"}, + "Enabled":{"shape":"Boolean"} + }, + "wrapper":true + }, + "EventSubscriptionQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"EventSubscriptionQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "EventSubscriptionsList":{ + "type":"list", + "member":{ + "shape":"EventSubscription", + "locationName":"EventSubscription" + } + }, + "EventSubscriptionsMessage":{ + "type":"structure", + "members":{ + "Marker":{"shape":"String"}, + "EventSubscriptionsList":{"shape":"EventSubscriptionsList"} + } + }, + "EventsMessage":{ + "type":"structure", + "members":{ + "Marker":{"shape":"String"}, + "Events":{"shape":"EventList"} + } + }, + "FailoverDBClusterMessage":{ + "type":"structure", + "members":{ + "DBClusterIdentifier":{"shape":"String"} + } + }, + "FailoverDBClusterResult":{ + "type":"structure", + "members":{ + "DBCluster":{"shape":"DBCluster"} + } + }, + "Filter":{ + "type":"structure", + "required":[ + "Name", + "Values" + ], + "members":{ + "Name":{"shape":"String"}, + "Values":{"shape":"FilterValueList"} + } + }, + "FilterList":{ + "type":"list", + "member":{ + "shape":"Filter", + "locationName":"Filter" + } + }, + "FilterValueList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"Value" + } + }, + "IPRange":{ + "type":"structure", + "members":{ + "Status":{"shape":"String"}, + "CIDRIP":{"shape":"String"} + } + }, + "IPRangeList":{ + "type":"list", + "member":{ + "shape":"IPRange", + "locationName":"IPRange" + } + }, + "InstanceQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InstanceQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InsufficientDBClusterCapacityFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InsufficientDBClusterCapacityFault", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "InsufficientDBInstanceCapacityFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InsufficientDBInstanceCapacity", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InsufficientStorageClusterCapacityFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InsufficientStorageClusterCapacity", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "Integer":{"type":"integer"}, + "IntegerOptional":{"type":"integer"}, + "InvalidDBClusterSnapshotStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidDBClusterSnapshotStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidDBClusterStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidDBClusterStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidDBInstanceStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidDBInstanceState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidDBParameterGroupStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidDBParameterGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidDBSecurityGroupStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidDBSecurityGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidDBSnapshotStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidDBSnapshotState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidDBSubnetGroupFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidDBSubnetGroupFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidDBSubnetGroupStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidDBSubnetGroupStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidDBSubnetStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidDBSubnetStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidEventSubscriptionStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidEventSubscriptionState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidOptionGroupStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidOptionGroupStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidRestoreFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidRestoreFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidSubnet":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidSubnet", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidVPCNetworkStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidVPCNetworkStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "KMSKeyNotAccessibleFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"KMSKeyNotAccessibleFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "KeyList":{ + "type":"list", + "member":{"shape":"String"} + }, + "ListTagsForResourceMessage":{ + "type":"structure", + "required":["ResourceName"], + "members":{ + "ResourceName":{"shape":"String"}, + "Filters":{"shape":"FilterList"} + } + }, + "Long":{"type":"long"}, + "ModifyDBClusterMessage":{ + "type":"structure", + "required":["DBClusterIdentifier"], + "members":{ + "DBClusterIdentifier":{"shape":"String"}, + "NewDBClusterIdentifier":{"shape":"String"}, + "ApplyImmediately":{"shape":"Boolean"}, + "BackupRetentionPeriod":{"shape":"IntegerOptional"}, + "DBClusterParameterGroupName":{"shape":"String"}, + "VpcSecurityGroupIds":{"shape":"VpcSecurityGroupIdList"}, + "Port":{"shape":"IntegerOptional"}, + "MasterUserPassword":{"shape":"String"}, + "OptionGroupName":{"shape":"String"}, + "PreferredBackupWindow":{"shape":"String"}, + "PreferredMaintenanceWindow":{"shape":"String"} + } + }, + "ModifyDBClusterParameterGroupMessage":{ + "type":"structure", + "required":[ + "DBClusterParameterGroupName", + "Parameters" + ], + "members":{ + "DBClusterParameterGroupName":{"shape":"String"}, + "Parameters":{"shape":"ParametersList"} + } + }, + "ModifyDBClusterResult":{ + "type":"structure", + "members":{ + "DBCluster":{"shape":"DBCluster"} + } + }, + "ModifyDBClusterSnapshotAttributeMessage":{ + "type":"structure", + "required":[ + "DBClusterSnapshotIdentifier", + "AttributeName" + ], + "members":{ + "DBClusterSnapshotIdentifier":{"shape":"String"}, + "AttributeName":{"shape":"String"}, + "ValuesToAdd":{"shape":"AttributeValueList"}, + "ValuesToRemove":{"shape":"AttributeValueList"} + } + }, + "ModifyDBClusterSnapshotAttributeResult":{ + "type":"structure", + "members":{ + "DBClusterSnapshotAttributesResult":{"shape":"DBClusterSnapshotAttributesResult"} + } + }, + "ModifyDBInstanceMessage":{ + "type":"structure", + "required":["DBInstanceIdentifier"], + "members":{ + "DBInstanceIdentifier":{"shape":"String"}, + "AllocatedStorage":{"shape":"IntegerOptional"}, + "DBInstanceClass":{"shape":"String"}, + "DBSecurityGroups":{"shape":"DBSecurityGroupNameList"}, + "VpcSecurityGroupIds":{"shape":"VpcSecurityGroupIdList"}, + "ApplyImmediately":{"shape":"Boolean"}, + "MasterUserPassword":{"shape":"String"}, + "DBParameterGroupName":{"shape":"String"}, + "BackupRetentionPeriod":{"shape":"IntegerOptional"}, + "PreferredBackupWindow":{"shape":"String"}, + "PreferredMaintenanceWindow":{"shape":"String"}, + "MultiAZ":{"shape":"BooleanOptional"}, + "EngineVersion":{"shape":"String"}, + "AllowMajorVersionUpgrade":{"shape":"Boolean"}, + "AutoMinorVersionUpgrade":{"shape":"BooleanOptional"}, + "Iops":{"shape":"IntegerOptional"}, + "OptionGroupName":{"shape":"String"}, + "NewDBInstanceIdentifier":{"shape":"String"}, + "StorageType":{"shape":"String"}, + "TdeCredentialArn":{"shape":"String"}, + "TdeCredentialPassword":{"shape":"String"}, + "CACertificateIdentifier":{"shape":"String"}, + "Domain":{"shape":"String"}, + "CopyTagsToSnapshot":{"shape":"BooleanOptional"}, + "MonitoringInterval":{"shape":"IntegerOptional"}, + "DBPortNumber":{"shape":"IntegerOptional"}, + "PubliclyAccessible":{"shape":"BooleanOptional"}, + "MonitoringRoleArn":{"shape":"String"}, + "DomainIAMRoleName":{"shape":"String"}, + "PromotionTier":{"shape":"IntegerOptional"} + } + }, + "ModifyDBInstanceResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "ModifyDBParameterGroupMessage":{ + "type":"structure", + "required":[ + "DBParameterGroupName", + "Parameters" + ], + "members":{ + "DBParameterGroupName":{"shape":"String"}, + "Parameters":{"shape":"ParametersList"} + } + }, + "ModifyDBSnapshotAttributeMessage":{ + "type":"structure", + "required":[ + "DBSnapshotIdentifier", + "AttributeName" + ], + "members":{ + "DBSnapshotIdentifier":{"shape":"String"}, + "AttributeName":{"shape":"String"}, + "ValuesToAdd":{"shape":"AttributeValueList"}, + "ValuesToRemove":{"shape":"AttributeValueList"} + } + }, + "ModifyDBSnapshotAttributeResult":{ + "type":"structure", + "members":{ + "DBSnapshotAttributesResult":{"shape":"DBSnapshotAttributesResult"} + } + }, + "ModifyDBSubnetGroupMessage":{ + "type":"structure", + "required":[ + "DBSubnetGroupName", + "SubnetIds" + ], + "members":{ + "DBSubnetGroupName":{"shape":"String"}, + "DBSubnetGroupDescription":{"shape":"String"}, + "SubnetIds":{"shape":"SubnetIdentifierList"} + } + }, + "ModifyDBSubnetGroupResult":{ + "type":"structure", + "members":{ + "DBSubnetGroup":{"shape":"DBSubnetGroup"} + } + }, + "ModifyEventSubscriptionMessage":{ + "type":"structure", + "required":["SubscriptionName"], + "members":{ + "SubscriptionName":{"shape":"String"}, + "SnsTopicArn":{"shape":"String"}, + "SourceType":{"shape":"String"}, + "EventCategories":{"shape":"EventCategoriesList"}, + "Enabled":{"shape":"BooleanOptional"} + } + }, + "ModifyEventSubscriptionResult":{ + "type":"structure", + "members":{ + "EventSubscription":{"shape":"EventSubscription"} + } + }, + "ModifyOptionGroupMessage":{ + "type":"structure", + "required":["OptionGroupName"], + "members":{ + "OptionGroupName":{"shape":"String"}, + "OptionsToInclude":{"shape":"OptionConfigurationList"}, + "OptionsToRemove":{"shape":"OptionNamesList"}, + "ApplyImmediately":{"shape":"Boolean"} + } + }, + "ModifyOptionGroupResult":{ + "type":"structure", + "members":{ + "OptionGroup":{"shape":"OptionGroup"} + } + }, + "Option":{ + "type":"structure", + "members":{ + "OptionName":{"shape":"String"}, + "OptionDescription":{"shape":"String"}, + "Persistent":{"shape":"Boolean"}, + "Permanent":{"shape":"Boolean"}, + "Port":{"shape":"IntegerOptional"}, + "OptionSettings":{"shape":"OptionSettingConfigurationList"}, + "DBSecurityGroupMemberships":{"shape":"DBSecurityGroupMembershipList"}, + "VpcSecurityGroupMemberships":{"shape":"VpcSecurityGroupMembershipList"} + } + }, + "OptionConfiguration":{ + "type":"structure", + "required":["OptionName"], + "members":{ + "OptionName":{"shape":"String"}, + "Port":{"shape":"IntegerOptional"}, + "DBSecurityGroupMemberships":{"shape":"DBSecurityGroupNameList"}, + "VpcSecurityGroupMemberships":{"shape":"VpcSecurityGroupIdList"}, + "OptionSettings":{"shape":"OptionSettingsList"} + } + }, + "OptionConfigurationList":{ + "type":"list", + "member":{ + "shape":"OptionConfiguration", + "locationName":"OptionConfiguration" + } + }, + "OptionGroup":{ + "type":"structure", + "members":{ + "OptionGroupName":{"shape":"String"}, + "OptionGroupDescription":{"shape":"String"}, + "EngineName":{"shape":"String"}, + "MajorEngineVersion":{"shape":"String"}, + "Options":{"shape":"OptionsList"}, + "AllowsVpcAndNonVpcInstanceMemberships":{"shape":"Boolean"}, + "VpcId":{"shape":"String"} + }, + "wrapper":true + }, + "OptionGroupAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"OptionGroupAlreadyExistsFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "OptionGroupMembership":{ + "type":"structure", + "members":{ + "OptionGroupName":{"shape":"String"}, + "Status":{"shape":"String"} + } + }, + "OptionGroupMembershipList":{ + "type":"list", + "member":{ + "shape":"OptionGroupMembership", + "locationName":"OptionGroupMembership" + } + }, + "OptionGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"OptionGroupNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "OptionGroupOption":{ + "type":"structure", + "members":{ + "Name":{"shape":"String"}, + "Description":{"shape":"String"}, + "EngineName":{"shape":"String"}, + "MajorEngineVersion":{"shape":"String"}, + "MinimumRequiredMinorEngineVersion":{"shape":"String"}, + "PortRequired":{"shape":"Boolean"}, + "DefaultPort":{"shape":"IntegerOptional"}, + "OptionsDependedOn":{"shape":"OptionsDependedOn"}, + "Persistent":{"shape":"Boolean"}, + "Permanent":{"shape":"Boolean"}, + "OptionGroupOptionSettings":{"shape":"OptionGroupOptionSettingsList"} + } + }, + "OptionGroupOptionSetting":{ + "type":"structure", + "members":{ + "SettingName":{"shape":"String"}, + "SettingDescription":{"shape":"String"}, + "DefaultValue":{"shape":"String"}, + "ApplyType":{"shape":"String"}, + "AllowedValues":{"shape":"String"}, + "IsModifiable":{"shape":"Boolean"} + } + }, + "OptionGroupOptionSettingsList":{ + "type":"list", + "member":{ + "shape":"OptionGroupOptionSetting", + "locationName":"OptionGroupOptionSetting" + } + }, + "OptionGroupOptionsList":{ + "type":"list", + "member":{ + "shape":"OptionGroupOption", + "locationName":"OptionGroupOption" + } + }, + "OptionGroupOptionsMessage":{ + "type":"structure", + "members":{ + "OptionGroupOptions":{"shape":"OptionGroupOptionsList"}, + "Marker":{"shape":"String"} + } + }, + "OptionGroupQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"OptionGroupQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "OptionGroups":{ + "type":"structure", + "members":{ + "OptionGroupsList":{"shape":"OptionGroupsList"}, + "Marker":{"shape":"String"} + } + }, + "OptionGroupsList":{ + "type":"list", + "member":{ + "shape":"OptionGroup", + "locationName":"OptionGroup" + } + }, + "OptionNamesList":{ + "type":"list", + "member":{"shape":"String"} + }, + "OptionSetting":{ + "type":"structure", + "members":{ + "Name":{"shape":"String"}, + "Value":{"shape":"String"}, + "DefaultValue":{"shape":"String"}, + "Description":{"shape":"String"}, + "ApplyType":{"shape":"String"}, + "DataType":{"shape":"String"}, + "AllowedValues":{"shape":"String"}, + "IsModifiable":{"shape":"Boolean"}, + "IsCollection":{"shape":"Boolean"} + } + }, + "OptionSettingConfigurationList":{ + "type":"list", + "member":{ + "shape":"OptionSetting", + "locationName":"OptionSetting" + } + }, + "OptionSettingsList":{ + "type":"list", + "member":{ + "shape":"OptionSetting", + "locationName":"OptionSetting" + } + }, + "OptionsDependedOn":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"OptionName" + } + }, + "OptionsList":{ + "type":"list", + "member":{ + "shape":"Option", + "locationName":"Option" + } + }, + "OrderableDBInstanceOption":{ + "type":"structure", + "members":{ + "Engine":{"shape":"String"}, + "EngineVersion":{"shape":"String"}, + "DBInstanceClass":{"shape":"String"}, + "LicenseModel":{"shape":"String"}, + "AvailabilityZones":{"shape":"AvailabilityZoneList"}, + "MultiAZCapable":{"shape":"Boolean"}, + "ReadReplicaCapable":{"shape":"Boolean"}, + "Vpc":{"shape":"Boolean"}, + "SupportsStorageEncryption":{"shape":"Boolean"}, + "StorageType":{"shape":"String"}, + "SupportsIops":{"shape":"Boolean"}, + "SupportsEnhancedMonitoring":{"shape":"Boolean"} + }, + "wrapper":true + }, + "OrderableDBInstanceOptionsList":{ + "type":"list", + "member":{ + "shape":"OrderableDBInstanceOption", + "locationName":"OrderableDBInstanceOption" + } + }, + "OrderableDBInstanceOptionsMessage":{ + "type":"structure", + "members":{ + "OrderableDBInstanceOptions":{"shape":"OrderableDBInstanceOptionsList"}, + "Marker":{"shape":"String"} + } + }, + "Parameter":{ + "type":"structure", + "members":{ + "ParameterName":{"shape":"String"}, + "ParameterValue":{"shape":"String"}, + "Description":{"shape":"String"}, + "Source":{"shape":"String"}, + "ApplyType":{"shape":"String"}, + "DataType":{"shape":"String"}, + "AllowedValues":{"shape":"String"}, + "IsModifiable":{"shape":"Boolean"}, + "MinimumEngineVersion":{"shape":"String"}, + "ApplyMethod":{"shape":"ApplyMethod"} + } + }, + "ParametersList":{ + "type":"list", + "member":{ + "shape":"Parameter", + "locationName":"Parameter" + } + }, + "PendingMaintenanceAction":{ + "type":"structure", + "members":{ + "Action":{"shape":"String"}, + "AutoAppliedAfterDate":{"shape":"TStamp"}, + "ForcedApplyDate":{"shape":"TStamp"}, + "OptInStatus":{"shape":"String"}, + "CurrentApplyDate":{"shape":"TStamp"}, + "Description":{"shape":"String"} + } + }, + "PendingMaintenanceActionDetails":{ + "type":"list", + "member":{ + "shape":"PendingMaintenanceAction", + "locationName":"PendingMaintenanceAction" + } + }, + "PendingMaintenanceActions":{ + "type":"list", + "member":{ + "shape":"ResourcePendingMaintenanceActions", + "locationName":"ResourcePendingMaintenanceActions" + } + }, + "PendingMaintenanceActionsMessage":{ + "type":"structure", + "members":{ + "PendingMaintenanceActions":{"shape":"PendingMaintenanceActions"}, + "Marker":{"shape":"String"} + } + }, + "PendingModifiedValues":{ + "type":"structure", + "members":{ + "DBInstanceClass":{"shape":"String"}, + "AllocatedStorage":{"shape":"IntegerOptional"}, + "MasterUserPassword":{"shape":"String"}, + "Port":{"shape":"IntegerOptional"}, + "BackupRetentionPeriod":{"shape":"IntegerOptional"}, + "MultiAZ":{"shape":"BooleanOptional"}, + "EngineVersion":{"shape":"String"}, + "Iops":{"shape":"IntegerOptional"}, + "DBInstanceIdentifier":{"shape":"String"}, + "StorageType":{"shape":"String"}, + "CACertificateIdentifier":{"shape":"String"} + } + }, + "PointInTimeRestoreNotEnabledFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"PointInTimeRestoreNotEnabled", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "PromoteReadReplicaDBClusterMessage":{ + "type":"structure", + "required":["DBClusterIdentifier"], + "members":{ + "DBClusterIdentifier":{"shape":"String"} + } + }, + "PromoteReadReplicaDBClusterResult":{ + "type":"structure", + "members":{ + "DBCluster":{"shape":"DBCluster"} + } + }, + "PromoteReadReplicaMessage":{ + "type":"structure", + "required":["DBInstanceIdentifier"], + "members":{ + "DBInstanceIdentifier":{"shape":"String"}, + "BackupRetentionPeriod":{"shape":"IntegerOptional"}, + "PreferredBackupWindow":{"shape":"String"} + } + }, + "PromoteReadReplicaResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "ProvisionedIopsNotAvailableInAZFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ProvisionedIopsNotAvailableInAZFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "PurchaseReservedDBInstancesOfferingMessage":{ + "type":"structure", + "required":["ReservedDBInstancesOfferingId"], + "members":{ + "ReservedDBInstancesOfferingId":{"shape":"String"}, + "ReservedDBInstanceId":{"shape":"String"}, + "DBInstanceCount":{"shape":"IntegerOptional"}, + "Tags":{"shape":"TagList"} + } + }, + "PurchaseReservedDBInstancesOfferingResult":{ + "type":"structure", + "members":{ + "ReservedDBInstance":{"shape":"ReservedDBInstance"} + } + }, + "ReadReplicaDBInstanceIdentifierList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ReadReplicaDBInstanceIdentifier" + } + }, + "ReadReplicaIdentifierList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ReadReplicaIdentifier" + } + }, + "RebootDBInstanceMessage":{ + "type":"structure", + "required":["DBInstanceIdentifier"], + "members":{ + "DBInstanceIdentifier":{"shape":"String"}, + "ForceFailover":{"shape":"BooleanOptional"} + } + }, + "RebootDBInstanceResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "RecurringCharge":{ + "type":"structure", + "members":{ + "RecurringChargeAmount":{"shape":"Double"}, + "RecurringChargeFrequency":{"shape":"String"} + }, + "wrapper":true + }, + "RecurringChargeList":{ + "type":"list", + "member":{ + "shape":"RecurringCharge", + "locationName":"RecurringCharge" + } + }, + "RemoveSourceIdentifierFromSubscriptionMessage":{ + "type":"structure", + "required":[ + "SubscriptionName", + "SourceIdentifier" + ], + "members":{ + "SubscriptionName":{"shape":"String"}, + "SourceIdentifier":{"shape":"String"} + } + }, + "RemoveSourceIdentifierFromSubscriptionResult":{ + "type":"structure", + "members":{ + "EventSubscription":{"shape":"EventSubscription"} + } + }, + "RemoveTagsFromResourceMessage":{ + "type":"structure", + "required":[ + "ResourceName", + "TagKeys" + ], + "members":{ + "ResourceName":{"shape":"String"}, + "TagKeys":{"shape":"KeyList"} + } + }, + "ReservedDBInstance":{ + "type":"structure", + "members":{ + "ReservedDBInstanceId":{"shape":"String"}, + "ReservedDBInstancesOfferingId":{"shape":"String"}, + "DBInstanceClass":{"shape":"String"}, + "StartTime":{"shape":"TStamp"}, + "Duration":{"shape":"Integer"}, + "FixedPrice":{"shape":"Double"}, + "UsagePrice":{"shape":"Double"}, + "CurrencyCode":{"shape":"String"}, + "DBInstanceCount":{"shape":"Integer"}, + "ProductDescription":{"shape":"String"}, + "OfferingType":{"shape":"String"}, + "MultiAZ":{"shape":"Boolean"}, + "State":{"shape":"String"}, + "RecurringCharges":{"shape":"RecurringChargeList"} + }, + "wrapper":true + }, + "ReservedDBInstanceAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ReservedDBInstanceAlreadyExists", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ReservedDBInstanceList":{ + "type":"list", + "member":{ + "shape":"ReservedDBInstance", + "locationName":"ReservedDBInstance" + } + }, + "ReservedDBInstanceMessage":{ + "type":"structure", + "members":{ + "Marker":{"shape":"String"}, + "ReservedDBInstances":{"shape":"ReservedDBInstanceList"} + } + }, + "ReservedDBInstanceNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ReservedDBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ReservedDBInstanceQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ReservedDBInstanceQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ReservedDBInstancesOffering":{ + "type":"structure", + "members":{ + "ReservedDBInstancesOfferingId":{"shape":"String"}, + "DBInstanceClass":{"shape":"String"}, + "Duration":{"shape":"Integer"}, + "FixedPrice":{"shape":"Double"}, + "UsagePrice":{"shape":"Double"}, + "CurrencyCode":{"shape":"String"}, + "ProductDescription":{"shape":"String"}, + "OfferingType":{"shape":"String"}, + "MultiAZ":{"shape":"Boolean"}, + "RecurringCharges":{"shape":"RecurringChargeList"} + }, + "wrapper":true + }, + "ReservedDBInstancesOfferingList":{ + "type":"list", + "member":{ + "shape":"ReservedDBInstancesOffering", + "locationName":"ReservedDBInstancesOffering" + } + }, + "ReservedDBInstancesOfferingMessage":{ + "type":"structure", + "members":{ + "Marker":{"shape":"String"}, + "ReservedDBInstancesOfferings":{"shape":"ReservedDBInstancesOfferingList"} + } + }, + "ReservedDBInstancesOfferingNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ReservedDBInstancesOfferingNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ResetDBClusterParameterGroupMessage":{ + "type":"structure", + "required":["DBClusterParameterGroupName"], + "members":{ + "DBClusterParameterGroupName":{"shape":"String"}, + "ResetAllParameters":{"shape":"Boolean"}, + "Parameters":{"shape":"ParametersList"} + } + }, + "ResetDBParameterGroupMessage":{ + "type":"structure", + "required":["DBParameterGroupName"], + "members":{ + "DBParameterGroupName":{"shape":"String"}, + "ResetAllParameters":{"shape":"Boolean"}, + "Parameters":{"shape":"ParametersList"} + } + }, + "ResourceNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ResourceNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ResourcePendingMaintenanceActions":{ + "type":"structure", + "members":{ + "ResourceIdentifier":{"shape":"String"}, + "PendingMaintenanceActionDetails":{"shape":"PendingMaintenanceActionDetails"} + }, + "wrapper":true + }, + "RestoreDBClusterFromSnapshotMessage":{ + "type":"structure", + "required":[ + "DBClusterIdentifier", + "SnapshotIdentifier", + "Engine" + ], + "members":{ + "AvailabilityZones":{"shape":"AvailabilityZones"}, + "DBClusterIdentifier":{"shape":"String"}, + "SnapshotIdentifier":{"shape":"String"}, + "Engine":{"shape":"String"}, + "EngineVersion":{"shape":"String"}, + "Port":{"shape":"IntegerOptional"}, + "DBSubnetGroupName":{"shape":"String"}, + "DatabaseName":{"shape":"String"}, + "OptionGroupName":{"shape":"String"}, + "VpcSecurityGroupIds":{"shape":"VpcSecurityGroupIdList"}, + "Tags":{"shape":"TagList"}, + "KmsKeyId":{"shape":"String"} + } + }, + "RestoreDBClusterFromSnapshotResult":{ + "type":"structure", + "members":{ + "DBCluster":{"shape":"DBCluster"} + } + }, + "RestoreDBClusterToPointInTimeMessage":{ + "type":"structure", + "required":[ + "DBClusterIdentifier", + "SourceDBClusterIdentifier" + ], + "members":{ + "DBClusterIdentifier":{"shape":"String"}, + "SourceDBClusterIdentifier":{"shape":"String"}, + "RestoreToTime":{"shape":"TStamp"}, + "UseLatestRestorableTime":{"shape":"Boolean"}, + "Port":{"shape":"IntegerOptional"}, + "DBSubnetGroupName":{"shape":"String"}, + "OptionGroupName":{"shape":"String"}, + "VpcSecurityGroupIds":{"shape":"VpcSecurityGroupIdList"}, + "Tags":{"shape":"TagList"}, + "KmsKeyId":{"shape":"String"} + } + }, + "RestoreDBClusterToPointInTimeResult":{ + "type":"structure", + "members":{ + "DBCluster":{"shape":"DBCluster"} + } + }, + "RestoreDBInstanceFromDBSnapshotMessage":{ + "type":"structure", + "required":[ + "DBInstanceIdentifier", + "DBSnapshotIdentifier" + ], + "members":{ + "DBInstanceIdentifier":{"shape":"String"}, + "DBSnapshotIdentifier":{"shape":"String"}, + "DBInstanceClass":{"shape":"String"}, + "Port":{"shape":"IntegerOptional"}, + "AvailabilityZone":{"shape":"String"}, + "DBSubnetGroupName":{"shape":"String"}, + "MultiAZ":{"shape":"BooleanOptional"}, + "PubliclyAccessible":{"shape":"BooleanOptional"}, + "AutoMinorVersionUpgrade":{"shape":"BooleanOptional"}, + "LicenseModel":{"shape":"String"}, + "DBName":{"shape":"String"}, + "Engine":{"shape":"String"}, + "Iops":{"shape":"IntegerOptional"}, + "OptionGroupName":{"shape":"String"}, + "Tags":{"shape":"TagList"}, + "StorageType":{"shape":"String"}, + "TdeCredentialArn":{"shape":"String"}, + "TdeCredentialPassword":{"shape":"String"}, + "Domain":{"shape":"String"}, + "CopyTagsToSnapshot":{"shape":"BooleanOptional"}, + "DomainIAMRoleName":{"shape":"String"} + } + }, + "RestoreDBInstanceFromDBSnapshotResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "RestoreDBInstanceToPointInTimeMessage":{ + "type":"structure", + "required":[ + "SourceDBInstanceIdentifier", + "TargetDBInstanceIdentifier" + ], + "members":{ + "SourceDBInstanceIdentifier":{"shape":"String"}, + "TargetDBInstanceIdentifier":{"shape":"String"}, + "RestoreTime":{"shape":"TStamp"}, + "UseLatestRestorableTime":{"shape":"Boolean"}, + "DBInstanceClass":{"shape":"String"}, + "Port":{"shape":"IntegerOptional"}, + "AvailabilityZone":{"shape":"String"}, + "DBSubnetGroupName":{"shape":"String"}, + "MultiAZ":{"shape":"BooleanOptional"}, + "PubliclyAccessible":{"shape":"BooleanOptional"}, + "AutoMinorVersionUpgrade":{"shape":"BooleanOptional"}, + "LicenseModel":{"shape":"String"}, + "DBName":{"shape":"String"}, + "Engine":{"shape":"String"}, + "Iops":{"shape":"IntegerOptional"}, + "OptionGroupName":{"shape":"String"}, + "CopyTagsToSnapshot":{"shape":"BooleanOptional"}, + "Tags":{"shape":"TagList"}, + "StorageType":{"shape":"String"}, + "TdeCredentialArn":{"shape":"String"}, + "TdeCredentialPassword":{"shape":"String"}, + "Domain":{"shape":"String"}, + "DomainIAMRoleName":{"shape":"String"} + } + }, + "RestoreDBInstanceToPointInTimeResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "RevokeDBSecurityGroupIngressMessage":{ + "type":"structure", + "required":["DBSecurityGroupName"], + "members":{ + "DBSecurityGroupName":{"shape":"String"}, + "CIDRIP":{"shape":"String"}, + "EC2SecurityGroupName":{"shape":"String"}, + "EC2SecurityGroupId":{"shape":"String"}, + "EC2SecurityGroupOwnerId":{"shape":"String"} + } + }, + "RevokeDBSecurityGroupIngressResult":{ + "type":"structure", + "members":{ + "DBSecurityGroup":{"shape":"DBSecurityGroup"} + } + }, + "SNSInvalidTopicFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SNSInvalidTopic", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "SNSNoAuthorizationFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SNSNoAuthorization", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "SNSTopicArnNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SNSTopicArnNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "SharedSnapshotQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SharedSnapshotQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "SnapshotQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SnapshotQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "SourceIdsList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SourceId" + } + }, + "SourceNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SourceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "SourceType":{ + "type":"string", + "enum":[ + "db-instance", + "db-parameter-group", + "db-security-group", + "db-snapshot", + "db-cluster", + "db-cluster-snapshot" + ] + }, + "StorageQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"StorageQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "StorageTypeNotSupportedFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"StorageTypeNotSupported", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "String":{"type":"string"}, + "Subnet":{ + "type":"structure", + "members":{ + "SubnetIdentifier":{"shape":"String"}, + "SubnetAvailabilityZone":{"shape":"AvailabilityZone"}, + "SubnetStatus":{"shape":"String"} + } + }, + "SubnetAlreadyInUse":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SubnetAlreadyInUse", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "SubnetIdentifierList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SubnetIdentifier" + } + }, + "SubnetList":{ + "type":"list", + "member":{ + "shape":"Subnet", + "locationName":"Subnet" + } + }, + "SubscriptionAlreadyExistFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SubscriptionAlreadyExist", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "SubscriptionCategoryNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SubscriptionCategoryNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "SubscriptionNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SubscriptionNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "SupportedCharacterSetsList":{ + "type":"list", + "member":{ + "shape":"CharacterSet", + "locationName":"CharacterSet" + } + }, + "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"} + } + }, + "UpgradeTarget":{ + "type":"structure", + "members":{ + "Engine":{"shape":"String"}, + "EngineVersion":{"shape":"String"}, + "Description":{"shape":"String"}, + "AutoUpgrade":{"shape":"Boolean"}, + "IsMajorVersionUpgrade":{"shape":"Boolean"} + } + }, + "ValidUpgradeTargetList":{ + "type":"list", + "member":{ + "shape":"UpgradeTarget", + "locationName":"UpgradeTarget" + } + }, + "VpcSecurityGroupIdList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"VpcSecurityGroupId" + } + }, + "VpcSecurityGroupMembership":{ + "type":"structure", + "members":{ + "VpcSecurityGroupId":{"shape":"String"}, + "Status":{"shape":"String"} + } + }, + "VpcSecurityGroupMembershipList":{ + "type":"list", + "member":{ + "shape":"VpcSecurityGroupMembership", + "locationName":"VpcSecurityGroupMembership" + } + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/rds/2014-10-31/docs-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/rds/2014-10-31/docs-2.json new file mode 100644 index 000000000..11b4827c3 --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/rds/2014-10-31/docs-2.json @@ -0,0 +1,2755 @@ +{ + "version": "2.0", + "service": "
Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and scale a relational database in the cloud. It provides cost-efficient, resizeable capacity for an industry-standard relational database and manages common database administration tasks, freeing up developers to focus on what makes their applications and businesses unique.
Amazon RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server, Oracle, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS is flexible: you can scale your database instance's compute resources and storage capacity to meet your application's demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for the resources you use.
This interface reference for Amazon RDS contains documentation for a programming or command line interface you can use to manage Amazon RDS. Note that Amazon RDS is asynchronous, which means that some interfaces might require techniques such as polling or callback functions to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, or during the maintenance window. The reference structure is as follows, and we list following some related topics from the user guide.
Amazon RDS API Reference
For the alphabetical list of API actions, see API Actions.
For the alphabetical list of data types, see Data Types.
For a list of common query parameters, see Common Parameters.
For descriptions of the error codes, see Common Errors.
Amazon RDS User Guide
For a summary of the Amazon RDS interfaces, see Available RDS Interfaces.
For more information about how to use the Query API, see Using the Query API.
Adds a source identifier to an existing RDS event notification subscription.
", + "AddTagsToResource": "Adds metadata tags to an Amazon RDS resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon RDS resources, or used in a Condition statement in an IAM policy for Amazon RDS.
For an overview on tagging Amazon RDS resources, see Tagging Amazon RDS Resources.
", + "ApplyPendingMaintenanceAction": "Applies a pending maintenance action to a resource (for example, to a DB instance).
", + "AuthorizeDBSecurityGroupIngress": "Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC instances. Second, IP ranges are available if the application accessing your database is running on the Internet. Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).
You cannot authorize ingress from an EC2 security group in one region to an Amazon RDS DB instance in another. You cannot authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another.
For an overview of CIDR ranges, go to the Wikipedia Tutorial.
", + "CopyDBClusterSnapshot": "Creates a snapshot of a DB cluster. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
", + "CopyDBParameterGroup": "Copies the specified DB parameter group.
", + "CopyDBSnapshot": "Copies the specified DB snapshot. The source DB snapshot must be in the \"available\" state.
If you are copying from a shared manual DB snapshot, the SourceDBSnapshotIdentifier must be the ARN of the shared DB snapshot.
Copies the specified option group.
", + "CreateDBCluster": "Creates a new Amazon Aurora DB cluster.
You can use the ReplicationSourceIdentifier parameter to create the DB cluster as a Read Replica of another DB cluster.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
", + "CreateDBClusterParameterGroup": "Creates a new DB cluster parameter group.
Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster.
A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using ModifyDBCluster. When you associate a new DB cluster parameter group with a running DB cluster, you need to reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.
After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
", + "CreateDBClusterSnapshot": "Creates a snapshot of a DB cluster. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
", + "CreateDBInstance": "Creates a new DB instance.
", + "CreateDBInstanceReadReplica": "Creates a DB instance for a DB instance running MySQL, MariaDB, or PostgreSQL that acts as a Read Replica of a source DB instance.
All Read Replica DB instances are created as Single-AZ deployments with backups disabled. All other DB instance attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance, except as specified below.
The source DB instance must have backup retention enabled.
Creates a new DB parameter group.
A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup. Once you've created a DB parameter group, you need to associate it with your DB instance using ModifyDBInstance. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect.
After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.
Creates a new DB security group. DB security groups control access to a DB instance.
", + "CreateDBSnapshot": "Creates a DBSnapshot. The source DBInstance must be in \"available\" state.
", + "CreateDBSubnetGroup": "Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the region.
", + "CreateEventSubscription": "Creates an RDS event notification subscription. This action requires a topic ARN (Amazon Resource Name) created by either the RDS console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.
You can specify the type of source (SourceType) you want to be notified of, provide a list of RDS sources (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.
If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIdentifier = myDBInstance1, you will be notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you will receive notice of the events for that source type for all your RDS sources. If you do not specify either the SourceType nor the SourceIdentifier, you will be notified of events generated from all RDS sources belonging to your customer account.
", + "CreateOptionGroup": "Creates a new option group. You can create up to 20 option groups.
", + "DeleteDBCluster": "The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and cannot be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
", + "DeleteDBClusterParameterGroup": "Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted cannot be associated with any DB clusters.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
", + "DeleteDBClusterSnapshot": "Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.
The DB cluster snapshot must be in the available state to be deleted.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
", + "DeleteDBInstance": "The DeleteDBInstance action deletes a previously provisioned DB instance. When you delete a DB instance, all automated backups for that instance are deleted and cannot be recovered. Manual DB snapshots of the DB instance to be deleted by DeleteDBInstance are not deleted.
If you request a final DB snapshot the status of the Amazon RDS DB instance is deleting until the DB snapshot is created. The API action DescribeDBInstance is used to monitor the status of this operation. The action cannot be canceled or reverted once submitted.
Note that when a DB instance is in a failure state and has a status of failed, incompatible-restore, or incompatible-network, you can only delete it when the SkipFinalSnapshot parameter is set to true.
If the specified DB instance is part of an Amazon Aurora DB cluster, you cannot delete the DB instance if the following are true:
The DB cluster is a Read Replica of another Amazon Aurora DB cluster.
The DB instance is the only instance in the DB cluster.
To delete a DB instance in this case, first call the PromoteReadReplicaDBCluster API action to promote the DB cluster so it's no longer a Read Replica. After the promotion completes, then call the DeleteDBInstance API action to delete the final instance in the DB cluster.
Deletes a specified DBParameterGroup. The DBParameterGroup to be deleted cannot be associated with any DB instances.
", + "DeleteDBSecurityGroup": "Deletes a DB security group.
The specified DB security group must not be associated with any DB instances.
Deletes a DBSnapshot. If the snapshot is being copied, the copy operation is terminated.
The DBSnapshot must be in the available state to be deleted.
Deletes a DB subnet group.
The specified database subnet group must not be associated with any DB instances.
Deletes an RDS event notification subscription.
", + "DeleteOptionGroup": "Deletes an existing option group.
", + "DescribeAccountAttributes": "Lists all of the attributes for a customer account. The attributes include Amazon RDS quotas for the account, such as the number of DB instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value.
This command does not take any parameters.
", + "DescribeCertificates": "Lists the set of CA certificates provided by Amazon RDS for this AWS account.
", + "DescribeDBClusterParameterGroups": " Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list will contain only the description of the specified DB cluster parameter group.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
", + "DescribeDBClusterParameters": "Returns the detailed parameter list for a particular DB cluster parameter group.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
", + "DescribeDBClusterSnapshotAttributes": "Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.
When sharing snapshots with other AWS accounts, DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the AWS accounts that are authorized to copy or restore the manual DB cluster snapshot. If all is included in the list of values for the restore attribute, then the manual DB cluster snapshot is public and can be copied or restored by all AWS accounts.
To add or remove access for an AWS account to copy or restore a manual DB cluster snapshot, or to make the manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute API action.
", + "DescribeDBClusterSnapshots": "Returns information about DB cluster snapshots. This API action supports pagination.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
", + "DescribeDBClusters": "Returns information about provisioned Aurora DB clusters. This API supports pagination.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
", + "DescribeDBEngineVersions": "Returns a list of the available DB engines.
", + "DescribeDBInstances": "Returns information about provisioned RDS instances. This API supports pagination.
", + "DescribeDBLogFiles": "Returns a list of DB log files for the DB instance.
", + "DescribeDBParameterGroups": " Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DB parameter group.
Returns the detailed parameter list for a particular DB parameter group.
", + "DescribeDBSecurityGroups": " Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified, the list will contain only the descriptions of the specified DB security group.
Returns a list of DB snapshot attribute names and values for a manual DB snapshot.
When sharing snapshots with other AWS accounts, DescribeDBSnapshotAttributes returns the restore attribute and a list of IDs for the AWS accounts that are authorized to copy or restore the manual DB snapshot. If all is included in the list of values for the restore attribute, then the manual DB snapshot is public and can be copied or restored by all AWS accounts.
To add or remove access for an AWS account to copy or restore a manual DB snapshot, or to make the manual DB snapshot public or private, use the ModifyDBSnapshotAttribute API action.
", + "DescribeDBSnapshots": "Returns information about DB snapshots. This API action supports pagination.
", + "DescribeDBSubnetGroups": "Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.
For an overview of CIDR ranges, go to the Wikipedia Tutorial.
", + "DescribeEngineDefaultClusterParameters": "Returns the default engine and system parameter information for the cluster database engine.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
", + "DescribeEngineDefaultParameters": "Returns the default engine and system parameter information for the specified database engine.
", + "DescribeEventCategories": "Displays a list of categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in the Events topic in the Amazon RDS User Guide.
", + "DescribeEventSubscriptions": "Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.
If you specify a SubscriptionName, lists the description for that subscription.
", + "DescribeEvents": "Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.
", + "DescribeOptionGroupOptions": "Describes all available options.
", + "DescribeOptionGroups": "Describes the available option groups.
", + "DescribeOrderableDBInstanceOptions": "Returns a list of orderable DB instance options for the specified engine.
", + "DescribePendingMaintenanceActions": "Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
", + "DescribeReservedDBInstances": "Returns information about reserved DB instances for this account, or about a specified reserved DB instance.
", + "DescribeReservedDBInstancesOfferings": "Lists available reserved DB instance offerings.
", + "DownloadDBLogFilePortion": "Downloads all or a portion of the specified log file, up to 1 MB in size.
", + "FailoverDBCluster": "Forces a failover for a DB cluster.
A failover for a DB cluster promotes one of the read-only instances in the DB cluster to the master DB instance (the cluster writer) and deletes the current primary instance.
Amazon Aurora will automatically fail over to a read-only instance, if one exists, when the primary instance fails. You can force a failover when you want to simulate a failure of a DB instance for testing. Because each instance in a DB cluster has its own endpoint address, you will need to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
", + "ListTagsForResource": "Lists all tags on an Amazon RDS resource.
For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources.
", + "ModifyDBCluster": "Modify a setting for an Amazon Aurora DB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
", + "ModifyDBClusterParameterGroup": " Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB cluster associated with the parameter group before the change can take effect.
After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified.
Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.
To share a manual DB cluster snapshot with other AWS accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the AWS accounts that are authorized to restore the manual DB cluster snapshot. Use the value all to make the manual DB cluster snapshot public, which means that it can be copied or restored by all AWS accounts. Do not add the all value for any manual DB cluster snapshots that contain private information that you don't want available to all AWS accounts.
To view which AWS accounts have access to copy or restore a manual DB cluster snapshot, or whether a manual DB cluster snapshot public or private, use the DescribeDBClusterSnapshotAttributes API action.
If a manual DB cluster snapshot is encrypted, it cannot be shared.
", + "ModifyDBInstance": "Modify settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.
", + "ModifyDBParameterGroup": " Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.
Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB instance associated with the parameter group before the change can take effect.
After you modify a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the modify action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.
Adds an attribute and values to, or removes an attribute and values from, a manual DB snapshot.
To share a manual DB snapshot with other AWS accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the AWS accounts that are authorized to restore the manual DB snapshot. Uses the value all to make the manual DB snapshot public, which means it can be copied or restored by all AWS accounts. Do not add the all value for any manual DB snapshots that contain private information that you don't want available to all AWS accounts.
To view which AWS accounts have access to copy or restore a manual DB snapshot, or whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes API action.
If the manual DB snapshot is encrypted, it cannot be shared.
", + "ModifyDBSubnetGroup": "Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the region.
", + "ModifyEventSubscription": "Modifies an existing RDS event notification subscription. Note that you cannot modify the source identifiers using this call; to change source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.
You can see a list of the event categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.
", + "ModifyOptionGroup": "Modifies an existing option group.
", + "PromoteReadReplica": "Promotes a Read Replica DB instance to a standalone DB instance.
We recommend that you enable automated backups on your Read Replica before promoting the Read Replica. This ensures that no backup is taken during the promotion process. Once the instance is promoted to a primary instance, backups are taken based on your backup settings.
Promotes a Read Replica DB cluster to a standalone DB cluster.
", + "PurchaseReservedDBInstancesOffering": "Purchases a reserved DB instance offering.
", + "RebootDBInstance": "Rebooting a DB instance restarts the database engine service. A reboot also applies to the DB instance any modifications to the associated DB parameter group that were pending. Rebooting a DB instance results in a momentary outage of the instance, during which the DB instance status is set to rebooting. If the RDS instance is configured for MultiAZ, it is possible that the reboot will be conducted through a failover. An Amazon RDS event is created when the reboot is completed.
If your DB instance is deployed in multiple Availability Zones, you can force a failover from one AZ to the other during the reboot. You might force a failover to test the availability of your DB instance deployment or to restore operations to the original AZ after a failover occurs.
The time required to reboot is a function of the specific database engine's crash recovery process. To improve the reboot time, we recommend that you reduce database activities as much as possible during the reboot process to reduce rollback activity for in-transit transactions.
", + "RemoveSourceIdentifierFromSubscription": "Removes a source identifier from an existing RDS event notification subscription.
", + "RemoveTagsFromResource": "Removes metadata tags from an Amazon RDS resource.
For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources.
", + "ResetDBClusterParameterGroup": " Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DB cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters.
When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request. You must call RebootDBInstance for every DB instance in your DB cluster that you want the updated static parameter to apply to.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
", + "ResetDBParameterGroup": " Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request.
Creates a new DB cluster from a DB cluster snapshot. The target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
", + "RestoreDBClusterToPointInTime": " Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
", + "RestoreDBInstanceFromDBSnapshot": "Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with the most of original configuration with the default security group and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored AZ deployment and not a single-AZ deployment.
If your intent is to replace your original DB instance with the new, restored DB instance, then rename your original DB instance before you call the RestoreDBInstanceFromDBSnapshot action. RDS does not allow two DB instances with the same name. Once you have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. The result is that you will replace the original DB instance with the DB instance created from the snapshot.
If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of the shared DB snapshot.
Restores a DB instance to an arbitrary point in time. You can restore to any point in time before the time identified by the LatestRestorableTime property. You can restore to a point up to the number of days specified by the BackupRetentionPeriod property.
The target database is created with most of the original configuration, but in a system-selected availability zone, with the default security group, the default subnet group, and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored deployment and not a single-AZ deployment.
", + "RevokeDBSecurityGroupIngress": "Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC Security Groups. Required parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId).
" + }, + "shapes": { + "AccountAttributesMessage": { + "base": "Data returned by the DescribeAccountAttributes action.
", + "refs": { + } + }, + "AccountQuota": { + "base": "Describes a quota for an AWS account, for example, the number of DB instances allowed.
", + "refs": { + "AccountQuotaList$member": null + } + }, + "AccountQuotaList": { + "base": null, + "refs": { + "AccountAttributesMessage$AccountQuotas": "A list of AccountQuota objects. Within this list, each quota has a name, a count of usage toward the quota maximum, and a maximum value for the quota.
" + } + }, + "AddSourceIdentifierToSubscriptionMessage": { + "base": "", + "refs": { + } + }, + "AddSourceIdentifierToSubscriptionResult": { + "base": null, + "refs": { + } + }, + "AddTagsToResourceMessage": { + "base": "", + "refs": { + } + }, + "ApplyMethod": { + "base": null, + "refs": { + "Parameter$ApplyMethod": "Indicates when to apply parameter updates.
" + } + }, + "ApplyPendingMaintenanceActionMessage": { + "base": "", + "refs": { + } + }, + "ApplyPendingMaintenanceActionResult": { + "base": null, + "refs": { + } + }, + "AttributeValueList": { + "base": null, + "refs": { + "DBClusterSnapshotAttribute$AttributeValues": "The value(s) for the manual DB cluster snapshot attribute.
If the AttributeName field is set to restore, then this element returns a list of IDs of the AWS accounts that are authorized to copy or restore the manual DB cluster snapshot. If a value of all is in the list, then the manual DB cluster snapshot is public and available for any AWS account to copy or restore.
The value or values for the manual DB snapshot attribute.
If the AttributeName field is set to restore, then this element returns a list of IDs of the AWS accounts that are authorized to copy or restore the manual DB snapshot. If a value of all is in the list, then the manual DB snapshot is public and available for any AWS account to copy or restore.
A list of DB cluster snapshot attributes to add to the attribute specified by AttributeName.
To authorize other AWS accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more AWS account IDs, or all to make the manual DB cluster snapshot restorable by any AWS account. Do not add the all value for any manual DB cluster snapshots that contain private information that you don't want available to all AWS accounts.
A list of DB cluster snapshot attributes to remove from the attribute specified by AttributeName.
To remove authorization for other AWS accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more AWS account identifiers, or all to remove authorization for any AWS account to copy or restore the DB cluster snapshot. If you specify all, an AWS account whose account ID is explicitly added to the restore attribute can still copy or restore a manual DB cluster snapshot.
A list of DB snapshot attributes to add to the attribute specified by AttributeName.
To authorize other AWS accounts to copy or restore a manual snapshot, set this list to include one or more AWS account IDs, or all to make the manual DB snapshot restorable by any AWS account. Do not add the all value for any manual DB snapshots that contain private information that you don't want available to all AWS accounts.
A list of DB snapshot attributes to remove from the attribute specified by AttributeName.
To remove authorization for other AWS accounts to copy or restore a manual snapshot, set this list to include one or more AWS account identifiers, or all to remove authorization for any AWS account to copy or restore the DB snapshot. If you specify all, an AWS account whose account ID is explicitly added to the restore attribute can still copy or restore the manual DB snapshot.
The specified CIDRIP or EC2 security group is already authorized for the specified DB security group.
", + "refs": { + } + }, + "AuthorizationNotFoundFault": { + "base": "Specified CIDRIP or EC2 security group is not authorized for the specified DB security group.
RDS may not also be authorized via IAM to perform necessary actions on your behalf.
", + "refs": { + } + }, + "AuthorizationQuotaExceededFault": { + "base": "DB security group authorization quota has been reached.
", + "refs": { + } + }, + "AuthorizeDBSecurityGroupIngressMessage": { + "base": "", + "refs": { + } + }, + "AuthorizeDBSecurityGroupIngressResult": { + "base": null, + "refs": { + } + }, + "AvailabilityZone": { + "base": "Contains Availability Zone information.
This data type is used as an element in the following data type:
", + "refs": { + "AvailabilityZoneList$member": null, + "Subnet$SubnetAvailabilityZone": null + } + }, + "AvailabilityZoneList": { + "base": null, + "refs": { + "OrderableDBInstanceOption$AvailabilityZones": "A list of Availability Zones for the orderable DB instance.
" + } + }, + "AvailabilityZones": { + "base": null, + "refs": { + "CreateDBClusterMessage$AvailabilityZones": "A list of EC2 Availability Zones that instances in the DB cluster can be created in. For information on regions and Availability Zones, see Regions and Availability Zones.
", + "DBCluster$AvailabilityZones": "Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
", + "DBClusterSnapshot$AvailabilityZones": "Provides the list of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.
", + "RestoreDBClusterFromSnapshotMessage$AvailabilityZones": "Provides the list of EC2 Availability Zones that instances in the restored DB cluster can be created in.
" + } + }, + "Boolean": { + "base": null, + "refs": { + "DBCluster$StorageEncrypted": "Specifies whether the DB cluster is encrypted.
", + "DBClusterMember$IsClusterWriter": "Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.
Specifies whether the DB cluster snapshot is encrypted.
", + "DBInstance$MultiAZ": "Specifies if the DB instance is a Multi-AZ deployment.
", + "DBInstance$AutoMinorVersionUpgrade": "Indicates that minor version patches are applied automatically.
", + "DBInstance$PubliclyAccessible": "Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
Default VPC:true
VPC:false
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.
", + "DBInstance$StorageEncrypted": "Specifies whether the DB instance is encrypted.
", + "DBInstance$CopyTagsToSnapshot": "Specifies whether tags are copied from the DB instance to snapshots of the DB instance.
", + "DBInstanceStatusInfo$Normal": "Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.
", + "DBSnapshot$Encrypted": "Specifies whether the DB snapshot is encrypted.
", + "DeleteDBClusterMessage$SkipFinalSnapshot": " Determines whether a final DB cluster snapshot is created before the DB cluster is deleted. If true is specified, no DB cluster snapshot is created. If false is specified, a DB cluster snapshot is created before the DB cluster is deleted.
You must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is false.
Default: false
Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted.
Note that when a DB instance is in a failure state and has a status of 'failed', 'incompatible-restore', or 'incompatible-network', it can only be deleted when the SkipFinalSnapshot parameter is set to \"true\".
Specify true when deleting a Read Replica.
The FinalDBSnapshotIdentifier parameter must be specified if SkipFinalSnapshot is false.
Default: false
Set this value to true to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore, otherwise set this value to false. The default is false.
You can give an AWS account permission to restore a manual DB cluster snapshot from another AWS account by the ModifyDBClusterSnapshotAttribute API action.
", + "DescribeDBClusterSnapshotsMessage$IncludePublic": "Set this value to true to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account, otherwise set this value to false. The default is false. The default is false.
You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.
", + "DescribeDBEngineVersionsMessage$DefaultOnly": "Indicates that only the default version of the specified engine or engine and major version combination is returned.
", + "DescribeDBSnapshotsMessage$IncludeShared": "Set this value to true to include shared manual DB snapshots from other AWS accounts that this AWS account has been given permission to copy or restore, otherwise set this value to false. The default is false.
You can give an AWS account permission to restore a manual DB snapshot from another AWS account by using the ModifyDBSnapshotAttribute API action.
", + "DescribeDBSnapshotsMessage$IncludePublic": "Set this value to true to include manual DB snapshots that are public and can be copied or restored by any AWS account, otherwise set this value to false. The default is false.
You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.
", + "DownloadDBLogFilePortionDetails$AdditionalDataPending": "Boolean value that if true, indicates there is more data to be downloaded.
", + "EventSubscription$Enabled": "A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.
", + "ModifyDBClusterMessage$ApplyImmediately": "A value that specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB cluster. If this parameter is set to false, changes to the DB cluster are applied during the next maintenance window.
The ApplyImmediately parameter only affects the NewDBClusterIdentifier and MasterUserPassword values. If you set the ApplyImmediately parameter value to false, then changes to the NewDBClusterIdentifier and MasterUserPassword values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the ApplyImmediately parameter.
Default: false
Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB instance.
If this parameter is set to false, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage and will be applied on the next call to RebootDBInstance, or the next failure reboot. Review the table of parameters in Modifying a DB Instance and Using the Apply Immediately Parameter to see the impact that setting ApplyImmediately to true or false has for each modified parameter and to determine when the changes will be applied.
Default: false
Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.
Constraints: This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.
", + "ModifyOptionGroupMessage$ApplyImmediately": "Indicates whether the changes should be applied immediately, or during the next maintenance window for each instance associated with the option group.
", + "Option$Persistent": "Indicate if this option is persistent.
", + "Option$Permanent": "Indicate if this option is permanent.
", + "OptionGroup$AllowsVpcAndNonVpcInstanceMemberships": "Indicates whether this option group can be applied to both VPC and non-VPC instances. The value true indicates the option group can be applied to both VPC and non-VPC instances.
Specifies whether the option requires a port.
", + "OptionGroupOption$Persistent": "A persistent option cannot be removed from the option group once the option group is used, but this option can be removed from the db instance while modifying the related data and assigning another option group without this option.
", + "OptionGroupOption$Permanent": "A permanent option cannot be removed from the option group once the option group is used, and it cannot be removed from the db instance after assigning an option group with this permanent option.
", + "OptionGroupOptionSetting$IsModifiable": "Boolean value where true indicates that this option group option can be changed from the default value.
", + "OptionSetting$IsModifiable": "A Boolean value that, when true, indicates the option setting can be modified from the default.
", + "OptionSetting$IsCollection": "Indicates if the option setting is part of a collection.
", + "OrderableDBInstanceOption$MultiAZCapable": "Indicates whether this orderable DB instance is multi-AZ capable.
", + "OrderableDBInstanceOption$ReadReplicaCapable": "Indicates whether this orderable DB instance can have a Read Replica.
", + "OrderableDBInstanceOption$Vpc": "Indicates whether this is a VPC orderable DB instance.
", + "OrderableDBInstanceOption$SupportsStorageEncryption": "Indicates whether this orderable DB instance supports encrypted storage.
", + "OrderableDBInstanceOption$SupportsIops": "Indicates whether this orderable DB instance supports provisioned IOPS.
", + "OrderableDBInstanceOption$SupportsEnhancedMonitoring": "Indicates whether the DB instance supports enhanced monitoring at intervals from 1 to 60 seconds.
", + "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.
Indicates if the reservation applies to Multi-AZ deployments.
", + "ReservedDBInstancesOffering$MultiAZ": "Indicates if the offering applies to Multi-AZ deployments.
", + "ResetDBClusterParameterGroupMessage$ResetAllParameters": "A value that is set to true to reset all parameters in the DB cluster parameter group to their default values, and false otherwise. You cannot use this parameter if there is a list of parameter names specified for the Parameters parameter.
Specifies whether (true) or not (false) to reset all parameters in the DB parameter group to default values.
Default: true
A value that is set to true to restore the DB cluster to the latest restorable backup time, and false otherwise.
Default: false
Constraints: Cannot be specified if RestoreToTime parameter is provided.
Specifies whether (true) or not (false) the DB instance is restored from the latest backup time.
Default: false
Constraints: Cannot be specified if RestoreTime parameter is provided.
", + "UpgradeTarget$AutoUpgrade": "A value that indicates whether the target version will be applied to any source DB instances that have AutoMinorVersionUpgrade set to true.
", + "UpgradeTarget$IsMajorVersionUpgrade": "A value that indicates whether a database engine will be upgraded to a major version.
" + } + }, + "BooleanOptional": { + "base": null, + "refs": { + "CopyDBSnapshotMessage$CopyTags": "True to copy all tags from the source DB snapshot to the target DB snapshot; otherwise false. The default is false.
", + "CreateDBClusterMessage$StorageEncrypted": "Specifies whether the DB cluster is encrypted.
", + "CreateDBInstanceMessage$MultiAZ": "Specifies if the DB instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the MultiAZ parameter is set to true.
", + "CreateDBInstanceMessage$AutoMinorVersionUpgrade": "Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window.
Default: true
Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
Default VPC: true
VPC: false
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.
", + "CreateDBInstanceMessage$StorageEncrypted": "Specifies whether the DB instance is encrypted.
Default: false
", + "CreateDBInstanceMessage$CopyTagsToSnapshot": "True to copy all tags from the DB instance to snapshots of the DB instance; otherwise false. The default is false.
", + "CreateDBInstanceReadReplicaMessage$AutoMinorVersionUpgrade": "Indicates that minor engine upgrades will be applied automatically to the Read Replica during the maintenance window.
Default: Inherits from the source DB instance
", + "CreateDBInstanceReadReplicaMessage$PubliclyAccessible": "Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
Default VPC:true
VPC:false
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.
", + "CreateDBInstanceReadReplicaMessage$CopyTagsToSnapshot": "True to copy all tags from the Read Replica to snapshots of the Read Replica; otherwise false. The default is false.
", + "CreateEventSubscriptionMessage$Enabled": "A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.
", + "DescribeDBEngineVersionsMessage$ListSupportedCharacterSets": "If this parameter is specified, and if the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.
", + "DescribeOrderableDBInstanceOptionsMessage$Vpc": "The VPC filter value. Specify this parameter to show only the available VPC or non-VPC offerings.
", + "DescribeReservedDBInstancesMessage$MultiAZ": "The Multi-AZ filter value. Specify this parameter to show only those reservations matching the specified Multi-AZ parameter.
", + "DescribeReservedDBInstancesOfferingsMessage$MultiAZ": "The Multi-AZ filter value. Specify this parameter to show only the available offerings matching the specified Multi-AZ parameter.
", + "ModifyDBInstanceMessage$MultiAZ": " Specifies if the DB instance is a Multi-AZ deployment. Changing this parameter does not result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.
Constraints: Cannot be specified if the DB instance is a Read Replica.
", + "ModifyDBInstanceMessage$AutoMinorVersionUpgrade": " Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window. Changing this parameter does not result in an outage except in the following case and the change is asynchronously applied as soon as possible. An outage will result if this parameter is set to true during the maintenance window, and a newer minor version is available, and RDS has enabled auto patching for that engine version.
True to copy all tags from the DB instance to snapshots of the DB instance; otherwise false. The default is false.
", + "ModifyDBInstanceMessage$PubliclyAccessible": "Boolean value that indicates if the DB instance has a publicly resolvable DNS name. Set to True to make the DB instance Internet-facing with a publicly resolvable DNS name, which resolves to a public IP address. Set to False to make the DB instance internal with a DNS name that resolves to a private IP address.
PubliclyAccessible only applies to DB instances in a VPC. The DB instance must be part of a public subnet and PubliclyAccessible must be true in order for it to be publicly accessible.
Changes to the PubliclyAccessible parameter are applied immediately regardless of the value of the ApplyImmediately parameter.
Default: false
", + "ModifyEventSubscriptionMessage$Enabled": "A Boolean value; set to true to activate the subscription.
", + "PendingModifiedValues$MultiAZ": "Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.
", + "RebootDBInstanceMessage$ForceFailover": " When true, the reboot will be conducted through a MultiAZ failover.
Constraint: You cannot specify true if the instance is not configured for MultiAZ.
Specifies if the DB instance is a Multi-AZ deployment.
Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.
Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
Default VPC: true
VPC: false
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.
", + "RestoreDBInstanceFromDBSnapshotMessage$AutoMinorVersionUpgrade": "Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window.
", + "RestoreDBInstanceFromDBSnapshotMessage$CopyTagsToSnapshot": "True to copy all tags from the restored DB instance to snapshots of the DB instance; otherwise false. The default is false.
", + "RestoreDBInstanceToPointInTimeMessage$MultiAZ": "Specifies if the DB instance is a Multi-AZ deployment.
Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.
Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
Default VPC:true
VPC:false
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.
", + "RestoreDBInstanceToPointInTimeMessage$AutoMinorVersionUpgrade": "Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window.
", + "RestoreDBInstanceToPointInTimeMessage$CopyTagsToSnapshot": "True to copy all tags from the restored DB instance to snapshots of the DB instance; otherwise false. The default is false.
" + } + }, + "Certificate": { + "base": "A CA certificate for an AWS account.
", + "refs": { + "CertificateList$member": null + } + }, + "CertificateList": { + "base": null, + "refs": { + "CertificateMessage$Certificates": "The list of Certificate objects for the AWS account.
" + } + }, + "CertificateMessage": { + "base": "Data returned by the DescribeCertificates action.
", + "refs": { + } + }, + "CertificateNotFoundFault": { + "base": "CertificateIdentifier does not refer to an existing certificate.
", + "refs": { + } + }, + "CharacterSet": { + "base": "This data type is used as a response element in the action DescribeDBEngineVersions.
", + "refs": { + "DBEngineVersion$DefaultCharacterSet": " The default character set for new instances of this engine version, if the CharacterSetName parameter of the CreateDBInstance API is not specified.
Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBClusters action.
", + "refs": { + "CreateDBClusterResult$DBCluster": null, + "DBClusterList$member": null, + "DeleteDBClusterResult$DBCluster": null, + "FailoverDBClusterResult$DBCluster": null, + "ModifyDBClusterResult$DBCluster": null, + "PromoteReadReplicaDBClusterResult$DBCluster": null, + "RestoreDBClusterFromSnapshotResult$DBCluster": null, + "RestoreDBClusterToPointInTimeResult$DBCluster": null + } + }, + "DBClusterAlreadyExistsFault": { + "base": "User already has a DB cluster with the given identifier.
", + "refs": { + } + }, + "DBClusterList": { + "base": null, + "refs": { + "DBClusterMessage$DBClusters": "Contains a list of DB clusters for the user.
" + } + }, + "DBClusterMember": { + "base": "Contains information about an instance that is part of a DB cluster.
", + "refs": { + "DBClusterMemberList$member": null + } + }, + "DBClusterMemberList": { + "base": null, + "refs": { + "DBCluster$DBClusterMembers": "Provides the list of instances that make up the DB cluster.
" + } + }, + "DBClusterMessage": { + "base": "Contains the result of a successful invocation of the DescribeDBClusters action.
", + "refs": { + } + }, + "DBClusterNotFoundFault": { + "base": "DBClusterIdentifier does not refer to an existing DB cluster.
", + "refs": { + } + }, + "DBClusterOptionGroupMemberships": { + "base": null, + "refs": { + "DBCluster$DBClusterOptionGroupMemberships": "Provides the list of option group memberships for this DB cluster.
" + } + }, + "DBClusterOptionGroupStatus": { + "base": "Contains status information for a DB cluster option group.
", + "refs": { + "DBClusterOptionGroupMemberships$member": null + } + }, + "DBClusterParameterGroup": { + "base": "Contains the result of a successful invocation of the CreateDBClusterParameterGroup action.
This data type is used as a request parameter in the DeleteDBClusterParameterGroup action, and as a response element in the DescribeDBClusterParameterGroups action.
", + "refs": { + "CreateDBClusterParameterGroupResult$DBClusterParameterGroup": null, + "DBClusterParameterGroupList$member": null + } + }, + "DBClusterParameterGroupDetails": { + "base": "Provides details about a DB cluster parameter group including the parameters in the DB cluster parameter group.
", + "refs": { + } + }, + "DBClusterParameterGroupList": { + "base": null, + "refs": { + "DBClusterParameterGroupsMessage$DBClusterParameterGroups": "A list of DB cluster parameter groups.
" + } + }, + "DBClusterParameterGroupNameMessage": { + "base": "", + "refs": { + } + }, + "DBClusterParameterGroupNotFoundFault": { + "base": "DBClusterParameterGroupName does not refer to an existing DB Cluster parameter group.
", + "refs": { + } + }, + "DBClusterParameterGroupsMessage": { + "base": "", + "refs": { + } + }, + "DBClusterQuotaExceededFault": { + "base": "User attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.
", + "refs": { + } + }, + "DBClusterSnapshot": { + "base": "Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBClusterSnapshots action.
", + "refs": { + "CopyDBClusterSnapshotResult$DBClusterSnapshot": null, + "CreateDBClusterSnapshotResult$DBClusterSnapshot": null, + "DBClusterSnapshotList$member": null, + "DeleteDBClusterSnapshotResult$DBClusterSnapshot": null + } + }, + "DBClusterSnapshotAlreadyExistsFault": { + "base": "User already has a DB cluster snapshot with the given identifier.
", + "refs": { + } + }, + "DBClusterSnapshotAttribute": { + "base": "Contains the name and values of a manual DB cluster snapshot attribute.
Manual DB cluster snapshot attributes are used to authorize other AWS accounts to restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.
", + "refs": { + "DBClusterSnapshotAttributeList$member": null + } + }, + "DBClusterSnapshotAttributeList": { + "base": null, + "refs": { + "DBClusterSnapshotAttributesResult$DBClusterSnapshotAttributes": "The list of attributes and values for the manual DB cluster snapshot.
" + } + }, + "DBClusterSnapshotAttributesResult": { + "base": "Contains the results of a successful call to the DescribeDBClusterSnapshotAttributes API action.
Manual DB cluster snapshot attributes are used to authorize other AWS accounts to copy or restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.
", + "refs": { + "DescribeDBClusterSnapshotAttributesResult$DBClusterSnapshotAttributesResult": null, + "ModifyDBClusterSnapshotAttributeResult$DBClusterSnapshotAttributesResult": null + } + }, + "DBClusterSnapshotList": { + "base": null, + "refs": { + "DBClusterSnapshotMessage$DBClusterSnapshots": "Provides a list of DB cluster snapshots for the user.
" + } + }, + "DBClusterSnapshotMessage": { + "base": "Provides a list of DB cluster snapshots for the user as the result of a call to the DescribeDBClusterSnapshots action.
", + "refs": { + } + }, + "DBClusterSnapshotNotFoundFault": { + "base": "DBClusterSnapshotIdentifier does not refer to an existing DB cluster snapshot.
", + "refs": { + } + }, + "DBEngineVersion": { + "base": "This data type is used as a response element in the action DescribeDBEngineVersions.
", + "refs": { + "DBEngineVersionList$member": null + } + }, + "DBEngineVersionList": { + "base": null, + "refs": { + "DBEngineVersionMessage$DBEngineVersions": " A list of DBEngineVersion elements.
Contains the result of a successful invocation of the DescribeDBEngineVersions action.
", + "refs": { + } + }, + "DBInstance": { + "base": "Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBInstances action.
", + "refs": { + "CreateDBInstanceReadReplicaResult$DBInstance": null, + "CreateDBInstanceResult$DBInstance": null, + "DBInstanceList$member": null, + "DeleteDBInstanceResult$DBInstance": null, + "ModifyDBInstanceResult$DBInstance": null, + "PromoteReadReplicaResult$DBInstance": null, + "RebootDBInstanceResult$DBInstance": null, + "RestoreDBInstanceFromDBSnapshotResult$DBInstance": null, + "RestoreDBInstanceToPointInTimeResult$DBInstance": null + } + }, + "DBInstanceAlreadyExistsFault": { + "base": "User already has a DB instance with the given identifier.
", + "refs": { + } + }, + "DBInstanceList": { + "base": null, + "refs": { + "DBInstanceMessage$DBInstances": "A list of DBInstance instances.
" + } + }, + "DBInstanceMessage": { + "base": "Contains the result of a successful invocation of the DescribeDBInstances action.
", + "refs": { + } + }, + "DBInstanceNotFoundFault": { + "base": "DBInstanceIdentifier does not refer to an existing DB instance.
", + "refs": { + } + }, + "DBInstanceStatusInfo": { + "base": "Provides a list of status information for a DB instance.
", + "refs": { + "DBInstanceStatusInfoList$member": null + } + }, + "DBInstanceStatusInfoList": { + "base": null, + "refs": { + "DBInstance$StatusInfos": "The status of a Read Replica. If the instance is not a Read Replica, this will be blank.
" + } + }, + "DBLogFileNotFoundFault": { + "base": "LogFileName does not refer to an existing DB log file.
", + "refs": { + } + }, + "DBParameterGroup": { + "base": "Contains the result of a successful invocation of the CreateDBParameterGroup action.
This data type is used as a request parameter in the DeleteDBParameterGroup action, and as a response element in the DescribeDBParameterGroups action.
", + "refs": { + "CopyDBParameterGroupResult$DBParameterGroup": null, + "CreateDBParameterGroupResult$DBParameterGroup": null, + "DBParameterGroupList$member": null + } + }, + "DBParameterGroupAlreadyExistsFault": { + "base": "A DB parameter group with the same name exists.
", + "refs": { + } + }, + "DBParameterGroupDetails": { + "base": "Contains the result of a successful invocation of the DescribeDBParameters action.
", + "refs": { + } + }, + "DBParameterGroupList": { + "base": null, + "refs": { + "DBParameterGroupsMessage$DBParameterGroups": "A list of DBParameterGroup instances.
" + } + }, + "DBParameterGroupNameMessage": { + "base": "Contains the result of a successful invocation of the ModifyDBParameterGroup or ResetDBParameterGroup action.
", + "refs": { + } + }, + "DBParameterGroupNotFoundFault": { + "base": "DBParameterGroupName does not refer to an existing DB parameter group.
", + "refs": { + } + }, + "DBParameterGroupQuotaExceededFault": { + "base": "Request would result in user exceeding the allowed number of DB parameter groups.
", + "refs": { + } + }, + "DBParameterGroupStatus": { + "base": "The status of the DB parameter group.
This data type is used as a response element in the following actions:
Provides the list of DB parameter groups applied to this DB instance.
" + } + }, + "DBParameterGroupsMessage": { + "base": "Contains the result of a successful invocation of the DescribeDBParameterGroups action.
", + "refs": { + } + }, + "DBSecurityGroup": { + "base": "Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBSecurityGroups action.
", + "refs": { + "AuthorizeDBSecurityGroupIngressResult$DBSecurityGroup": null, + "CreateDBSecurityGroupResult$DBSecurityGroup": null, + "DBSecurityGroups$member": null, + "RevokeDBSecurityGroupIngressResult$DBSecurityGroup": null + } + }, + "DBSecurityGroupAlreadyExistsFault": { + "base": "A DB security group with the name specified in DBSecurityGroupName already exists.
", + "refs": { + } + }, + "DBSecurityGroupMembership": { + "base": "This data type is used as a response element in the following actions:
", + "refs": { + "DBSecurityGroupMembershipList$member": null + } + }, + "DBSecurityGroupMembershipList": { + "base": null, + "refs": { + "DBInstance$DBSecurityGroups": " Provides List of DB security group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.
If the option requires access to a port, then this DB security group allows access to the port.
" + } + }, + "DBSecurityGroupMessage": { + "base": "Contains the result of a successful invocation of the DescribeDBSecurityGroups action.
", + "refs": { + } + }, + "DBSecurityGroupNameList": { + "base": null, + "refs": { + "CreateDBInstanceMessage$DBSecurityGroups": "A list of DB security groups to associate with this DB instance.
Default: The default DB security group for the database engine.
", + "ModifyDBInstanceMessage$DBSecurityGroups": "A list of DB security groups to authorize on this DB instance. Changing this setting does not result in an outage and the change is asynchronously applied as soon as possible.
Constraints:
Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
A list of DBSecurityGroupMemebrship name strings used for this option.
" + } + }, + "DBSecurityGroupNotFoundFault": { + "base": "DBSecurityGroupName does not refer to an existing DB security group.
", + "refs": { + } + }, + "DBSecurityGroupNotSupportedFault": { + "base": "A DB security group is not allowed for this action.
", + "refs": { + } + }, + "DBSecurityGroupQuotaExceededFault": { + "base": "Request would result in user exceeding the allowed number of DB security groups.
", + "refs": { + } + }, + "DBSecurityGroups": { + "base": null, + "refs": { + "DBSecurityGroupMessage$DBSecurityGroups": "A list of DBSecurityGroup instances.
" + } + }, + "DBSnapshot": { + "base": "Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBSnapshots action.
", + "refs": { + "CopyDBSnapshotResult$DBSnapshot": null, + "CreateDBSnapshotResult$DBSnapshot": null, + "DBSnapshotList$member": null, + "DeleteDBSnapshotResult$DBSnapshot": null + } + }, + "DBSnapshotAlreadyExistsFault": { + "base": "DBSnapshotIdentifier is already used by an existing snapshot.
", + "refs": { + } + }, + "DBSnapshotAttribute": { + "base": "Contains the name and values of a manual DB snapshot attribute
Manual DB snapshot attributes are used to authorize other AWS accounts to restore a manual DB snapshot. For more information, see the ModifyDBSnapshotAttribute API.
", + "refs": { + "DBSnapshotAttributeList$member": null + } + }, + "DBSnapshotAttributeList": { + "base": null, + "refs": { + "DBSnapshotAttributesResult$DBSnapshotAttributes": "The list of attributes and values for the manual DB snapshot.
" + } + }, + "DBSnapshotAttributesResult": { + "base": "Contains the results of a successful call to the DescribeDBSnapshotAttributes API action.
Manual DB snapshot attributes are used to authorize other AWS accounts to copy or restore a manual DB snapshot. For more information, see the ModifyDBSnapshotAttribute API action.
", + "refs": { + "DescribeDBSnapshotAttributesResult$DBSnapshotAttributesResult": null, + "ModifyDBSnapshotAttributeResult$DBSnapshotAttributesResult": null + } + }, + "DBSnapshotList": { + "base": null, + "refs": { + "DBSnapshotMessage$DBSnapshots": "A list of DBSnapshot instances.
" + } + }, + "DBSnapshotMessage": { + "base": "Contains the result of a successful invocation of the DescribeDBSnapshots action.
", + "refs": { + } + }, + "DBSnapshotNotFoundFault": { + "base": "DBSnapshotIdentifier does not refer to an existing DB snapshot.
", + "refs": { + } + }, + "DBSubnetGroup": { + "base": "Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBSubnetGroups action.
", + "refs": { + "CreateDBSubnetGroupResult$DBSubnetGroup": null, + "DBInstance$DBSubnetGroup": "Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
", + "DBSubnetGroups$member": null, + "ModifyDBSubnetGroupResult$DBSubnetGroup": null + } + }, + "DBSubnetGroupAlreadyExistsFault": { + "base": "DBSubnetGroupName is already used by an existing DB subnet group.
", + "refs": { + } + }, + "DBSubnetGroupDoesNotCoverEnoughAZs": { + "base": "Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
", + "refs": { + } + }, + "DBSubnetGroupMessage": { + "base": "Contains the result of a successful invocation of the DescribeDBSubnetGroups action.
", + "refs": { + } + }, + "DBSubnetGroupNotAllowedFault": { + "base": "Indicates that the DBSubnetGroup should not be specified while creating read replicas that lie in the same region as the source instance.
", + "refs": { + } + }, + "DBSubnetGroupNotFoundFault": { + "base": "DBSubnetGroupName does not refer to an existing DB subnet group.
", + "refs": { + } + }, + "DBSubnetGroupQuotaExceededFault": { + "base": "Request would result in user exceeding the allowed number of DB subnet groups.
", + "refs": { + } + }, + "DBSubnetGroups": { + "base": null, + "refs": { + "DBSubnetGroupMessage$DBSubnetGroups": "A list of DBSubnetGroup instances.
" + } + }, + "DBSubnetQuotaExceededFault": { + "base": "Request would result in user exceeding the allowed number of subnets in a DB subnet groups.
", + "refs": { + } + }, + "DBUpgradeDependencyFailureFault": { + "base": "The DB upgrade failed because a resource the DB depends on could not be modified.
", + "refs": { + } + }, + "DeleteDBClusterMessage": { + "base": "", + "refs": { + } + }, + "DeleteDBClusterParameterGroupMessage": { + "base": "", + "refs": { + } + }, + "DeleteDBClusterResult": { + "base": null, + "refs": { + } + }, + "DeleteDBClusterSnapshotMessage": { + "base": "", + "refs": { + } + }, + "DeleteDBClusterSnapshotResult": { + "base": null, + "refs": { + } + }, + "DeleteDBInstanceMessage": { + "base": "", + "refs": { + } + }, + "DeleteDBInstanceResult": { + "base": null, + "refs": { + } + }, + "DeleteDBParameterGroupMessage": { + "base": "", + "refs": { + } + }, + "DeleteDBSecurityGroupMessage": { + "base": "", + "refs": { + } + }, + "DeleteDBSnapshotMessage": { + "base": "", + "refs": { + } + }, + "DeleteDBSnapshotResult": { + "base": null, + "refs": { + } + }, + "DeleteDBSubnetGroupMessage": { + "base": "", + "refs": { + } + }, + "DeleteEventSubscriptionMessage": { + "base": "", + "refs": { + } + }, + "DeleteEventSubscriptionResult": { + "base": null, + "refs": { + } + }, + "DeleteOptionGroupMessage": { + "base": "", + "refs": { + } + }, + "DescribeAccountAttributesMessage": { + "base": "", + "refs": { + } + }, + "DescribeCertificatesMessage": { + "base": "", + "refs": { + } + }, + "DescribeDBClusterParameterGroupsMessage": { + "base": "", + "refs": { + } + }, + "DescribeDBClusterParametersMessage": { + "base": "", + "refs": { + } + }, + "DescribeDBClusterSnapshotAttributesMessage": { + "base": "", + "refs": { + } + }, + "DescribeDBClusterSnapshotAttributesResult": { + "base": null, + "refs": { + } + }, + "DescribeDBClusterSnapshotsMessage": { + "base": "", + "refs": { + } + }, + "DescribeDBClustersMessage": { + "base": "", + "refs": { + } + }, + "DescribeDBEngineVersionsMessage": { + "base": null, + "refs": { + } + }, + "DescribeDBInstancesMessage": { + "base": "", + "refs": { + } + }, + "DescribeDBLogFilesDetails": { + "base": "This data type is used as a response element to DescribeDBLogFiles.
", + "refs": { + "DescribeDBLogFilesList$member": null + } + }, + "DescribeDBLogFilesList": { + "base": null, + "refs": { + "DescribeDBLogFilesResponse$DescribeDBLogFiles": "The DB log files returned.
" + } + }, + "DescribeDBLogFilesMessage": { + "base": "", + "refs": { + } + }, + "DescribeDBLogFilesResponse": { + "base": "The response from a call to DescribeDBLogFiles.
", + "refs": { + } + }, + "DescribeDBParameterGroupsMessage": { + "base": "", + "refs": { + } + }, + "DescribeDBParametersMessage": { + "base": null, + "refs": { + } + }, + "DescribeDBSecurityGroupsMessage": { + "base": "", + "refs": { + } + }, + "DescribeDBSnapshotAttributesMessage": { + "base": "", + "refs": { + } + }, + "DescribeDBSnapshotAttributesResult": { + "base": null, + "refs": { + } + }, + "DescribeDBSnapshotsMessage": { + "base": "", + "refs": { + } + }, + "DescribeDBSubnetGroupsMessage": { + "base": "", + "refs": { + } + }, + "DescribeEngineDefaultClusterParametersMessage": { + "base": "", + "refs": { + } + }, + "DescribeEngineDefaultClusterParametersResult": { + "base": null, + "refs": { + } + }, + "DescribeEngineDefaultParametersMessage": { + "base": "", + "refs": { + } + }, + "DescribeEngineDefaultParametersResult": { + "base": null, + "refs": { + } + }, + "DescribeEventCategoriesMessage": { + "base": "", + "refs": { + } + }, + "DescribeEventSubscriptionsMessage": { + "base": "", + "refs": { + } + }, + "DescribeEventsMessage": { + "base": "", + "refs": { + } + }, + "DescribeOptionGroupOptionsMessage": { + "base": "", + "refs": { + } + }, + "DescribeOptionGroupsMessage": { + "base": "", + "refs": { + } + }, + "DescribeOrderableDBInstanceOptionsMessage": { + "base": "", + "refs": { + } + }, + "DescribePendingMaintenanceActionsMessage": { + "base": "", + "refs": { + } + }, + "DescribeReservedDBInstancesMessage": { + "base": "", + "refs": { + } + }, + "DescribeReservedDBInstancesOfferingsMessage": { + "base": "", + "refs": { + } + }, + "DomainMembership": { + "base": "An Active Directory Domain membership record associated with the DB instance.
", + "refs": { + "DomainMembershipList$member": null + } + }, + "DomainMembershipList": { + "base": "List of Active Directory Domain membership records associated with a DB instance.
", + "refs": { + "DBInstance$DomainMemberships": "The Active Directory Domain membership records associated with the DB instance.
" + } + }, + "DomainNotFoundFault": { + "base": "Domain does not refer to an existing Active Directory Domain.
", + "refs": { + } + }, + "Double": { + "base": null, + "refs": { + "RecurringCharge$RecurringChargeAmount": "The amount of the recurring charge.
", + "ReservedDBInstance$FixedPrice": "The fixed price charged for this reserved DB instance.
", + "ReservedDBInstance$UsagePrice": "The hourly price charged for this reserved DB instance.
", + "ReservedDBInstancesOffering$FixedPrice": "The fixed price charged for this offering.
", + "ReservedDBInstancesOffering$UsagePrice": "The hourly price charged for this offering.
" + } + }, + "DownloadDBLogFilePortionDetails": { + "base": "This data type is used as a response element to DownloadDBLogFilePortion.
", + "refs": { + } + }, + "DownloadDBLogFilePortionMessage": { + "base": "", + "refs": { + } + }, + "EC2SecurityGroup": { + "base": "This data type is used as a response element in the following actions:
", + "refs": { + "EC2SecurityGroupList$member": null + } + }, + "EC2SecurityGroupList": { + "base": null, + "refs": { + "DBSecurityGroup$EC2SecurityGroups": "Contains a list of EC2SecurityGroup elements.
" + } + }, + "Endpoint": { + "base": "This data type is used as a response element in the following actions:
", + "refs": { + "DBInstance$Endpoint": "Specifies the connection endpoint.
" + } + }, + "EngineDefaults": { + "base": "Contains the result of a successful invocation of the DescribeEngineDefaultParameters action.
", + "refs": { + "DescribeEngineDefaultClusterParametersResult$EngineDefaults": null, + "DescribeEngineDefaultParametersResult$EngineDefaults": null + } + }, + "Event": { + "base": "This data type is used as a response element in the DescribeEvents action.
", + "refs": { + "EventList$member": null + } + }, + "EventCategoriesList": { + "base": null, + "refs": { + "CreateEventSubscriptionMessage$EventCategories": "A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.
", + "DescribeEventsMessage$EventCategories": "A list of event categories that trigger notifications for a event notification subscription.
", + "Event$EventCategories": "Specifies the category for the event.
", + "EventCategoriesMap$EventCategories": "The event categories for the specified source type
", + "EventSubscription$EventCategoriesList": "A list of event categories for the RDS event notification subscription.
", + "ModifyEventSubscriptionMessage$EventCategories": "A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.
" + } + }, + "EventCategoriesMap": { + "base": "Contains the results of a successful invocation of the DescribeEventCategories action.
", + "refs": { + "EventCategoriesMapList$member": null + } + }, + "EventCategoriesMapList": { + "base": null, + "refs": { + "EventCategoriesMessage$EventCategoriesMapList": "A list of EventCategoriesMap data types.
" + } + }, + "EventCategoriesMessage": { + "base": "Data returned from the DescribeEventCategories action.
", + "refs": { + } + }, + "EventList": { + "base": null, + "refs": { + "EventsMessage$Events": "A list of Event instances.
" + } + }, + "EventSubscription": { + "base": "Contains the results of a successful invocation of the DescribeEventSubscriptions action.
", + "refs": { + "AddSourceIdentifierToSubscriptionResult$EventSubscription": null, + "CreateEventSubscriptionResult$EventSubscription": null, + "DeleteEventSubscriptionResult$EventSubscription": null, + "EventSubscriptionsList$member": null, + "ModifyEventSubscriptionResult$EventSubscription": null, + "RemoveSourceIdentifierFromSubscriptionResult$EventSubscription": null + } + }, + "EventSubscriptionQuotaExceededFault": { + "base": "You have reached the maximum number of event subscriptions.
", + "refs": { + } + }, + "EventSubscriptionsList": { + "base": null, + "refs": { + "EventSubscriptionsMessage$EventSubscriptionsList": "A list of EventSubscriptions data types.
" + } + }, + "EventSubscriptionsMessage": { + "base": "Data returned by the DescribeEventSubscriptions action.
", + "refs": { + } + }, + "EventsMessage": { + "base": "Contains the result of a successful invocation of the DescribeEvents action.
", + "refs": { + } + }, + "FailoverDBClusterMessage": { + "base": "", + "refs": { + } + }, + "FailoverDBClusterResult": { + "base": null, + "refs": { + } + }, + "Filter": { + "base": "This type is not currently supported.
", + "refs": { + "FilterList$member": null + } + }, + "FilterList": { + "base": null, + "refs": { + "DescribeCertificatesMessage$Filters": "This parameter is not currently supported.
", + "DescribeDBClusterParameterGroupsMessage$Filters": "This parameter is not currently supported.
", + "DescribeDBClusterParametersMessage$Filters": "This parameter is not currently supported.
", + "DescribeDBClusterSnapshotsMessage$Filters": "This parameter is not currently supported.
", + "DescribeDBClustersMessage$Filters": "This parameter is not currently supported.
", + "DescribeDBEngineVersionsMessage$Filters": "Not currently supported.
", + "DescribeDBInstancesMessage$Filters": "This parameter is not currently supported.
", + "DescribeDBLogFilesMessage$Filters": "This parameter is not currently supported.
", + "DescribeDBParameterGroupsMessage$Filters": "This parameter is not currently supported.
", + "DescribeDBParametersMessage$Filters": "This parameter is not currently supported.
", + "DescribeDBSecurityGroupsMessage$Filters": "This parameter is not currently supported.
", + "DescribeDBSnapshotsMessage$Filters": "This parameter is not currently supported.
", + "DescribeDBSubnetGroupsMessage$Filters": "This parameter is not currently supported.
", + "DescribeEngineDefaultClusterParametersMessage$Filters": "This parameter is not currently supported.
", + "DescribeEngineDefaultParametersMessage$Filters": "Not currently supported.
", + "DescribeEventCategoriesMessage$Filters": "This parameter is not currently supported.
", + "DescribeEventSubscriptionsMessage$Filters": "This parameter is not currently supported.
", + "DescribeEventsMessage$Filters": "This parameter is not currently supported.
", + "DescribeOptionGroupOptionsMessage$Filters": "This parameter is not currently supported.
", + "DescribeOptionGroupsMessage$Filters": "This parameter is not currently supported.
", + "DescribeOrderableDBInstanceOptionsMessage$Filters": "This parameter is not currently supported.
", + "DescribePendingMaintenanceActionsMessage$Filters": "A filter that specifies one or more resources to return pending maintenance actions for.
Supported filters:
db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The results list will only include pending maintenance actions for the DB instances identified by these ARNs.
This parameter is not currently supported.
", + "DescribeReservedDBInstancesOfferingsMessage$Filters": "This parameter is not currently supported.
", + "ListTagsForResourceMessage$Filters": "This parameter is not currently supported.
" + } + }, + "FilterValueList": { + "base": null, + "refs": { + "Filter$Values": "This parameter is not currently supported.
" + } + }, + "IPRange": { + "base": "This data type is used as a response element in the DescribeDBSecurityGroups action.
", + "refs": { + "IPRangeList$member": null + } + }, + "IPRangeList": { + "base": null, + "refs": { + "DBSecurityGroup$IPRanges": "Contains a list of IPRange elements.
" + } + }, + "InstanceQuotaExceededFault": { + "base": "Request would result in user exceeding the allowed number of DB instances.
", + "refs": { + } + }, + "InsufficientDBClusterCapacityFault": { + "base": "The DB cluster does not have enough capacity for the current operation.
", + "refs": { + } + }, + "InsufficientDBInstanceCapacityFault": { + "base": "Specified DB instance class is not available in the specified Availability Zone.
", + "refs": { + } + }, + "InsufficientStorageClusterCapacityFault": { + "base": "There is insufficient storage available for the current action. You may be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.
", + "refs": { + } + }, + "Integer": { + "base": null, + "refs": { + "DBClusterSnapshot$AllocatedStorage": "Specifies the allocated storage size in gigabytes (GB).
", + "DBClusterSnapshot$Port": "Specifies the port that the DB cluster was listening on at the time of the snapshot.
", + "DBClusterSnapshot$PercentProgress": "Specifies the percentage of the estimated data that has been transferred.
", + "DBInstance$AllocatedStorage": "Specifies the allocated storage size specified in gigabytes.
", + "DBInstance$BackupRetentionPeriod": "Specifies the number of days for which automatic DB snapshots are retained.
", + "DBInstance$DbInstancePort": "Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.
", + "DBSnapshot$AllocatedStorage": "Specifies the allocated storage size in gigabytes (GB).
", + "DBSnapshot$Port": "Specifies the port that the database engine was listening on at the time of the snapshot.
", + "DBSnapshot$PercentProgress": "The percentage of the estimated data that has been transferred.
", + "DownloadDBLogFilePortionMessage$NumberOfLines": "The number of lines to download. If the number of lines specified results in a file over 1 MB in size, the file will be truncated at 1 MB in size.
If the NumberOfLines parameter is specified, then the block of lines returned can be from the beginning or the end of the log file, depending on the value of the Marker parameter.
If neither Marker or NumberOfLines are specified, the entire log file is returned up to a maximum of 10000 lines, starting with the most recent log entries first.
If NumberOfLines is specified and Marker is not specified, then the most recent lines from the end of the log file are returned.
If Marker is specified as \"0\", then the specified number of lines from the beginning of the log file are returned.
You can download the log file in blocks of lines by specifying the size of the block using the NumberOfLines parameter, and by specifying a value of \"0\" for the Marker parameter in your first request. Include the Marker value returned in the response as the Marker value for the next request, continuing until the AdditionalDataPending response element returns false.
Specifies the port that the database engine is listening on.
", + "ReservedDBInstance$Duration": "The duration of the reservation in seconds.
", + "ReservedDBInstance$DBInstanceCount": "The number of reserved DB instances.
", + "ReservedDBInstancesOffering$Duration": "The duration of the offering in seconds.
" + } + }, + "IntegerOptional": { + "base": null, + "refs": { + "CreateDBClusterMessage$BackupRetentionPeriod": "The number of days for which automated backups are retained. You must specify a minimum value of 1.
Default: 1
Constraints:
Must be a value from 1 to 35
The port number on which the instances in the DB cluster accept connections.
Default: 3306
The amount of storage (in gigabytes) to be initially allocated for the database instance.
Type: Integer
MySQL
Constraints: Must be an integer from 5 to 6144.
MariaDB
Constraints: Must be an integer from 5 to 6144.
PostgreSQL
Constraints: Must be an integer from 5 to 6144.
Oracle
Constraints: Must be an integer from 10 to 6144.
SQL Server
Constraints: Must be an integer from 200 to 4096 (Standard Edition and Enterprise Edition) or from 20 to 4096 (Express Edition and Web Edition)
", + "CreateDBInstanceMessage$BackupRetentionPeriod": "The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
Default: 1
Constraints:
Must be a value from 0 to 35
Cannot be set to 0 if the DB instance is a source to Read Replicas
The port number on which the database accepts connections.
MySQL
Default: 3306
Valid Values: 1150-65535
Type: Integer
MariaDB
Default: 3306
Valid Values: 1150-65535
Type: Integer
PostgreSQL
Default: 5432
Valid Values: 1150-65535
Type: Integer
Oracle
Default: 1521
Valid Values: 1150-65535
SQL Server
Default: 1433
Valid Values: 1150-65535 except for 1434, 3389, 47001, 49152, and 49152 through 49156.
Amazon Aurora
Default: 3306
Valid Values: 1150-65535
Type: Integer
", + "CreateDBInstanceMessage$Iops": "The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
Constraints: Must be a multiple between 3 and 10 of the storage amount for the DB instance. Must also be an integer multiple of 1000. For example, if the size of your DB instance is 500 GB, then your Iops value can be 2000, 3000, 4000, or 5000.
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.
If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster.
Default: 1
Valid Values: 0 - 15
", + "CreateDBInstanceReadReplicaMessage$Port": "The port number that the DB instance uses for connections.
Default: Inherits from the source DB instance
Valid Values: 1150-65535
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
", + "CreateDBInstanceReadReplicaMessage$MonitoringInterval": "The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the Read Replica. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.
If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60
Specifies the allocated storage size in gigabytes (GB).
", + "DBCluster$BackupRetentionPeriod": "Specifies the number of days for which automatic DB snapshots are retained.
", + "DBCluster$Port": "Specifies the port that the database engine is listening on.
", + "DBClusterMember$PromotionTier": "A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster.
", + "DBInstance$Iops": "Specifies the Provisioned IOPS (I/O operations per second) value.
", + "DBInstance$MonitoringInterval": "The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
", + "DBInstance$PromotionTier": "A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster.
", + "DBSnapshot$Iops": "Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
", + "DescribeCertificatesMessage$MaxRecords": " The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
", + "DescribeDBClusterParameterGroupsMessage$MaxRecords": " The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
", + "DescribeDBClusterParametersMessage$MaxRecords": " The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
", + "DescribeDBClusterSnapshotsMessage$MaxRecords": "The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
", + "DescribeDBClustersMessage$MaxRecords": "The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
", + "DescribeDBEngineVersionsMessage$MaxRecords": " The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
", + "DescribeDBInstancesMessage$MaxRecords": " The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
", + "DescribeDBLogFilesMessage$MaxRecords": "The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
", + "DescribeDBParameterGroupsMessage$MaxRecords": " The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
", + "DescribeDBParametersMessage$MaxRecords": " The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
", + "DescribeDBSecurityGroupsMessage$MaxRecords": " The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
", + "DescribeDBSnapshotsMessage$MaxRecords": " The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
", + "DescribeDBSubnetGroupsMessage$MaxRecords": " The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
", + "DescribeEngineDefaultClusterParametersMessage$MaxRecords": " The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called 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 pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
", + "DescribeEventSubscriptionsMessage$MaxRecords": " The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called 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 to retrieve events for.
Default: 60
", + "DescribeEventsMessage$MaxRecords": " The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
", + "DescribeOptionGroupOptionsMessage$MaxRecords": " The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
", + "DescribeOptionGroupsMessage$MaxRecords": " The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
", + "DescribeOrderableDBInstanceOptionsMessage$MaxRecords": " The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
", + "DescribePendingMaintenanceActionsMessage$MaxRecords": " The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
", + "DescribeReservedDBInstancesMessage$MaxRecords": " The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
", + "DescribeReservedDBInstancesOfferingsMessage$MaxRecords": " The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
", + "ModifyDBClusterMessage$BackupRetentionPeriod": "The number of days for which automated backups are retained. You must specify a minimum value of 1.
Default: 1
Constraints:
Must be a value from 1 to 35
The port number on which the DB cluster accepts connections.
Constraints: Value must be 1150-65535
Default: The same port as the original DB cluster.
", + "ModifyDBInstanceMessage$AllocatedStorage": " The new storage capacity of the RDS instance. Changing this setting does not result in an outage and the change is applied during the next maintenance window unless ApplyImmediately is set to true for this request.
MySQL
Default: Uses existing setting
Valid Values: 5-6144
Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
Type: Integer
MariaDB
Default: Uses existing setting
Valid Values: 5-6144
Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
Type: Integer
PostgreSQL
Default: Uses existing setting
Valid Values: 5-6144
Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
Type: Integer
Oracle
Default: Uses existing setting
Valid Values: 10-6144
Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
SQL Server
Cannot be modified.
If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance will be available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance will be suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a Read Replica for the instance, and creating a DB snapshot of the instance.
", + "ModifyDBInstanceMessage$BackupRetentionPeriod": "The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
Changing this parameter can result in an outage if you change from 0 to a non-zero value or from a non-zero value to 0. These changes are applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously applied as soon as possible.
Default: Uses existing setting
Constraints:
Must be a value from 0 to 35
Can be specified for a MySQL Read Replica only if the source is running MySQL 5.6
Can be specified for a PostgreSQL Read Replica only if the source is running PostgreSQL 9.3.5
Cannot be set to 0 if the DB instance is a source to Read Replicas
The new Provisioned IOPS (I/O operations per second) value for the RDS instance. Changing this setting does not result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.
Default: Uses existing setting
Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value. If you are migrating from Provisioned IOPS to standard storage, set this value to 0. The DB instance will require a reboot for the change in storage type to take effect.
SQL Server
Setting the IOPS value for the SQL Server database engine is not supported.
Type: Integer
If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance will be available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance will be suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a Read Replica for the instance, and creating a DB snapshot of the instance.
", + "ModifyDBInstanceMessage$MonitoringInterval": "The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.
If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60
The port number on which the database accepts connections.
The value of the DBPortNumber parameter must not match any of the port values specified for options in the option group for the DB instance.
Your database will restart when you change the DBPortNumber value regardless of the value of the ApplyImmediately parameter.
MySQL
Default: 3306
Valid Values: 1150-65535
MariaDB
Default: 3306
Valid Values: 1150-65535
PostgreSQL
Default: 5432
Valid Values: 1150-65535
Type: Integer
Oracle
Default: 1521
Valid Values: 1150-65535
SQL Server
Default: 1433
Valid Values: 1150-65535 except for 1434, 3389, 47001, 49152, and 49152 through 49156.
Amazon Aurora
Default: 3306
Valid Values: 1150-65535
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster.
Default: 1
Valid Values: 0 - 15
", + "Option$Port": "If required, the port configured for this option to use.
", + "OptionConfiguration$Port": "The optional port for the option.
", + "OptionGroupOption$DefaultPort": "If the option requires a port, specifies the default port for the option.
", + "PendingModifiedValues$AllocatedStorage": " Contains the new AllocatedStorage size for the DB instance that will be applied or is in progress.
Specifies the pending port for the DB instance.
", + "PendingModifiedValues$BackupRetentionPeriod": "Specifies the pending number of days for which automated backups are retained.
", + "PendingModifiedValues$Iops": "Specifies the new Provisioned IOPS value for the DB instance that will be applied or is being applied.
", + "PromoteReadReplicaMessage$BackupRetentionPeriod": "The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
Default: 1
Constraints:
Must be a value from 0 to 8
The number of instances to reserve.
Default: 1
The port number on which the new DB cluster accepts connections.
Constraints: Value must be 1150-65535
Default: The same port as the original DB cluster.
", + "RestoreDBClusterToPointInTimeMessage$Port": "The port number on which the new DB cluster accepts connections.
Constraints: Value must be 1150-65535
Default: The same port as the original DB cluster.
", + "RestoreDBInstanceFromDBSnapshotMessage$Port": "The port number on which the database accepts connections.
Default: The same port as the original DB instance
Constraints: Value must be 1150-65535
Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. If this parameter is not specified, the IOPS value will be taken from the backup. If this parameter is set to 0, the new instance will be converted to a non-PIOPS instance, which will take additional time, though your DB instance will be available for connections before the conversion starts.
Constraints: Must be an integer greater than 1000.
SQL Server
Setting the IOPS value for the SQL Server database engine is not supported.
", + "RestoreDBInstanceToPointInTimeMessage$Port": "The port number on which the database accepts connections.
Constraints: Value must be 1150-65535
Default: The same port as the original DB instance.
", + "RestoreDBInstanceToPointInTimeMessage$Iops": "The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
Constraints: Must be an integer greater than 1000.
SQL Server
Setting the IOPS value for the SQL Server database engine is not supported.
" + } + }, + "InvalidDBClusterSnapshotStateFault": { + "base": "The supplied value is not a valid DB cluster snapshot state.
", + "refs": { + } + }, + "InvalidDBClusterStateFault": { + "base": "The DB cluster is not in a valid state.
", + "refs": { + } + }, + "InvalidDBInstanceStateFault": { + "base": "The specified DB instance is not in the available state.
", + "refs": { + } + }, + "InvalidDBParameterGroupStateFault": { + "base": "The DB parameter group cannot be deleted because it is in use.
", + "refs": { + } + }, + "InvalidDBSecurityGroupStateFault": { + "base": "The state of the DB security group does not allow deletion.
", + "refs": { + } + }, + "InvalidDBSnapshotStateFault": { + "base": "The state of the DB snapshot does not allow deletion.
", + "refs": { + } + }, + "InvalidDBSubnetGroupFault": { + "base": "Indicates the DBSubnetGroup does not belong to the same VPC as that of an existing cross region read replica of the same source instance.
", + "refs": { + } + }, + "InvalidDBSubnetGroupStateFault": { + "base": "The DB subnet group cannot be deleted because it is in use.
", + "refs": { + } + }, + "InvalidDBSubnetStateFault": { + "base": "The DB subnet is not in the available state.
", + "refs": { + } + }, + "InvalidEventSubscriptionStateFault": { + "base": "This error can occur if someone else is modifying a subscription. You should retry the action.
", + "refs": { + } + }, + "InvalidOptionGroupStateFault": { + "base": "The option group is not in the available state.
", + "refs": { + } + }, + "InvalidRestoreFault": { + "base": "Cannot restore from vpc backup to non-vpc DB instance.
", + "refs": { + } + }, + "InvalidSubnet": { + "base": "The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
", + "refs": { + } + }, + "InvalidVPCNetworkStateFault": { + "base": "DB subnet group does not cover all Availability Zones after it is created because users' change.
", + "refs": { + } + }, + "KMSKeyNotAccessibleFault": { + "base": "Error accessing KMS key.
", + "refs": { + } + }, + "KeyList": { + "base": null, + "refs": { + "RemoveTagsFromResourceMessage$TagKeys": "The tag key (name) of the tag to be removed.
" + } + }, + "ListTagsForResourceMessage": { + "base": "", + "refs": { + } + }, + "Long": { + "base": null, + "refs": { + "AccountQuota$Used": "The amount currently used toward the quota maximum.
", + "AccountQuota$Max": "The maximum allowed value for the quota.
", + "DescribeDBLogFilesDetails$LastWritten": "A POSIX timestamp when the last log entry was written.
", + "DescribeDBLogFilesDetails$Size": "The size, in bytes, of the log file for the specified DB instance.
", + "DescribeDBLogFilesMessage$FileLastWritten": "Filters the available log files for files written since the specified date, in POSIX timestamp format with milliseconds.
", + "DescribeDBLogFilesMessage$FileSize": "Filters the available log files for files larger than the specified size.
" + } + }, + "ModifyDBClusterMessage": { + "base": "", + "refs": { + } + }, + "ModifyDBClusterParameterGroupMessage": { + "base": "", + "refs": { + } + }, + "ModifyDBClusterResult": { + "base": null, + "refs": { + } + }, + "ModifyDBClusterSnapshotAttributeMessage": { + "base": "", + "refs": { + } + }, + "ModifyDBClusterSnapshotAttributeResult": { + "base": null, + "refs": { + } + }, + "ModifyDBInstanceMessage": { + "base": "", + "refs": { + } + }, + "ModifyDBInstanceResult": { + "base": null, + "refs": { + } + }, + "ModifyDBParameterGroupMessage": { + "base": "", + "refs": { + } + }, + "ModifyDBSnapshotAttributeMessage": { + "base": "", + "refs": { + } + }, + "ModifyDBSnapshotAttributeResult": { + "base": null, + "refs": { + } + }, + "ModifyDBSubnetGroupMessage": { + "base": "", + "refs": { + } + }, + "ModifyDBSubnetGroupResult": { + "base": null, + "refs": { + } + }, + "ModifyEventSubscriptionMessage": { + "base": "", + "refs": { + } + }, + "ModifyEventSubscriptionResult": { + "base": null, + "refs": { + } + }, + "ModifyOptionGroupMessage": { + "base": "", + "refs": { + } + }, + "ModifyOptionGroupResult": { + "base": null, + "refs": { + } + }, + "Option": { + "base": "Option details.
", + "refs": { + "OptionsList$member": null + } + }, + "OptionConfiguration": { + "base": "A list of all available options
", + "refs": { + "OptionConfigurationList$member": null + } + }, + "OptionConfigurationList": { + "base": null, + "refs": { + "ModifyOptionGroupMessage$OptionsToInclude": "Options in this list are added to the option group or, if already present, the specified configuration is used to update the existing configuration.
" + } + }, + "OptionGroup": { + "base": "", + "refs": { + "CopyOptionGroupResult$OptionGroup": null, + "CreateOptionGroupResult$OptionGroup": null, + "ModifyOptionGroupResult$OptionGroup": null, + "OptionGroupsList$member": null + } + }, + "OptionGroupAlreadyExistsFault": { + "base": "The option group you are trying to create already exists.
", + "refs": { + } + }, + "OptionGroupMembership": { + "base": "Provides information on the option groups the DB instance is a member of.
", + "refs": { + "OptionGroupMembershipList$member": null + } + }, + "OptionGroupMembershipList": { + "base": null, + "refs": { + "DBInstance$OptionGroupMemberships": "Provides the list of option group memberships for this DB instance.
" + } + }, + "OptionGroupNotFoundFault": { + "base": "The specified option group could not be found.
", + "refs": { + } + }, + "OptionGroupOption": { + "base": "Available option.
", + "refs": { + "OptionGroupOptionsList$member": null + } + }, + "OptionGroupOptionSetting": { + "base": "Option group option settings are used to display settings available for each option with their default values and other information. These values are used with the DescribeOptionGroupOptions action.
", + "refs": { + "OptionGroupOptionSettingsList$member": null + } + }, + "OptionGroupOptionSettingsList": { + "base": null, + "refs": { + "OptionGroupOption$OptionGroupOptionSettings": "Specifies the option settings that are available (and the default value) for each option in an option group.
" + } + }, + "OptionGroupOptionsList": { + "base": "List of available option group options.
", + "refs": { + "OptionGroupOptionsMessage$OptionGroupOptions": null + } + }, + "OptionGroupOptionsMessage": { + "base": "", + "refs": { + } + }, + "OptionGroupQuotaExceededFault": { + "base": "The quota of 20 option groups was exceeded for this AWS account.
", + "refs": { + } + }, + "OptionGroups": { + "base": "List of option groups.
", + "refs": { + } + }, + "OptionGroupsList": { + "base": null, + "refs": { + "OptionGroups$OptionGroupsList": "List of option groups.
" + } + }, + "OptionNamesList": { + "base": null, + "refs": { + "ModifyOptionGroupMessage$OptionsToRemove": "Options in this list are removed from the option group.
" + } + }, + "OptionSetting": { + "base": "Option settings are the actual settings being applied or configured for that option. It is used when you modify an option group or describe option groups. For example, the NATIVE_NETWORK_ENCRYPTION option has a setting called SQLNET.ENCRYPTION_SERVER that can have several different values.
", + "refs": { + "OptionSettingConfigurationList$member": null, + "OptionSettingsList$member": null + } + }, + "OptionSettingConfigurationList": { + "base": null, + "refs": { + "Option$OptionSettings": "The option settings for this option.
" + } + }, + "OptionSettingsList": { + "base": null, + "refs": { + "OptionConfiguration$OptionSettings": "The option settings to include in an option group.
" + } + }, + "OptionsDependedOn": { + "base": null, + "refs": { + "OptionGroupOption$OptionsDependedOn": "List of all options that are prerequisites for this option.
" + } + }, + "OptionsList": { + "base": null, + "refs": { + "OptionGroup$Options": "Indicates what options are available in the option group.
" + } + }, + "OrderableDBInstanceOption": { + "base": "Contains a list of available options for a DB instance
This data type is used as a response element in the DescribeOrderableDBInstanceOptions action.
", + "refs": { + "OrderableDBInstanceOptionsList$member": null + } + }, + "OrderableDBInstanceOptionsList": { + "base": null, + "refs": { + "OrderableDBInstanceOptionsMessage$OrderableDBInstanceOptions": "An OrderableDBInstanceOption structure containing information about orderable options for the DB instance.
" + } + }, + "OrderableDBInstanceOptionsMessage": { + "base": "Contains the result of a successful invocation of the DescribeOrderableDBInstanceOptions action.
", + "refs": { + } + }, + "Parameter": { + "base": "This data type is used as a request parameter in the ModifyDBParameterGroup and ResetDBParameterGroup actions.
This data type is used as a response element in the DescribeEngineDefaultParameters and DescribeDBParameters actions.
", + "refs": { + "ParametersList$member": null + } + }, + "ParametersList": { + "base": null, + "refs": { + "DBClusterParameterGroupDetails$Parameters": "Provides a list of parameters for the DB cluster parameter group.
", + "DBParameterGroupDetails$Parameters": "A list of Parameter values.
", + "EngineDefaults$Parameters": "Contains a list of engine default parameters.
", + "ModifyDBClusterParameterGroupMessage$Parameters": "A list of parameters in the DB cluster parameter group to modify.
", + "ModifyDBParameterGroupMessage$Parameters": "An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters can be modified in a single request.
Valid Values (for the application method): immediate | pending-reboot
You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when you reboot the DB instance without failover.
A list of parameter names in the DB cluster parameter group to reset to the default values. You cannot use this parameter if the ResetAllParameters parameter is set to true.
An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters can be modified in a single request.
MySQL
Valid Values (for Apply method): immediate | pending-reboot
You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when DB instance reboots.
MariaDB
Valid Values (for Apply method): immediate | pending-reboot
You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when DB instance reboots.
Oracle
Valid Values (for Apply method): pending-reboot
Provides information about a pending maintenance action for a resource.
", + "refs": { + "PendingMaintenanceActionDetails$member": null + } + }, + "PendingMaintenanceActionDetails": { + "base": null, + "refs": { + "ResourcePendingMaintenanceActions$PendingMaintenanceActionDetails": "A list that provides details about the pending maintenance actions for the resource.
" + } + }, + "PendingMaintenanceActions": { + "base": null, + "refs": { + "PendingMaintenanceActionsMessage$PendingMaintenanceActions": "A list of the pending maintenance actions for the resource.
" + } + }, + "PendingMaintenanceActionsMessage": { + "base": "Data returned from the DescribePendingMaintenanceActions action.
", + "refs": { + } + }, + "PendingModifiedValues": { + "base": "This data type is used as a response element in the ModifyDBInstance action.
", + "refs": { + "DBInstance$PendingModifiedValues": "Specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
" + } + }, + "PointInTimeRestoreNotEnabledFault": { + "base": "SourceDBInstanceIdentifier refers to a DB instance with BackupRetentionPeriod equal to 0.
", + "refs": { + } + }, + "PromoteReadReplicaDBClusterMessage": { + "base": "", + "refs": { + } + }, + "PromoteReadReplicaDBClusterResult": { + "base": null, + "refs": { + } + }, + "PromoteReadReplicaMessage": { + "base": "", + "refs": { + } + }, + "PromoteReadReplicaResult": { + "base": null, + "refs": { + } + }, + "ProvisionedIopsNotAvailableInAZFault": { + "base": "Provisioned IOPS not available in the specified Availability Zone.
", + "refs": { + } + }, + "PurchaseReservedDBInstancesOfferingMessage": { + "base": "", + "refs": { + } + }, + "PurchaseReservedDBInstancesOfferingResult": { + "base": null, + "refs": { + } + }, + "ReadReplicaDBInstanceIdentifierList": { + "base": null, + "refs": { + "DBInstance$ReadReplicaDBInstanceIdentifiers": "Contains one or more identifiers of the Read Replicas associated with this DB instance.
" + } + }, + "ReadReplicaIdentifierList": { + "base": null, + "refs": { + "DBCluster$ReadReplicaIdentifiers": "Contains one or more identifiers of the Read Replicas associated with this DB cluster.
" + } + }, + "RebootDBInstanceMessage": { + "base": "", + "refs": { + } + }, + "RebootDBInstanceResult": { + "base": null, + "refs": { + } + }, + "RecurringCharge": { + "base": "This data type is used as a response element in the DescribeReservedDBInstances and DescribeReservedDBInstancesOfferings actions.
", + "refs": { + "RecurringChargeList$member": null + } + }, + "RecurringChargeList": { + "base": null, + "refs": { + "ReservedDBInstance$RecurringCharges": "The recurring price charged to run this reserved DB instance.
", + "ReservedDBInstancesOffering$RecurringCharges": "The recurring price charged to run this reserved DB instance.
" + } + }, + "RemoveSourceIdentifierFromSubscriptionMessage": { + "base": "", + "refs": { + } + }, + "RemoveSourceIdentifierFromSubscriptionResult": { + "base": null, + "refs": { + } + }, + "RemoveTagsFromResourceMessage": { + "base": "", + "refs": { + } + }, + "ReservedDBInstance": { + "base": "This data type is used as a response element in the DescribeReservedDBInstances and PurchaseReservedDBInstancesOffering actions.
", + "refs": { + "PurchaseReservedDBInstancesOfferingResult$ReservedDBInstance": null, + "ReservedDBInstanceList$member": null + } + }, + "ReservedDBInstanceAlreadyExistsFault": { + "base": "User already has a reservation with the given identifier.
", + "refs": { + } + }, + "ReservedDBInstanceList": { + "base": null, + "refs": { + "ReservedDBInstanceMessage$ReservedDBInstances": "A list of reserved DB instances.
" + } + }, + "ReservedDBInstanceMessage": { + "base": "Contains the result of a successful invocation of the DescribeReservedDBInstances action.
", + "refs": { + } + }, + "ReservedDBInstanceNotFoundFault": { + "base": "The specified reserved DB Instance not found.
", + "refs": { + } + }, + "ReservedDBInstanceQuotaExceededFault": { + "base": "Request would exceed the user's DB Instance quota.
", + "refs": { + } + }, + "ReservedDBInstancesOffering": { + "base": "This data type is used as a response element in the DescribeReservedDBInstancesOfferings action.
", + "refs": { + "ReservedDBInstancesOfferingList$member": null + } + }, + "ReservedDBInstancesOfferingList": { + "base": null, + "refs": { + "ReservedDBInstancesOfferingMessage$ReservedDBInstancesOfferings": "A list of reserved DB instance offerings.
" + } + }, + "ReservedDBInstancesOfferingMessage": { + "base": "Contains the result of a successful invocation of the DescribeReservedDBInstancesOfferings action.
", + "refs": { + } + }, + "ReservedDBInstancesOfferingNotFoundFault": { + "base": "Specified offering does not exist.
", + "refs": { + } + }, + "ResetDBClusterParameterGroupMessage": { + "base": "", + "refs": { + } + }, + "ResetDBParameterGroupMessage": { + "base": "", + "refs": { + } + }, + "ResourceNotFoundFault": { + "base": "The specified resource ID was not found.
", + "refs": { + } + }, + "ResourcePendingMaintenanceActions": { + "base": "Describes the pending maintenance actions for a resource.
", + "refs": { + "ApplyPendingMaintenanceActionResult$ResourcePendingMaintenanceActions": null, + "PendingMaintenanceActions$member": null + } + }, + "RestoreDBClusterFromSnapshotMessage": { + "base": "", + "refs": { + } + }, + "RestoreDBClusterFromSnapshotResult": { + "base": null, + "refs": { + } + }, + "RestoreDBClusterToPointInTimeMessage": { + "base": "", + "refs": { + } + }, + "RestoreDBClusterToPointInTimeResult": { + "base": null, + "refs": { + } + }, + "RestoreDBInstanceFromDBSnapshotMessage": { + "base": "", + "refs": { + } + }, + "RestoreDBInstanceFromDBSnapshotResult": { + "base": null, + "refs": { + } + }, + "RestoreDBInstanceToPointInTimeMessage": { + "base": "", + "refs": { + } + }, + "RestoreDBInstanceToPointInTimeResult": { + "base": null, + "refs": { + } + }, + "RevokeDBSecurityGroupIngressMessage": { + "base": "", + "refs": { + } + }, + "RevokeDBSecurityGroupIngressResult": { + "base": null, + "refs": { + } + }, + "SNSInvalidTopicFault": { + "base": "SNS has responded that there is a problem with the SND topic specified.
", + "refs": { + } + }, + "SNSNoAuthorizationFault": { + "base": "You do not have permission to publish to the SNS topic ARN.
", + "refs": { + } + }, + "SNSTopicArnNotFoundFault": { + "base": "The SNS topic ARN does not exist.
", + "refs": { + } + }, + "SharedSnapshotQuotaExceededFault": { + "base": "You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.
", + "refs": { + } + }, + "SnapshotQuotaExceededFault": { + "base": "Request would result in user exceeding the allowed number of DB snapshots.
", + "refs": { + } + }, + "SourceIdsList": { + "base": null, + "refs": { + "CreateEventSubscriptionMessage$SourceIds": "The list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens.
Constraints:
If SourceIds are supplied, SourceType must also be provided.
If the source type is a DB instance, then a DBInstanceIdentifier must be supplied.
If the source type is a DB security group, a DBSecurityGroupName must be supplied.
If the source type is a DB parameter group, a DBParameterGroupName must be supplied.
If the source type is a DB snapshot, a DBSnapshotIdentifier must be supplied.
A list of source IDs for the RDS event notification subscription.
" + } + }, + "SourceNotFoundFault": { + "base": "The requested source could not be found.
", + "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 source type for this event.
" + } + }, + "StorageQuotaExceededFault": { + "base": "Request would result in user exceeding the allowed amount of storage available across all DB instances.
", + "refs": { + } + }, + "StorageTypeNotSupportedFault": { + "base": "StorageType specified cannot be associated with the DB Instance.
", + "refs": { + } + }, + "String": { + "base": null, + "refs": { + "AccountQuota$AccountQuotaName": "The name of the Amazon RDS quota for this AWS account.
", + "AddSourceIdentifierToSubscriptionMessage$SubscriptionName": "The name of the RDS event notification subscription you want to add a source identifier to.
", + "AddSourceIdentifierToSubscriptionMessage$SourceIdentifier": "The identifier of the event source to be added. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens.
Constraints:
If the source type is a DB instance, then a DBInstanceIdentifier must be supplied.
If the source type is a DB security group, a DBSecurityGroupName must be supplied.
If the source type is a DB parameter group, a DBParameterGroupName must be supplied.
If the source type is a DB snapshot, a DBSnapshotIdentifier must be supplied.
The Amazon RDS resource the tags will be added to. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).
", + "ApplyPendingMaintenanceActionMessage$ResourceIdentifier": "The RDS Amazon Resource Name (ARN) of the resource that the pending maintenance action applies to. For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).
", + "ApplyPendingMaintenanceActionMessage$ApplyAction": "The pending maintenance action to apply to this resource.
Valid values: system-update, db-upgrade
A value that specifies the type of opt-in request, or undoes an opt-in request. An opt-in request of type immediate cannot be undone.
Valid values:
immediate - Apply the maintenance action immediately.
next-maintenance - Apply the maintenance action during the next maintenance window for the resource.
undo-opt-in - Cancel any existing next-maintenance opt-in requests.
The name of the DB security group to add authorization to.
", + "AuthorizeDBSecurityGroupIngressMessage$CIDRIP": "The IP range to authorize.
", + "AuthorizeDBSecurityGroupIngressMessage$EC2SecurityGroupName": " Name of the EC2 security group to authorize. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
Id of the EC2 security group to authorize. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
AWS account number of the owner of the EC2 security group specified in the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
The name of the availability zone.
", + "AvailabilityZones$member": null, + "Certificate$CertificateIdentifier": "The unique key that identifies a certificate.
", + "Certificate$CertificateType": "The type of the certificate.
", + "Certificate$Thumbprint": "The thumbprint of the certificate.
", + "CertificateMessage$Marker": " An optional pagination token provided by a previous DescribeCertificates request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
The name of the character set.
", + "CharacterSet$CharacterSetDescription": "The description of the character set.
", + "CopyDBClusterSnapshotMessage$SourceDBClusterSnapshotIdentifier": "The identifier of the DB cluster snapshot to copy. This parameter is not case-sensitive.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Example: my-cluster-snapshot1
The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter is not case-sensitive.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Example: my-cluster-snapshot2
The identifier or ARN for the source DB parameter group. For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).
Constraints:
Must specify a valid DB parameter group.
If the source DB parameter group is in the same region as the copy, specify a valid DB parameter group identifier, for example my-db-param-group, or a valid ARN.
If the source DB parameter group is in a different region than the copy, specify a valid DB parameter group ARN, for example arn:aws:rds:us-west-2:123456789012:pg:special-parameters.
The identifier for the copied DB parameter group.
Constraints:
Cannot be null, empty, or blank
Must contain from 1 to 255 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
Example: my-db-parameter-group
A description for the copied DB parameter group.
", + "CopyDBSnapshotMessage$SourceDBSnapshotIdentifier": "The identifier for the source DB snapshot.
If you are copying from a shared manual DB snapshot, this must be the ARN of the shared DB snapshot.
Constraints:
Must specify a valid system snapshot in the \"available\" state.
If the source snapshot is in the same region as the copy, specify a valid DB snapshot identifier.
If the source snapshot is in a different region than the copy, specify a valid DB snapshot ARN. For more information, go to Copying a DB Snapshot.
Example: rds:mydb-2012-04-02-00-01
Example: arn:aws:rds:rr-regn-1:123456789012:snapshot:mysql-instance1-snapshot-20130805
The identifier for the copied snapshot.
Constraints:
Cannot be null, empty, or blank
Must contain from 1 to 255 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
Example: my-db-snapshot
The AWS Key Management Service (AWS KMS) key identifier for an encrypted DB snapshot. The KMS key identifier is the Amazon Resource Name (ARN) or the KMS key alias for the KMS encryption key.
If you copy an unencrypted DB snapshot and specify a value for the KmsKeyId parameter, Amazon RDS encrypts the target DB snapshot using the specified KMS encryption key.
If you copy an encrypted DB snapshot from your AWS account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS encryption key. If you don't specify a value for KmsKeyId then the copy of the DB snapshot is encrypted with the same KMS key as the source DB snapshot.
If you copy an encrypted DB snapshot that is shared from another AWS account, then you must specify a value for KmsKeyId.
The identifier or ARN for the source option group. For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).
Constraints:
Must specify a valid option group.
If the source option group is in the same region as the copy, specify a valid option group identifier, for example my-option-group, or a valid ARN.
If the source option group is in a different region than the copy, specify a valid option group ARN, for example arn:aws:rds:us-west-2:123456789012:og:special-options.
The identifier for the copied option group.
Constraints:
Cannot be null, empty, or blank
Must contain from 1 to 255 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
Example: my-option-group
The description for the copied option group.
", + "CreateDBClusterMessage$CharacterSetName": "A value that indicates that the DB cluster should be associated with the specified CharacterSet.
", + "CreateDBClusterMessage$DatabaseName": "The name for your database of up to 8 alpha-numeric characters. If you do not provide a name, Amazon RDS will not create a database in the DB cluster you are creating.
", + "CreateDBClusterMessage$DBClusterIdentifier": "The DB cluster identifier. This parameter is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Example: my-cluster1
The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, default.aurora5.6 for the specified engine will be used.
Constraints:
Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
A DB subnet group to associate with this DB cluster.
Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.
Example: mySubnetgroup
The name of the database engine to be used for this DB cluster.
Valid Values: aurora
The version number of the database engine to use.
Aurora
Example: 5.6.10a
The name of the master user for the client DB cluster.
Constraints:
Must be 1 to 16 alphanumeric characters.
First character must be a letter.
Cannot be a reserved word for the chosen database engine.
The password for the master database user. This password can contain any printable ASCII character except \"/\", \"\"\", or \"@\".
Constraints: Must contain from 8 to 41 characters.
", + "CreateDBClusterMessage$OptionGroupName": "A value that indicates that the DB cluster should be associated with the specified option group.
Permanent options cannot be removed from an option group. The option group cannot be removed from a DB cluster once it is associated with a DB cluster.
", + "CreateDBClusterMessage$PreferredBackupWindow": "The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.
Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Constraints:
Must be in the format hh24:mi-hh24:mi.
Times should be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
", + "CreateDBClusterMessage$ReplicationSourceIdentifier": "The Amazon Resource Name (ARN) of the source DB cluster if this DB cluster is created as a Read Replica.
", + "CreateDBClusterMessage$KmsKeyId": "The KMS key identifier for an encrypted DB cluster.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KM encryption key.
If the StorageEncrypted parameter is true, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.
The name of the DB cluster parameter group.
Constraints:
Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
This value is stored as a lowercase string.
The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family.
", + "CreateDBClusterParameterGroupMessage$Description": "The description for the DB cluster parameter group.
", + "CreateDBClusterSnapshotMessage$DBClusterSnapshotIdentifier": "The identifier of the DB cluster snapshot. This parameter is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Example: my-cluster1-snapshot1
The identifier of the DB cluster to create a snapshot for. This parameter is not case-sensitive.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Example: my-cluster1
The meaning of this parameter differs according to the database engine you use.
Type: String
MySQL
The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.
Constraints:
Must contain 1 to 64 alphanumeric characters
Cannot be a word reserved by the specified database engine
MariaDB
The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.
Constraints:
Must contain 1 to 64 alphanumeric characters
Cannot be a word reserved by the specified database engine
PostgreSQL
The name of the database to create when the DB instance is created. If this parameter is not specified, the default \"postgres\" database is created in the DB instance.
Constraints:
Must contain 1 to 63 alphanumeric characters
Must begin with a letter or an underscore. Subsequent characters can be letters, underscores, or digits (0-9).
Cannot be a word reserved by the specified database engine
Oracle
The Oracle System ID (SID) of the created DB instance.
Default: ORCL
Constraints:
Cannot be longer than 8 characters
SQL Server
Not applicable. Must be null.
Amazon Aurora
The name of the database to create when the primary instance of the DB cluster is created. If this parameter is not specified, no database is created in the DB instance.
Constraints:
Must contain 1 to 64 alphanumeric characters
Cannot be a word reserved by the specified database engine
The DB instance identifier. This parameter is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens (1 to 15 for SQL Server).
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Example: mydbinstance
The compute and memory capacity of the DB instance.
Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large
The name of the database engine to be used for this instance.
Valid Values: MySQL | mariadb | oracle-se1 | oracle-se | oracle-ee | sqlserver-ee | sqlserver-se | sqlserver-ex | sqlserver-web | postgres | aurora
Not every database engine is available for every AWS region.
", + "CreateDBInstanceMessage$MasterUsername": "The name of master user for the client DB instance.
MySQL
Constraints:
Must be 1 to 16 alphanumeric characters.
First character must be a letter.
Cannot be a reserved word for the chosen database engine.
MariaDB
Constraints:
Must be 1 to 16 alphanumeric characters.
Cannot be a reserved word for the chosen database engine.
Type: String
Oracle
Constraints:
Must be 1 to 30 alphanumeric characters.
First character must be a letter.
Cannot be a reserved word for the chosen database engine.
SQL Server
Constraints:
Must be 1 to 128 alphanumeric characters.
First character must be a letter.
Cannot be a reserved word for the chosen database engine.
PostgreSQL
Constraints:
Must be 1 to 63 alphanumeric characters.
First character must be a letter.
Cannot be a reserved word for the chosen database engine.
The password for the master database user. Can be any printable ASCII character except \"/\", \"\"\", or \"@\".
Type: String
MySQL
Constraints: Must contain from 8 to 41 characters.
MariaDB
Constraints: Must contain from 8 to 41 characters.
Oracle
Constraints: Must contain from 8 to 30 characters.
SQL Server
Constraints: Must contain from 8 to 128 characters.
PostgreSQL
Constraints: Must contain from 8 to 128 characters.
Amazon Aurora
Constraints: Must contain from 8 to 41 characters.
", + "CreateDBInstanceMessage$AvailabilityZone": "The EC2 Availability Zone that the database instance will be created in. For information on regions and Availability Zones, see Regions and Availability Zones.
Default: A random, system-chosen Availability Zone in the endpoint's region.
Example: us-east-1d
Constraint: The AvailabilityZone parameter cannot be specified if the MultiAZ parameter is set to true. The specified Availability Zone must be in the same region as the current endpoint.
A DB subnet group to associate with this DB instance.
If there is no DB subnet group, then it is a non-VPC DB instance.
", + "CreateDBInstanceMessage$PreferredMaintenanceWindow": "The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see DB Instance Maintenance.
Format: ddd:hh24:mi-ddd:hh24:mi
Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
", + "CreateDBInstanceMessage$DBParameterGroupName": "The name of the DB parameter group to associate with this DB instance. If this argument is omitted, the default DBParameterGroup for the specified engine will be used.
Constraints:
Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. For more information, see DB Instance Backups.
Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Constraints:
Must be in the format hh24:mi-hh24:mi.
Times should be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
The version number of the database engine to use.
The following are the database engines and major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS region.
Amazon Aurora
Version 5.6 (only available in AWS regions ap-northeast-1, ap-northeast-2, ap-southeast-2, eu-west-1, us-east-1, us-west-2): 5.6.10a
MariaDB
Version 10.0 (available in all AWS regions): 10.0.17 | 10.0.24
Microsoft SQL Server Enterprise Edition (sqlserver-ee)
Version 11.00 (available in all AWS regions): 11.00.2100.60.v1 | 11.00.5058.0.v1 | 11.00.6020.0.v1
Version 10.50 (available in all AWS regions): 10.50.2789.0.v1 | 10.50.6000.34.v1 | 10.50.6529.0.v1
Microsoft SQL Server Express Edition (sqlserver-ex)
Version 12.00 (available in all AWS regions): 12.00.4422.0.v1
Version 11.00 (available in all AWS regions): 11.00.2100.60.v1 | 11.00.5058.0.v1 | 11.00.6020.0.v1
Version 10.50 (available in all AWS regions): 10.50.2789.0.v1 | 10.50.6000.34.v1 | 10.50.6529.0.v1
Microsoft SQL Server Standard Edition (sqlserver-se)
Version 12.00 (available in all AWS regions): 12.00.4422.0.v1
Version 11.00 (available in all AWS regions): 11.00.2100.60.v1 | 11.00.5058.0.v1 | 11.00.6020.0.v1
Version 10.50 (available in all AWS regions): 10.50.2789.0.v1 | 10.50.6000.34.v1 | 10.50.6529.0.v1
Microsoft SQL Server Web Edition (sqlserver-web)
Version 12.00 (available in all AWS regions): 12.00.4422.0.v1
Version 11.00 (available in all AWS regions): 11.00.2100.60.v1 | 11.00.5058.0.v1 | 11.00.6020.0.v1
Version 10.50 (available in all AWS regions): 10.50.2789.0.v1 | 10.50.6000.34.v1 | 10.50.6529.0.v1
MySQL
Version 5.7 (available in all AWS regions): 5.7.10 | 5.7.11
Version 5.6 (available in all AWS regions except ap-northeast-2): 5.6.19a | 5.6.19b | 5.6.21 | 5.6.21b | 5.6.22
Version 5.6 (available in all AWS regions): 5.6.23 | 5.6.27 | 5.6.29
Version 5.5 (available in all AWS regions except eu-central-1, ap-northeast-2): 5.5.40 | 5.5.40a
Version 5.5 (available in all AWS regions except ap-northeast-2): 5.5.40b | 5.5.41
Version 5.5 (available in all AWS regions): 5.5.42 | 5.5.46
Version 5.1 (available in all AWS regions except eu-central-1, ap-northeast-2): 5.1.73a | 5.1.73b
Oracle Database Enterprise Edition (oracle-ee)
Version 12.1 (available in all AWS regions except ap-northeast-2): 12.1.0.1.v1 | 12.1.0.1.v2
Version 12.1 (available in all AWS regions except ap-northeast-2, us-gov-west-1): 12.1.0.1.v3 | 12.1.0.1.v4
Version 12.1 (available in all AWS regions): 12.1.0.2.v1
Version 12.1 (available in all AWS regions except us-gov-west-1): 12.1.0.2.v2 | 12.1.0.2.v3
Version 11.2 (available in all AWS regions except eu-central-1, ap-northeast-2): 11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7
Version 11.2 (available in all AWS regions except ap-northeast-2): 11.2.0.3.v1 | 11.2.0.3.v2 | 11.2.0.3.v3
Version 11.2 (available in all AWS regions except ap-northeast-2, us-gov-west-1): 11.2.0.3.v4
Version 11.2 (available in all AWS regions): 11.2.0.4.v1 | 11.2.0.4.v3 | 11.2.0.4.v4
Version 11.2 (available in all AWS regions except us-gov-west-1): 11.2.0.4.v5 | 11.2.0.4.v6 | 11.2.0.4.v7
Oracle Database Standard Edition (oracle-se)
Version 12.1 (available in all AWS regions except ap-northeast-2): 12.1.0.1.v1 | 12.1.0.1.v2
Version 12.1 (available in all AWS regions except ap-northeast-2, us-gov-west-1): 12.1.0.1.v3 | 12.1.0.1.v4
Version 11.2 (available in all AWS regions except eu-central-1, ap-northeast-2): 11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7
Version 11.2 (available in all AWS regions except ap-northeast-2): 11.2.0.3.v1 | 11.2.0.3.v2 | 11.2.0.3.v3
Version 11.2 (available in all AWS regions except ap-northeast-2, us-gov-west-1): 11.2.0.3.v4
Version 11.2 (available in all AWS regions): 11.2.0.4.v1 | 11.2.0.4.v3 | 11.2.0.4.v4
Version 11.2 (available in all AWS regions except us-gov-west-1): 11.2.0.4.v5 | 11.2.0.4.v6 | 11.2.0.4.v7
Oracle Database Standard Edition One (oracle-se1)
Version 12.1 (available in all AWS regions except ap-northeast-2): 12.1.0.1.v1 | 12.1.0.1.v2
Version 12.1 (available in all AWS regions except ap-northeast-2, us-gov-west-1): 12.1.0.1.v3 | 12.1.0.1.v4
Version 11.2 (available in all AWS regions except eu-central-1, ap-northeast-2): 11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7
Version 11.2 (available in all AWS regions except ap-northeast-2): 11.2.0.3.v1 | 11.2.0.3.v2 | 11.2.0.3.v3
Version 11.2 (available in all AWS regions except ap-northeast-2, us-gov-west-1): 11.2.0.3.v4
Version 11.2 (available in all AWS regions): 11.2.0.4.v1 | 11.2.0.4.v3 | 11.2.0.4.v4
Version 11.2 (available in all AWS regions except us-gov-west-1): 11.2.0.4.v5 | 11.2.0.4.v6 | 11.2.0.4.v7
Oracle Database Standard Edition Two (oracle-se2)
Version 12.1 (available in all AWS regions except us-gov-west-1): 12.1.0.2.v2 | 12.1.0.2.v3
PostgreSQL
Version 9.5 (available in all AWS regions except us-gov-west-1): 9.5.2
Version 9.4 (available in all AWS regions): 9.4.1 | 9.4.4 | 9.4.5
Version 9.4 (available in all AWS regions except us-gov-west-1): 9.4.7
Version 9.3 (available in all AWS regions except eu-central-1, ap-northeast-2): 9.3.1 | 9.3.2
Version 9.3 (available in all AWS regions except ap-northeast-2): 9.3.10 | 9.3.3 | 9.3.5 | 9.3.6 | 9.3.9
Version 9.3 (available in all AWS regions except ap-northeast-2, us-gov-west-1): 9.3.12
License model information for this DB instance.
Valid values: license-included | bring-your-own-license | general-public-license
Indicates that the DB instance should be associated with the specified option group.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
", + "CreateDBInstanceMessage$CharacterSetName": "For supported engines, indicates that the DB instance should be associated with the specified CharacterSet.
", + "CreateDBInstanceMessage$DBClusterIdentifier": "The identifier of the DB cluster that the instance will belong to.
For information on creating a DB cluster, see CreateDBCluster.
Type: String
", + "CreateDBInstanceMessage$StorageType": "Specifies the storage type to be associated with the DB instance.
Valid values: standard | gp2 | io1
If you specify io1, you must also include a value for the Iops parameter.
Default: io1 if the Iops parameter is specified; otherwise standard
The ARN from the Key Store with which to associate the instance for TDE encryption.
", + "CreateDBInstanceMessage$TdeCredentialPassword": "The password for the given ARN from the Key Store in order to access the device.
", + "CreateDBInstanceMessage$KmsKeyId": "The KMS key identifier for an encrypted DB instance.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.
If the StorageEncrypted parameter is true, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.
Specify the Active Directory Domain to create the instance in.
", + "CreateDBInstanceMessage$MonitoringRoleArn": "The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring.
If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.
Specify the name of the IAM role to be used when making API calls to the Directory Service.
", + "CreateDBInstanceReadReplicaMessage$DBInstanceIdentifier": "The DB instance identifier of the Read Replica. This identifier is the unique key that identifies a DB instance. This parameter is stored as a lowercase string.
", + "CreateDBInstanceReadReplicaMessage$SourceDBInstanceIdentifier": "The identifier of the DB instance that will act as the source for the Read Replica. Each DB instance can have up to five Read Replicas.
Constraints:
Must be the identifier of an existing MySQL, MariaDB, or PostgreSQL DB instance.
Can specify a DB instance that is a MySQL Read Replica only if the source is running MySQL 5.6.
Can specify a DB instance that is a PostgreSQL Read Replica only if the source is running PostgreSQL 9.3.5.
The specified DB instance must have automatic backups enabled, its backup retention period must be greater than 0.
If the source DB instance is in the same region as the Read Replica, specify a valid DB instance identifier.
If the source DB instance is in a different region than the Read Replica, specify a valid DB instance ARN. For more information, go to Constructing a Amazon RDS Amazon Resource Name (ARN).
The compute and memory capacity of the Read Replica.
Valid Values: db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large
Default: Inherits from the source DB instance.
", + "CreateDBInstanceReadReplicaMessage$AvailabilityZone": "The Amazon EC2 Availability Zone that the Read Replica will be created in.
Default: A random, system-chosen Availability Zone in the endpoint's region.
Example: us-east-1d
The option group the DB instance will be associated with. If omitted, the default option group for the engine specified will be used.
", + "CreateDBInstanceReadReplicaMessage$DBSubnetGroupName": "Specifies a DB subnet group for the DB instance. The new DB instance will be created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance is not created in a VPC.
Constraints:
Can only be specified if the source DB instance identifier specifies a DB instance in another region.
The specified DB subnet group must be in the same region in which the operation is running.
All Read Replicas in one region that are created from the same source DB instance must either:>
Specify DB subnet groups from the same VPC. All these Read Replicas will be created in the same VPC.
Not specify a DB subnet group. All these Read Replicas will be created outside of any VPC.
Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.
Example: mySubnetgroup
Specifies the storage type to be associated with the Read Replica.
Valid values: standard | gp2 | io1
If you specify io1, you must also include a value for the Iops parameter.
Default: io1 if the Iops parameter is specified; otherwise standard
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring.
If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.
The name of the DB parameter group.
Constraints:
Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
This value is stored as a lowercase string.
The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family.
", + "CreateDBParameterGroupMessage$Description": "The description for the DB parameter group.
", + "CreateDBSecurityGroupMessage$DBSecurityGroupName": "The name for the DB security group. This value is stored as a lowercase string.
Constraints:
Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
Must not be \"Default\"
Cannot contain spaces
Example: mysecuritygroup
The description for the DB security group.
", + "CreateDBSnapshotMessage$DBSnapshotIdentifier": "The identifier for the DB snapshot.
Constraints:
Cannot be null, empty, or blank
Must contain from 1 to 255 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
Example: my-snapshot-id
The DB instance identifier. This is the unique key that identifies a DB instance.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
The name for the DB subnet group. This value is stored as a lowercase string.
Constraints: Must contain no more than 255 alphanumeric characters. Cannot contain periods, underscores, spaces, or hyphens. Must not be default.
Example: mySubnetgroup
The description for the DB subnet group.
", + "CreateEventSubscriptionMessage$SubscriptionName": "The name of the subscription.
Constraints: The name must be less than 255 characters.
", + "CreateEventSubscriptionMessage$SnsTopicArn": "The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.
", + "CreateEventSubscriptionMessage$SourceType": "The type of source that will be generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned.
Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot
Specifies the name of the option group to be created.
Constraints:
Must be 1 to 255 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
Example: myoptiongroup
Specifies the name of the engine that this option group should be associated with.
", + "CreateOptionGroupMessage$MajorEngineVersion": "Specifies the major version of the engine that this option group should be associated with.
", + "CreateOptionGroupMessage$OptionGroupDescription": "The description of the option group.
", + "DBCluster$CharacterSetName": "If present, specifies the name of the character set that this cluster is associated with.
", + "DBCluster$DatabaseName": "Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.
", + "DBCluster$DBClusterIdentifier": "Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
", + "DBCluster$DBClusterParameterGroup": "Specifies the name of the DB cluster parameter group for the DB cluster.
", + "DBCluster$DBSubnetGroup": "Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
", + "DBCluster$Status": "Specifies the current state of this DB cluster.
", + "DBCluster$PercentProgress": "Specifies the progress of the operation as a percentage.
", + "DBCluster$Endpoint": "Specifies the connection endpoint for the primary instance of the DB cluster.
", + "DBCluster$Engine": "Provides the name of the database engine to be used for this DB cluster.
", + "DBCluster$EngineVersion": "Indicates the database engine version.
", + "DBCluster$MasterUsername": "Contains the master username for the DB cluster.
", + "DBCluster$PreferredBackupWindow": "Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
", + "DBCluster$ReplicationSourceIdentifier": "Contains the identifier of the source DB cluster if this DB cluster is a Read Replica.
", + "DBCluster$HostedZoneId": "Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
", + "DBCluster$KmsKeyId": "If StorageEncrypted is true, the KMS key identifier for the encrypted DB cluster.
The region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB cluster is accessed.
", + "DBClusterMember$DBInstanceIdentifier": "Specifies the instance identifier for this member of the DB cluster.
", + "DBClusterMember$DBClusterParameterGroupStatus": "Specifies the status of the DB cluster parameter group for this member of the DB cluster.
", + "DBClusterMessage$Marker": "A pagination token that can be used in a subsequent DescribeDBClusters request.
", + "DBClusterOptionGroupStatus$DBClusterOptionGroupName": "Specifies the name of the DB cluster option group.
", + "DBClusterOptionGroupStatus$Status": "Specifies the status of the DB cluster option group.
", + "DBClusterParameterGroup$DBClusterParameterGroupName": "Provides the name of the DB cluster parameter group.
", + "DBClusterParameterGroup$DBParameterGroupFamily": "Provides the name of the DB parameter group family that this DB cluster parameter group is compatible with.
", + "DBClusterParameterGroup$Description": "Provides the customer-specified description for this DB cluster parameter group.
", + "DBClusterParameterGroupDetails$Marker": " An optional pagination token provided by a previous DescribeDBClusterParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
The name of the DB cluster parameter group.
Constraints:
Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
This value is stored as a lowercase string.
An optional pagination token provided by a previous DescribeDBClusterParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
Specifies the identifier for the DB cluster snapshot.
", + "DBClusterSnapshot$DBClusterIdentifier": "Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.
", + "DBClusterSnapshot$Engine": "Specifies the name of the database engine.
", + "DBClusterSnapshot$Status": "Specifies the status of this DB cluster snapshot.
", + "DBClusterSnapshot$VpcId": "Provides the VPC ID associated with the DB cluster snapshot.
", + "DBClusterSnapshot$MasterUsername": "Provides the master username for the DB cluster snapshot.
", + "DBClusterSnapshot$EngineVersion": "Provides the version of the database engine for this DB cluster snapshot.
", + "DBClusterSnapshot$LicenseModel": "Provides the license model information for this DB cluster snapshot.
", + "DBClusterSnapshot$SnapshotType": "Provides the type of the DB cluster snapshot.
", + "DBClusterSnapshot$KmsKeyId": "If StorageEncrypted is true, the KMS key identifier for the encrypted DB cluster snapshot.
The name of the manual DB cluster snapshot attribute.
The attribute named restore refers to the list of AWS accounts that have permission to copy or restore the manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.
The identifier of the manual DB cluster snapshot that the attributes apply to.
", + "DBClusterSnapshotMessage$Marker": " An optional pagination token provided by a previous DescribeDBClusterSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of the database engine.
", + "DBEngineVersion$EngineVersion": "The version number of the database engine.
", + "DBEngineVersion$DBParameterGroupFamily": "The name of the DB parameter group family for the database engine.
", + "DBEngineVersion$DBEngineDescription": "The description of the database engine.
", + "DBEngineVersion$DBEngineVersionDescription": "The description of the database engine version.
", + "DBEngineVersionMessage$Marker": " An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
", + "DBInstance$DBInstanceClass": "Contains the name of the compute and memory capacity class of the DB instance.
", + "DBInstance$Engine": "Provides the name of the database engine to be used for this DB instance.
", + "DBInstance$DBInstanceStatus": "Specifies the current state of this database.
", + "DBInstance$MasterUsername": "Contains the master username for the DB instance.
", + "DBInstance$DBName": "The meaning of this parameter differs according to the database engine you use. For example, this value returns MySQL, MariaDB, or PostgreSQL information when returning values from CreateDBInstanceReadReplica since Read Replicas are only supported for these engines.
MySQL, MariaDB, SQL Server, PostgreSQL, Amazon Aurora
Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.
Type: String
Oracle
Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.
", + "DBInstance$PreferredBackupWindow": " Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
Specifies the name of the Availability Zone the DB instance is located in.
", + "DBInstance$PreferredMaintenanceWindow": "Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
", + "DBInstance$EngineVersion": "Indicates the database engine version.
", + "DBInstance$ReadReplicaSourceDBInstanceIdentifier": "Contains the identifier of the source DB instance if this DB instance is a Read Replica.
", + "DBInstance$LicenseModel": "License model information for this DB instance.
", + "DBInstance$CharacterSetName": "If present, specifies the name of the character set that this instance is associated with.
", + "DBInstance$SecondaryAvailabilityZone": "If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
", + "DBInstance$StorageType": "Specifies the storage type associated with DB instance.
", + "DBInstance$TdeCredentialArn": "The ARN from the Key Store with which the instance is associated for TDE encryption.
", + "DBInstance$DBClusterIdentifier": "If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.
", + "DBInstance$KmsKeyId": " If StorageEncrypted is true, the KMS key identifier for the encrypted DB instance.
The region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB instance is accessed.
", + "DBInstance$CACertificateIdentifier": "The identifier of the CA certificate for this DB instance.
", + "DBInstance$EnhancedMonitoringResourceArn": "The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.
", + "DBInstance$MonitoringRoleArn": "The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to CloudWatch Logs.
", + "DBInstanceMessage$Marker": " An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
This value is currently \"read replication.\"
", + "DBInstanceStatusInfo$Status": "Status of the DB instance. For a StatusType of read replica, the values can be replicating, error, stopped, or terminated.
", + "DBInstanceStatusInfo$Message": "Details of the error if there is an error for the instance. If the instance is not in an error state, this value is blank.
", + "DBParameterGroup$DBParameterGroupName": "Provides the name of the DB parameter group.
", + "DBParameterGroup$DBParameterGroupFamily": "Provides the name of the DB parameter group family that this DB parameter group is compatible with.
", + "DBParameterGroup$Description": "Provides the customer-specified description for this DB parameter group.
", + "DBParameterGroupDetails$Marker": " An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
Provides the name of the DB parameter group.
", + "DBParameterGroupStatus$DBParameterGroupName": "The name of the DP parameter group.
", + "DBParameterGroupStatus$ParameterApplyStatus": "The status of parameter updates.
", + "DBParameterGroupsMessage$Marker": " An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
Provides the AWS ID of the owner of a specific DB security group.
", + "DBSecurityGroup$DBSecurityGroupName": "Specifies the name of the DB security group.
", + "DBSecurityGroup$DBSecurityGroupDescription": "Provides the description of the DB security group.
", + "DBSecurityGroup$VpcId": "Provides the VpcId of the DB security group.
", + "DBSecurityGroupMembership$DBSecurityGroupName": "The name of the DB security group.
", + "DBSecurityGroupMembership$Status": "The status of the DB security group.
", + "DBSecurityGroupMessage$Marker": " An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
Specifies the identifier for the DB snapshot.
", + "DBSnapshot$DBInstanceIdentifier": "Specifies the DB instance identifier of the DB instance this DB snapshot was created from.
", + "DBSnapshot$Engine": "Specifies the name of the database engine.
", + "DBSnapshot$Status": "Specifies the status of this DB snapshot.
", + "DBSnapshot$AvailabilityZone": "Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
", + "DBSnapshot$VpcId": "Provides the VPC ID associated with the DB snapshot.
", + "DBSnapshot$MasterUsername": "Provides the master username for the DB snapshot.
", + "DBSnapshot$EngineVersion": "Specifies the version of the database engine.
", + "DBSnapshot$LicenseModel": "License model information for the restored DB instance.
", + "DBSnapshot$SnapshotType": "Provides the type of the DB snapshot.
", + "DBSnapshot$OptionGroupName": "Provides the option group name for the DB snapshot.
", + "DBSnapshot$SourceRegion": "The region that the DB snapshot was created in or copied from.
", + "DBSnapshot$SourceDBSnapshotIdentifier": "The DB snapshot Arn that the DB snapshot was copied from. It only has value in case of cross customer or cross region copy.
", + "DBSnapshot$StorageType": "Specifies the storage type associated with DB Snapshot.
", + "DBSnapshot$TdeCredentialArn": "The ARN from the Key Store with which to associate the instance for TDE encryption.
", + "DBSnapshot$KmsKeyId": " If Encrypted is true, the KMS key identifier for the encrypted DB snapshot.
The name of the manual DB snapshot attribute.
The attribute named restore refers to the list of AWS accounts that have permission to copy or restore the manual DB cluster snapshot. For more information, see the ModifyDBSnapshotAttribute API action.
The identifier of the manual DB snapshot that the attributes apply to.
", + "DBSnapshotMessage$Marker": " An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of the DB subnet group.
", + "DBSubnetGroup$DBSubnetGroupDescription": "Provides the description of the DB subnet group.
", + "DBSubnetGroup$VpcId": "Provides the VpcId of the DB subnet group.
", + "DBSubnetGroup$SubnetGroupStatus": "Provides the status of the DB subnet group.
", + "DBSubnetGroupMessage$Marker": " An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The DB cluster identifier for the DB cluster to be deleted. This parameter isn't case-sensitive.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
The DB cluster snapshot identifier of the new DB cluster snapshot created when SkipFinalSnapshot is set to false.
Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error.
Constraints:
Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
The name of the DB cluster parameter group.
Constraints:
Must be the name of an existing DB cluster parameter group.
You cannot delete a default DB cluster parameter group.
Cannot be associated with any DB clusters.
The identifier of the DB cluster snapshot to delete.
Constraints: Must be the name of an existing DB cluster snapshot in the available state.
The DB instance identifier for the DB instance to be deleted. This parameter isn't case-sensitive.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
The DBSnapshotIdentifier of the new DBSnapshot created when SkipFinalSnapshot is set to false.
Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error.
Constraints:
Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
Cannot be specified when deleting a Read Replica.
The name of the DB parameter group.
Constraints:
Must be the name of an existing DB parameter group
You cannot delete a default DB parameter group
Cannot be associated with any DB instances
The name of the DB security group to delete.
You cannot delete the default DB security group.
Constraints:
Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
Must not be \"Default\"
Cannot contain spaces
The DBSnapshot identifier.
Constraints: Must be the name of an existing DB snapshot in the available state.
The name of the database subnet group to delete.
You cannot delete the default subnet group.
Constraints:
Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.
Example: mySubnetgroup
The name of the RDS event notification subscription you want to delete.
", + "DeleteOptionGroupMessage$OptionGroupName": "The name of the option group to be deleted.
You cannot delete default option groups.
The user-supplied certificate identifier. If this parameter is specified, information for only the identified certificate is returned. This parameter isn't case-sensitive.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
An optional pagination token provided by a previous DescribeCertificates request. 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 DB cluster parameter group to return details for.
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 pagination token provided by a previous DescribeDBClusterParameterGroups request. 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 DB cluster parameter group to return parameter details for.
Constraints:
Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
A value that indicates to return only parameters for a specific source. Parameter sources can be engine, service, or customer.
An optional pagination token provided by a previous DescribeDBClusterParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The identifier for the DB cluster snapshot to describe the attributes for.
", + "DescribeDBClusterSnapshotsMessage$DBClusterIdentifier": "The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter cannot be used in conjunction with the DBClusterSnapshotIdentifier parameter. This parameter is not case-sensitive.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
A specific DB cluster snapshot identifier to describe. This parameter cannot be used in conjunction with the DBClusterIdentifier parameter. This value is stored as a lowercase string.
Constraints:
Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.
The type of DB cluster snapshots to be returned. You can specify one of the following values:
automated - Return all DB cluster snapshots that have been automatically taken by Amazon RDS for my AWS account.
manual - Return all DB cluster snapshots that have been taken by my AWS account.
shared - Return all manual DB cluster snapshots that have been shared to my AWS account.
public - Return all DB cluster snapshots that have been marked as public.
If you don't specify a SnapshotType value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by setting the IncludeShared parameter to true. You can include public DB cluster snapshots with these results by setting the IncludePublic parameter to true.
The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to public.
An optional pagination token provided by a previous DescribeDBClusterSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
An optional pagination token provided by a previous DescribeDBClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The database engine to return.
", + "DescribeDBEngineVersionsMessage$EngineVersion": "The database engine version to return.
Example: 5.1.49
The name of a specific DB parameter group family to return details for.
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 pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The user-supplied instance identifier. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn't case-sensitive.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
An optional pagination token provided by a previous DescribeDBInstances request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of the log file for the specified DB instance.
", + "DescribeDBLogFilesMessage$DBInstanceIdentifier": "The customer-assigned name of the DB instance that contains the log files you want to list.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
Filters the available log files for log file names that contain the specified string.
", + "DescribeDBLogFilesMessage$Marker": "The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.
", + "DescribeDBLogFilesResponse$Marker": "A pagination token that can be used in a subsequent DescribeDBLogFiles request.
", + "DescribeDBParameterGroupsMessage$DBParameterGroupName": "The name of a specific DB parameter group to return details for.
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 pagination token provided by a previous DescribeDBParameterGroups request. 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 DB parameter group to return details for.
Constraints:
Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
The parameter types to return.
Default: All parameter types returned
Valid Values: user | system | engine-default
An optional pagination token provided by a previous DescribeDBParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of the DB security group to return details for.
", + "DescribeDBSecurityGroupsMessage$Marker": " An optional pagination token provided by a previous DescribeDBSecurityGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The identifier for the DB snapshot to describe the attributes for.
", + "DescribeDBSnapshotsMessage$DBInstanceIdentifier": "The ID of the DB instance to retrieve the list of DB snapshots for. This parameter cannot be used in conjunction with DBSnapshotIdentifier. This parameter is not case-sensitive.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
A specific DB snapshot identifier to describe. This parameter cannot be used in conjunction with DBInstanceIdentifier. This value is stored as a lowercase string.
Constraints:
Must be 1 to 255 alphanumeric characters.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.
The type of snapshots to be returned. You can specify one of the following values:
automated - Return all DB snapshots that have been automatically taken by Amazon RDS for my AWS account.
manual - Return all DB snapshots that have been taken by my AWS account.
shared - Return all manual DB snapshots that have been shared to my AWS account.
public - Return all DB snapshots that have been marked as public.
If you don't specify a SnapshotType value, then both automated and manual snapshots are returned. You can include shared snapshots with these results by setting the IncludeShared parameter to true. You can include public snapshots with these results by setting the IncludePublic parameter to true.
The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to public.
An optional pagination token provided by a previous DescribeDBSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of the DB subnet group to return details for.
", + "DescribeDBSubnetGroupsMessage$Marker": " An optional pagination token provided by a previous DescribeDBSubnetGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of the DB cluster parameter group family to return engine parameter information for.
", + "DescribeEngineDefaultClusterParametersMessage$Marker": " An optional pagination token provided by a previous DescribeEngineDefaultClusterParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of the DB parameter group family.
", + "DescribeEngineDefaultParametersMessage$Marker": " An optional pagination token provided by a previous DescribeEngineDefaultParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The type of source that will be generating the events.
Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot
", + "DescribeEventSubscriptionsMessage$SubscriptionName": "The name of the RDS event notification subscription you want to describe.
", + "DescribeEventSubscriptionsMessage$Marker": " An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. 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 will be returned. If not specified, then all sources are included in the response.
Constraints:
If SourceIdentifier is supplied, SourceType must also be provided.
If the source type is DBInstance, then a DBInstanceIdentifier must be supplied.
If the source type is DBSecurityGroup, a DBSecurityGroupName must be supplied.
If the source type is DBParameterGroup, a DBParameterGroupName must be supplied.
If the source type is DBSnapshot, a DBSnapshotIdentifier must be supplied.
Cannot end with a hyphen or contain two consecutive hyphens.
An optional pagination token provided by a previous DescribeEvents request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
A required parameter. Options available for the given engine name will be described.
", + "DescribeOptionGroupOptionsMessage$MajorEngineVersion": "If specified, filters the results to include only options for the specified major engine version.
", + "DescribeOptionGroupOptionsMessage$Marker": "An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of the option group to describe. Cannot be supplied together with EngineName or MajorEngineVersion.
", + "DescribeOptionGroupsMessage$Marker": " An optional pagination token provided by a previous DescribeOptionGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
Filters the list of option groups to only include groups associated with a specific database engine.
", + "DescribeOptionGroupsMessage$MajorEngineVersion": "Filters the list of option groups to only include groups associated with a specific database engine version. If specified, then EngineName must also be specified.
", + "DescribeOrderableDBInstanceOptionsMessage$Engine": "The name of the engine to retrieve DB instance options for.
", + "DescribeOrderableDBInstanceOptionsMessage$EngineVersion": "The engine version filter value. Specify this parameter to show only the available offerings matching the specified engine version.
", + "DescribeOrderableDBInstanceOptionsMessage$DBInstanceClass": "The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.
", + "DescribeOrderableDBInstanceOptionsMessage$LicenseModel": "The license model filter value. Specify this parameter to show only the available offerings matching the specified license model.
", + "DescribeOrderableDBInstanceOptionsMessage$Marker": " An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
The ARN of a resource to return pending maintenance actions for.
", + "DescribePendingMaintenanceActionsMessage$Marker": " An optional pagination token provided by a previous DescribePendingMaintenanceActions request. If this parameter is specified, the response includes only records beyond the marker, up to a number of records specified by MaxRecords.
The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID.
", + "DescribeReservedDBInstancesMessage$ReservedDBInstancesOfferingId": "The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.
", + "DescribeReservedDBInstancesMessage$DBInstanceClass": "The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class.
", + "DescribeReservedDBInstancesMessage$Duration": "The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.
Valid Values: 1 | 3 | 31536000 | 94608000
The product description filter value. Specify this parameter to show only those reservations matching the specified product description.
", + "DescribeReservedDBInstancesMessage$OfferingType": "The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.
Valid Values: \"Partial Upfront\" | \"All Upfront\" | \"No Upfront\"
An optional pagination token provided by a previous request. 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. Specify this parameter to show only the available offering that matches the specified reservation identifier.
Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.
", + "DescribeReservedDBInstancesOfferingsMessage$Duration": "Duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.
Valid Values: 1 | 3 | 31536000 | 94608000
Product description filter value. Specify this parameter to show only the available offerings matching the specified product description.
", + "DescribeReservedDBInstancesOfferingsMessage$OfferingType": "The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.
Valid Values: \"Partial Upfront\" | \"All Upfront\" | \"No Upfront\"
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The identifier of the Active Directory Domain.
", + "DomainMembership$Status": "The status of the DB instance's Active Directory Domain membership, such as joined, pending-join, failed etc).
", + "DomainMembership$FQDN": "The fully qualified domain name of the Active Directory Domain.
", + "DomainMembership$IAMRoleName": "The name of the IAM role to be used when making API calls to the Directory Service.
", + "DownloadDBLogFilePortionDetails$LogFileData": "Entries from the specified log file.
", + "DownloadDBLogFilePortionDetails$Marker": "A pagination token that can be used in a subsequent DownloadDBLogFilePortion request.
", + "DownloadDBLogFilePortionMessage$DBInstanceIdentifier": "The customer-assigned name of the DB instance that contains the log files you want to list.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
The name of the log file to be downloaded.
", + "DownloadDBLogFilePortionMessage$Marker": "The pagination token provided in the previous request or \"0\". If the Marker parameter is specified the response includes only records beyond the marker until the end of the file or up to NumberOfLines.
", + "EC2SecurityGroup$Status": "Provides the status of the EC2 security group. Status can be \"authorizing\", \"authorized\", \"revoking\", and \"revoked\".
", + "EC2SecurityGroup$EC2SecurityGroupName": "Specifies the name of the EC2 security group.
", + "EC2SecurityGroup$EC2SecurityGroupId": "Specifies the id of the EC2 security group.
", + "EC2SecurityGroup$EC2SecurityGroupOwnerId": " Specifies the AWS ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field.
Specifies the DNS address of the DB instance.
", + "Endpoint$HostedZoneId": "Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
", + "EngineDefaults$DBParameterGroupFamily": "Specifies the name of the DB parameter group family that the engine default parameters apply to.
", + "EngineDefaults$Marker": " An optional pagination token provided by a previous EngineDefaults request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
Provides the identifier for the source of the event.
", + "Event$Message": "Provides the text of this event.
", + "EventCategoriesList$member": null, + "EventCategoriesMap$SourceType": "The source type that the returned categories belong to
", + "EventSubscription$CustomerAwsId": "The AWS customer account associated with the RDS event notification subscription.
", + "EventSubscription$CustSubscriptionId": "The RDS event notification subscription Id.
", + "EventSubscription$SnsTopicArn": "The topic ARN of the RDS event notification subscription.
", + "EventSubscription$Status": "The status of the RDS event notification subscription.
Constraints:
Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist
The status \"no-permission\" indicates that RDS no longer has permission to post to the SNS topic. The status \"topic-not-exist\" indicates that the topic was deleted after the subscription was created.
", + "EventSubscription$SubscriptionCreationTime": "The time the RDS event notification subscription was created.
", + "EventSubscription$SourceType": "The source type for the RDS event notification subscription.
", + "EventSubscriptionsMessage$Marker": " An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
An optional pagination token provided by a previous Events request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
A DB cluster identifier to force a failover for. This parameter is not case-sensitive.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
This parameter is not currently supported.
", + "FilterValueList$member": null, + "IPRange$Status": "Specifies the status of the IP range. Status can be \"authorizing\", \"authorized\", \"revoking\", and \"revoked\".
", + "IPRange$CIDRIP": "Specifies the IP range.
", + "KeyList$member": null, + "ListTagsForResourceMessage$ResourceName": "The Amazon RDS resource with tags to be listed. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).
", + "ModifyDBClusterMessage$DBClusterIdentifier": "The DB cluster identifier for the cluster being modified. This parameter is not case-sensitive.
Constraints:
Must be the identifier for an existing DB cluster.
Must contain from 1 to 63 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
Example: my-cluster2
The name of the DB cluster parameter group to use for the DB cluster.
", + "ModifyDBClusterMessage$MasterUserPassword": "The new password for the master database user. This password can contain any printable ASCII character except \"/\", \"\"\", or \"@\".
Constraints: Must contain from 8 to 41 characters.
", + "ModifyDBClusterMessage$OptionGroupName": "A value that indicates that the DB cluster should be associated with the specified option group. Changing this parameter does not result in an outage except in the following case, and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.
Permanent options cannot be removed from an option group. The option group cannot be removed from a DB cluster once it is associated with a DB cluster.
", + "ModifyDBClusterMessage$PreferredBackupWindow": "The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.
Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Constraints:
Must be in the format hh24:mi-hh24:mi.
Times should be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
", + "ModifyDBClusterParameterGroupMessage$DBClusterParameterGroupName": "The name of the DB cluster parameter group to modify.
", + "ModifyDBClusterSnapshotAttributeMessage$DBClusterSnapshotIdentifier": "The identifier for the DB cluster snapshot to modify the attributes for.
", + "ModifyDBClusterSnapshotAttributeMessage$AttributeName": "The name of the DB cluster snapshot attribute to modify.
To manage authorization for other AWS accounts to copy or restore a manual DB cluster snapshot, set this value to restore.
The DB instance identifier. This value is stored as a lowercase string.
Constraints:
Must be the identifier for an existing DB instance
Must contain from 1 to 63 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
The new compute and memory capacity of the DB instance. To determine the instance classes that are available for a particular DB engine, use the DescribeOrderableDBInstanceOptions action.
Passing a value for this setting causes an outage during the change and is applied during the next maintenance window, unless ApplyImmediately is specified as true for this request.
Default: Uses existing setting
Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge | db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large
The new password for the DB instance master user. Can be any printable ASCII character except \"/\", \"\"\", or \"@\".
Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.
Default: Uses existing setting
Constraints: Must be 8 to 41 alphanumeric characters (MySQL, MariaDB, and Amazon Aurora), 8 to 30 alphanumeric characters (Oracle), or 8 to 128 alphanumeric characters (SQL Server).
Amazon RDS API actions never return the password, so this action provides a way to regain access to a primary instance user if the password is lost. This includes restoring privileges that might have been accidentally revoked.
The name of the DB parameter group to apply to the DB instance. Changing this setting does not result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. The db instance will NOT be rebooted automatically and the parameter changes will NOT be applied during the next maintenance window.
Default: Uses existing setting
Constraints: The DB parameter group must be in the same DB parameter group family as this DB instance.
", + "ModifyDBInstanceMessage$PreferredBackupWindow": " The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod parameter. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.
Constraints:
Must be in the format hh24:mi-hh24:mi
Times should be in Universal Time Coordinated (UTC)
Must not conflict with the preferred maintenance window
Must be at least 30 minutes
The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter does not result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, then changing this parameter will cause a reboot of the DB instance. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied.
Default: Uses existing setting
Format: ddd:hh24:mi-ddd:hh24:mi
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Must be at least 30 minutes
", + "ModifyDBInstanceMessage$EngineVersion": " The version number of the database engine to upgrade to. Changing this parameter results in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.
For major version upgrades, if a non-default DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family.
For a list of valid engine versions, see CreateDBInstance.
", + "ModifyDBInstanceMessage$OptionGroupName": " Indicates that the DB instance should be associated with the specified option group. Changing this parameter does not result in an outage except in the following case and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
", + "ModifyDBInstanceMessage$NewDBInstanceIdentifier": " The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot will occur immediately if you set Apply Immediately to true, or will occur during the next maintenance window if Apply Immediately to false. This value is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
Specifies the storage type to be associated with the DB instance.
Valid values: standard | gp2 | io1
If you specify io1, you must also include a value for the Iops parameter.
Default: io1 if the Iops parameter is specified; otherwise standard
The ARN from the Key Store with which to associate the instance for TDE encryption.
", + "ModifyDBInstanceMessage$TdeCredentialPassword": "The password for the given ARN from the Key Store in order to access the device.
", + "ModifyDBInstanceMessage$CACertificateIdentifier": "Indicates the certificate that needs to be associated with the instance.
", + "ModifyDBInstanceMessage$Domain": "Specify the Active Directory Domain to move the instance to.
The specified Active Directory Domain must be created prior to this operation. Currently only a SQL Server instance can be created in a Active Directory Domain.
", + "ModifyDBInstanceMessage$MonitoringRoleArn": "The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring.
If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.
Specify the name of the IAM role to be used when making API calls to the Directory Service.
", + "ModifyDBParameterGroupMessage$DBParameterGroupName": "The name of the DB parameter group.
Constraints:
Must be the name of an existing DB parameter group
Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
The identifier for the DB snapshot to modify the attributes for.
", + "ModifyDBSnapshotAttributeMessage$AttributeName": "The name of the DB snapshot attribute to modify.
To manage authorization for other AWS accounts to copy or restore a manual DB snapshot, set this value to restore.
The name for the DB subnet group. This value is stored as a lowercase string.
Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.
Example: mySubnetgroup
The description for the DB subnet group.
", + "ModifyEventSubscriptionMessage$SubscriptionName": "The name of the RDS event notification subscription.
", + "ModifyEventSubscriptionMessage$SnsTopicArn": "The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.
", + "ModifyEventSubscriptionMessage$SourceType": "The type of source that will be generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned.
Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot
", + "ModifyOptionGroupMessage$OptionGroupName": "The name of the option group to be modified.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
", + "Option$OptionName": "The name of the option.
", + "Option$OptionDescription": "The description of the option.
", + "OptionConfiguration$OptionName": "The configuration of options to include in a group.
", + "OptionGroup$OptionGroupName": "Specifies the name of the option group.
", + "OptionGroup$OptionGroupDescription": "Provides a description of the option group.
", + "OptionGroup$EngineName": "Indicates the name of the engine that this option group can be applied to.
", + "OptionGroup$MajorEngineVersion": "Indicates the major engine version associated with this option group.
", + "OptionGroup$VpcId": "If AllowsVpcAndNonVpcInstanceMemberships is false, this field is blank. If AllowsVpcAndNonVpcInstanceMemberships is true and this field is blank, then this option group can be applied to both VPC and non-VPC instances. If this field contains a value, then this option group can only be applied to instances that are in the VPC indicated by this field.
The name of the option group that the instance belongs to.
", + "OptionGroupMembership$Status": "The status of the DB instance's option group membership. Valid values are: in-sync, pending-apply, pending-removal, pending-maintenance-apply, pending-maintenance-removal, applying, removing, and failed.
The name of the option.
", + "OptionGroupOption$Description": "The description of the option.
", + "OptionGroupOption$EngineName": "The name of the engine that this option can be applied to.
", + "OptionGroupOption$MajorEngineVersion": "Indicates the major engine version that the option is available for.
", + "OptionGroupOption$MinimumRequiredMinorEngineVersion": "The minimum required engine version for the option to be applied.
", + "OptionGroupOptionSetting$SettingName": "The name of the option group option.
", + "OptionGroupOptionSetting$SettingDescription": "The description of the option group option.
", + "OptionGroupOptionSetting$DefaultValue": "The default value for the option group option.
", + "OptionGroupOptionSetting$ApplyType": "The DB engine specific parameter type for the option group option.
", + "OptionGroupOptionSetting$AllowedValues": "Indicates the acceptable values for the option group option.
", + "OptionGroupOptionsMessage$Marker": "An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of the option that has settings that you can set.
", + "OptionSetting$Value": "The current value of the option setting.
", + "OptionSetting$DefaultValue": "The default value of the option setting.
", + "OptionSetting$Description": "The description of the option setting.
", + "OptionSetting$ApplyType": "The DB engine specific parameter type.
", + "OptionSetting$DataType": "The data type of the option setting.
", + "OptionSetting$AllowedValues": "The allowed values of the option setting.
", + "OptionsDependedOn$member": null, + "OrderableDBInstanceOption$Engine": "The engine type of the orderable DB instance.
", + "OrderableDBInstanceOption$EngineVersion": "The engine version of the orderable DB instance.
", + "OrderableDBInstanceOption$DBInstanceClass": "The DB instance class for the orderable DB instance.
", + "OrderableDBInstanceOption$LicenseModel": "The license model for the orderable DB instance.
", + "OrderableDBInstanceOption$StorageType": "Indicates the storage type for this orderable DB instance.
", + "OrderableDBInstanceOptionsMessage$Marker": " An optional pagination token provided by a previous OrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
Specifies the name of the parameter.
", + "Parameter$ParameterValue": "Specifies the value of the parameter.
", + "Parameter$Description": "Provides a description of the parameter.
", + "Parameter$Source": "Indicates the source of the parameter value.
", + "Parameter$ApplyType": "Specifies the engine specific parameters type.
", + "Parameter$DataType": "Specifies the valid data type for the parameter.
", + "Parameter$AllowedValues": "Specifies the valid range of values for the parameter.
", + "Parameter$MinimumEngineVersion": "The earliest engine version to which the parameter can apply.
", + "PendingMaintenanceAction$Action": "The type of pending maintenance action that is available for the resource.
", + "PendingMaintenanceAction$OptInStatus": "Indicates the type of opt-in request that has been received for the resource.
", + "PendingMaintenanceAction$Description": "A description providing more detail about the maintenance action.
", + "PendingMaintenanceActionsMessage$Marker": " An optional pagination token provided by a previous DescribePendingMaintenanceActions request. If this parameter is specified, the response includes only records beyond the marker, up to a number of records specified by MaxRecords.
Contains the new DBInstanceClass for the DB instance that will be applied or is in progress.
Contains the pending or in-progress change of the master credentials for the DB instance.
", + "PendingModifiedValues$EngineVersion": "Indicates the database engine version.
", + "PendingModifiedValues$DBInstanceIdentifier": " Contains the new DBInstanceIdentifier for the DB instance that will be applied or is in progress.
Specifies the storage type to be associated with the DB instance.
", + "PendingModifiedValues$CACertificateIdentifier": "Specifies the identifier of the CA certificate for the DB instance.
", + "PromoteReadReplicaDBClusterMessage$DBClusterIdentifier": "The identifier of the DB cluster Read Replica to promote. This parameter is not case-sensitive.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Example: my-cluster-replica1
The DB instance identifier. This value is stored as a lowercase string.
Constraints:
Must be the identifier for an existing Read Replica DB instance
Must contain from 1 to 63 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
Example: mydbinstance
The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.
Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Constraints:
Must be in the format hh24:mi-hh24:mi.
Times should be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
The ID of the Reserved DB instance offering to purchase.
Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
", + "PurchaseReservedDBInstancesOfferingMessage$ReservedDBInstanceId": "Customer-specified identifier to track this reservation.
Example: myreservationID
", + "ReadReplicaDBInstanceIdentifierList$member": null, + "ReadReplicaIdentifierList$member": null, + "RebootDBInstanceMessage$DBInstanceIdentifier": "The DB instance identifier. This parameter is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
The frequency of the recurring charge.
", + "RemoveSourceIdentifierFromSubscriptionMessage$SubscriptionName": "The name of the RDS event notification subscription you want to remove a source identifier from.
", + "RemoveSourceIdentifierFromSubscriptionMessage$SourceIdentifier": "The source identifier to be removed from the subscription, such as the DB instance identifier for a DB instance or the name of a security group.
", + "RemoveTagsFromResourceMessage$ResourceName": "The Amazon RDS resource the tags will be removed from. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).
", + "ReservedDBInstance$ReservedDBInstanceId": "The unique identifier for the reservation.
", + "ReservedDBInstance$ReservedDBInstancesOfferingId": "The offering identifier.
", + "ReservedDBInstance$DBInstanceClass": "The DB instance class for the reserved DB instance.
", + "ReservedDBInstance$CurrencyCode": "The currency code for the reserved DB instance.
", + "ReservedDBInstance$ProductDescription": "The description of the reserved DB instance.
", + "ReservedDBInstance$OfferingType": "The offering type of this reserved DB instance.
", + "ReservedDBInstance$State": "The state of the reserved DB instance.
", + "ReservedDBInstanceMessage$Marker": " An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The offering identifier.
", + "ReservedDBInstancesOffering$DBInstanceClass": "The DB instance class for the reserved DB instance.
", + "ReservedDBInstancesOffering$CurrencyCode": "The currency code for the reserved DB instance offering.
", + "ReservedDBInstancesOffering$ProductDescription": "The database engine used by the offering.
", + "ReservedDBInstancesOffering$OfferingType": "The offering type.
", + "ReservedDBInstancesOfferingMessage$Marker": " An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of the DB cluster parameter group to reset.
", + "ResetDBParameterGroupMessage$DBParameterGroupName": "The name of the DB parameter group.
Constraints:
Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
The ARN of the resource that has pending maintenance actions.
", + "RestoreDBClusterFromSnapshotMessage$DBClusterIdentifier": "The name of the DB cluster to create from the DB cluster snapshot. This parameter isn't case-sensitive.
Constraints:
Must contain from 1 to 255 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
Example: my-snapshot-id
The identifier for the DB cluster snapshot to restore from.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
The database engine to use for the new DB cluster.
Default: The same as source
Constraint: Must be compatible with the engine of the source
", + "RestoreDBClusterFromSnapshotMessage$EngineVersion": "The version of the database engine to use for the new DB cluster.
", + "RestoreDBClusterFromSnapshotMessage$DBSubnetGroupName": "The name of the DB subnet group to use for the new DB cluster.
Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.
Example: mySubnetgroup
The database name for the restored DB cluster.
", + "RestoreDBClusterFromSnapshotMessage$OptionGroupName": "The name of the option group to use for the restored DB cluster.
", + "RestoreDBClusterFromSnapshotMessage$KmsKeyId": "The KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster snapshot.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.
If you do not specify a value for the KmsKeyId parameter, then the following will occur:
If the DB cluster snapshot is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the DB cluster snapshot.
If the DB cluster snapshot is not encrypted, then the restored DB cluster is not encrypted.
If SnapshotIdentifier refers to a DB cluster snapshot that is not encrypted, and you specify a value for the KmsKeyId parameter, then the restore request is rejected.
The name of the new DB cluster to be created.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
The identifier of the source DB cluster from which to restore.
Constraints:
Must be the identifier of an existing database instance
Must contain from 1 to 63 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
The DB subnet group name to use for the new DB cluster.
Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.
Example: mySubnetgroup
The name of the option group for the new DB cluster.
", + "RestoreDBClusterToPointInTimeMessage$KmsKeyId": "The KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.
You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different than the KMS key used to encrypt the source DB cluster. The new DB cluster will be encrypted with the KMS key identified by the KmsKeyId parameter.
If you do not specify a value for the KmsKeyId parameter, then the following will occur:
If the DB cluster is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the source DB cluster.
If the DB cluster is not encrypted, then the restored DB cluster is not encrypted.
If DBClusterIdentifier refers to a DB cluster that is note encrypted, then the restore request is rejected.
Name of the DB instance to create from the DB snapshot. This parameter isn't case-sensitive.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens (1 to 15 for SQL Server)
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
Example: my-snapshot-id
The identifier for the DB snapshot to restore from.
Constraints:
Must contain from 1 to 255 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of the shared DB snapshot.
The compute and memory capacity of the Amazon RDS DB instance.
Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large
The EC2 Availability Zone that the database instance will be created in.
Default: A random, system-chosen Availability Zone.
Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.
Example: us-east-1a
The DB subnet group name to use for the new instance.
Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.
Example: mySubnetgroup
License model information for the restored DB instance.
Default: Same as source.
Valid values: license-included | bring-your-own-license | general-public-license
The database name for the restored DB instance.
This parameter doesn't apply to the MySQL or MariaDB engines.
The database engine to use for the new instance.
Default: The same as source
Constraint: Must be compatible with the engine of the source
Valid Values: MySQL | mariadb | oracle-se1 | oracle-se | oracle-ee | sqlserver-ee | sqlserver-se | sqlserver-ex | sqlserver-web | postgres | aurora
The name of the option group to be used for the restored DB instance.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
", + "RestoreDBInstanceFromDBSnapshotMessage$StorageType": "Specifies the storage type to be associated with the DB instance.
Valid values: standard | gp2 | io1
If you specify io1, you must also include a value for the Iops parameter.
Default: io1 if the Iops parameter is specified; otherwise standard
The ARN from the Key Store with which to associate the instance for TDE encryption.
", + "RestoreDBInstanceFromDBSnapshotMessage$TdeCredentialPassword": "The password for the given ARN from the Key Store in order to access the device.
", + "RestoreDBInstanceFromDBSnapshotMessage$Domain": "Specify the Active Directory Domain to restore the instance in.
", + "RestoreDBInstanceFromDBSnapshotMessage$DomainIAMRoleName": "Specify the name of the IAM role to be used when making API calls to the Directory Service.
", + "RestoreDBInstanceToPointInTimeMessage$SourceDBInstanceIdentifier": "The identifier of the source DB instance from which to restore.
Constraints:
Must be the identifier of an existing database instance
Must contain from 1 to 63 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
The name of the new database instance to be created.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
The compute and memory capacity of the Amazon RDS DB instance.
Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large
Default: The same DBInstanceClass as the original DB instance.
", + "RestoreDBInstanceToPointInTimeMessage$AvailabilityZone": "The EC2 Availability Zone that the database instance will be created in.
Default: A random, system-chosen Availability Zone.
Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.
Example: us-east-1a
The DB subnet group name to use for the new instance.
Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.
Example: mySubnetgroup
License model information for the restored DB instance.
Default: Same as source.
Valid values: license-included | bring-your-own-license | general-public-license
The database name for the restored DB instance.
This parameter is not used for the MySQL or MariaDB engines.
The database engine to use for the new instance.
Default: The same as source
Constraint: Must be compatible with the engine of the source
Valid Values: MySQL | mariadb | oracle-se1 | oracle-se | oracle-ee | sqlserver-ee | sqlserver-se | sqlserver-ex | sqlserver-web | postgres | aurora
The name of the option group to be used for the restored DB instance.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
", + "RestoreDBInstanceToPointInTimeMessage$StorageType": "Specifies the storage type to be associated with the DB instance.
Valid values: standard | gp2 | io1
If you specify io1, you must also include a value for the Iops parameter.
Default: io1 if the Iops parameter is specified; otherwise standard
The ARN from the Key Store with which to associate the instance for TDE encryption.
", + "RestoreDBInstanceToPointInTimeMessage$TdeCredentialPassword": "The password for the given ARN from the Key Store in order to access the device.
", + "RestoreDBInstanceToPointInTimeMessage$Domain": "Specify the Active Directory Domain to restore the instance in.
", + "RestoreDBInstanceToPointInTimeMessage$DomainIAMRoleName": "Specify the name of the IAM role to be used when making API calls to the Directory Service.
", + "RevokeDBSecurityGroupIngressMessage$DBSecurityGroupName": "The name of the DB security group to revoke ingress from.
", + "RevokeDBSecurityGroupIngressMessage$CIDRIP": " The IP range to revoke access from. Must be a valid CIDR range. If CIDRIP is specified, EC2SecurityGroupName, EC2SecurityGroupId and EC2SecurityGroupOwnerId cannot be provided.
The name of the EC2 security group to revoke access from. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
The id of the EC2 security group to revoke access from. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
The AWS Account Number of the owner of the EC2 security group specified in the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
Specifies the identifier of the subnet.
", + "Subnet$SubnetStatus": "Specifies the status of the subnet.
", + "SubnetIdentifierList$member": null, + "Tag$Key": "A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and cannot be prefixed with \"aws:\" or \"rds:\". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").
", + "Tag$Value": "A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and cannot be prefixed with \"aws:\" or \"rds:\". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").
", + "UpgradeTarget$Engine": "The name of the upgrade target database engine.
", + "UpgradeTarget$EngineVersion": "The version number of the upgrade target database engine.
", + "UpgradeTarget$Description": "The version of the database engine that a DB instance can be upgraded to.
", + "VpcSecurityGroupIdList$member": null, + "VpcSecurityGroupMembership$VpcSecurityGroupId": "The name of the VPC security group.
", + "VpcSecurityGroupMembership$Status": "The status of the VPC security group.
" + } + }, + "Subnet": { + "base": "This data type is used as a response element in the DescribeDBSubnetGroups action.
", + "refs": { + "SubnetList$member": null + } + }, + "SubnetAlreadyInUse": { + "base": "The DB subnet is already in use in the Availability Zone.
", + "refs": { + } + }, + "SubnetIdentifierList": { + "base": null, + "refs": { + "CreateDBSubnetGroupMessage$SubnetIds": "The EC2 Subnet IDs for the DB subnet group.
", + "ModifyDBSubnetGroupMessage$SubnetIds": "The EC2 subnet IDs for the DB subnet group.
" + } + }, + "SubnetList": { + "base": null, + "refs": { + "DBSubnetGroup$Subnets": "Contains a list of Subnet elements.
" + } + }, + "SubscriptionAlreadyExistFault": { + "base": "The supplied subscription name already exists.
", + "refs": { + } + }, + "SubscriptionCategoryNotFoundFault": { + "base": "The supplied category does not exist.
", + "refs": { + } + }, + "SubscriptionNotFoundFault": { + "base": "The subscription name does not exist.
", + "refs": { + } + }, + "SupportedCharacterSetsList": { + "base": null, + "refs": { + "DBEngineVersion$SupportedCharacterSets": " A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance API.
The starting date from which the certificate is valid.
", + "Certificate$ValidTill": "The final date that the certificate continues to be valid.
", + "DBCluster$EarliestRestorableTime": "Specifies the earliest time to which a database can be restored with point-in-time restore.
", + "DBCluster$LatestRestorableTime": "Specifies the latest time to which a database can be restored with point-in-time restore.
", + "DBClusterSnapshot$SnapshotCreateTime": "Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).
", + "DBClusterSnapshot$ClusterCreateTime": "Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
", + "DBInstance$InstanceCreateTime": "Provides the date and time the DB instance was created.
", + "DBInstance$LatestRestorableTime": "Specifies the latest time to which a database can be restored with point-in-time restore.
", + "DBSnapshot$SnapshotCreateTime": "Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).
", + "DBSnapshot$InstanceCreateTime": "Specifies the time when the snapshot was taken, in Universal Coordinated Time (UTC).
", + "DescribeEventsMessage$StartTime": "The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2009-07-08T18:00Z
", + "DescribeEventsMessage$EndTime": "The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2009-07-08T18:00Z
", + "Event$Date": "Specifies the date and time of the event.
", + "PendingMaintenanceAction$AutoAppliedAfterDate": "The date of the maintenance window when the action will be applied. The maintenance action will be applied to the resource during its first maintenance window after this date. If this date is specified, any next-maintenance opt-in requests are ignored.
The date when the maintenance action will be automatically applied. The maintenance action will be applied to the resource on this date regardless of the maintenance window for the resource. If this date is specified, any immediate opt-in requests are ignored.
The effective date when the pending maintenance action will be applied to the resource. This date takes into account opt-in requests received from the ApplyPendingMaintenanceAction API, the AutoAppliedAfterDate, and the ForcedApplyDate. This value is blank if an opt-in request has not been received and nothing has been specified as AutoAppliedAfterDate or ForcedApplyDate.
The time the reservation started.
", + "RestoreDBClusterToPointInTimeMessage$RestoreToTime": "The date and time to restore the DB cluster to.
Valid Values: Value must be a time in Universal Coordinated Time (UTC) format
Constraints:
Must be before the latest restorable time for the DB instance
Cannot be specified if UseLatestRestorableTime parameter is true
Example: 2015-03-07T23:45:00Z
The date and time to restore from.
Valid Values: Value must be a time in Universal Coordinated Time (UTC) format
Constraints:
Must be before the latest restorable time for the DB instance
Cannot be specified if UseLatestRestorableTime parameter is true
Example: 2009-09-07T23:45:00Z
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
", + "refs": { + "TagList$member": null + } + }, + "TagList": { + "base": "A list of tags.
", + "refs": { + "AddTagsToResourceMessage$Tags": "The tags to be assigned to the Amazon RDS resource.
", + "CopyDBClusterSnapshotMessage$Tags": null, + "CopyDBParameterGroupMessage$Tags": null, + "CopyDBSnapshotMessage$Tags": null, + "CopyOptionGroupMessage$Tags": null, + "CreateDBClusterMessage$Tags": null, + "CreateDBClusterParameterGroupMessage$Tags": null, + "CreateDBClusterSnapshotMessage$Tags": "The tags to be assigned to the DB cluster snapshot.
", + "CreateDBInstanceMessage$Tags": null, + "CreateDBInstanceReadReplicaMessage$Tags": null, + "CreateDBParameterGroupMessage$Tags": null, + "CreateDBSecurityGroupMessage$Tags": null, + "CreateDBSnapshotMessage$Tags": null, + "CreateDBSubnetGroupMessage$Tags": null, + "CreateEventSubscriptionMessage$Tags": null, + "CreateOptionGroupMessage$Tags": null, + "PurchaseReservedDBInstancesOfferingMessage$Tags": null, + "RestoreDBClusterFromSnapshotMessage$Tags": "The tags to be assigned to the restored DB cluster.
", + "RestoreDBClusterToPointInTimeMessage$Tags": null, + "RestoreDBInstanceFromDBSnapshotMessage$Tags": null, + "RestoreDBInstanceToPointInTimeMessage$Tags": null, + "TagListMessage$TagList": "List of tags returned by the ListTagsForResource operation.
" + } + }, + "TagListMessage": { + "base": "", + "refs": { + } + }, + "UpgradeTarget": { + "base": "The version of the database engine that a DB instance can be upgraded to.
", + "refs": { + "ValidUpgradeTargetList$member": null + } + }, + "ValidUpgradeTargetList": { + "base": null, + "refs": { + "DBEngineVersion$ValidUpgradeTarget": "A list of engine versions that this database engine version can be upgraded to.
" + } + }, + "VpcSecurityGroupIdList": { + "base": null, + "refs": { + "CreateDBClusterMessage$VpcSecurityGroupIds": "A list of EC2 VPC security groups to associate with this DB cluster.
", + "CreateDBInstanceMessage$VpcSecurityGroupIds": "A list of EC2 VPC security groups to associate with this DB instance.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
", + "ModifyDBClusterMessage$VpcSecurityGroupIds": "A lst of VPC security groups that the DB cluster will belong to.
", + "ModifyDBInstanceMessage$VpcSecurityGroupIds": "A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible.
Constraints:
Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
A list of VpcSecurityGroupMemebrship name strings used for this option.
", + "RestoreDBClusterFromSnapshotMessage$VpcSecurityGroupIds": "A list of VPC security groups that the new DB cluster will belong to.
", + "RestoreDBClusterToPointInTimeMessage$VpcSecurityGroupIds": "A lst of VPC security groups that the new DB cluster belongs to.
" + } + }, + "VpcSecurityGroupMembership": { + "base": "This data type is used as a response element for queries on VPC security group membership.
", + "refs": { + "VpcSecurityGroupMembershipList$member": null + } + }, + "VpcSecurityGroupMembershipList": { + "base": null, + "refs": { + "DBCluster$VpcSecurityGroups": "Provides a list of VPC security groups that the DB cluster belongs to.
", + "DBInstance$VpcSecurityGroups": "Provides List of VPC security group elements that the DB instance belongs to.
", + "Option$VpcSecurityGroupMemberships": "If the option requires access to a port, then this VPC security group allows access to the port.
" + } + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/rds/2014-10-31/examples-1.json b/vendor/github.com/aws/aws-sdk-go/models/apis/rds/2014-10-31/examples-1.json new file mode 100644 index 000000000..0ea7e3b0b --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/rds/2014-10-31/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/rds/2014-10-31/paginators-1.json b/vendor/github.com/aws/aws-sdk-go/models/apis/rds/2014-10-31/paginators-1.json new file mode 100644 index 000000000..662845c12 --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/rds/2014-10-31/paginators-1.json @@ -0,0 +1,110 @@ +{ + "pagination": { + "DescribeDBEngineVersions": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "DBEngineVersions" + }, + "DescribeDBInstances": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "DBInstances" + }, + "DescribeDBLogFiles": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "DescribeDBLogFiles" + }, + "DescribeDBParameterGroups": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "DBParameterGroups" + }, + "DescribeDBParameters": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "Parameters" + }, + "DescribeDBSecurityGroups": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "DBSecurityGroups" + }, + "DescribeDBSnapshots": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "DBSnapshots" + }, + "DescribeDBSubnetGroups": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "DBSubnetGroups" + }, + "DescribeEngineDefaultParameters": { + "input_token": "Marker", + "output_token": "EngineDefaults.Marker", + "limit_key": "MaxRecords", + "result_key": "EngineDefaults.Parameters" + }, + "DescribeEventSubscriptions": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "EventSubscriptionsList" + }, + "DescribeEvents": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "Events" + }, + "DescribeOptionGroupOptions": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "OptionGroupOptions" + }, + "DescribeOptionGroups": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "OptionGroupsList" + }, + "DescribeOrderableDBInstanceOptions": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "OrderableDBInstanceOptions" + }, + "DescribeReservedDBInstances": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "ReservedDBInstances" + }, + "DescribeReservedDBInstancesOfferings": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "ReservedDBInstancesOfferings" + }, + "DownloadDBLogFilePortion": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "NumberOfLines", + "more_results": "AdditionalDataPending", + "result_key": "LogFileData" + }, + "ListTagsForResource": { + "result_key": "TagList" + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/rds/2014-10-31/waiters-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/rds/2014-10-31/waiters-2.json new file mode 100644 index 000000000..4f403ac05 --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/rds/2014-10-31/waiters-2.json @@ -0,0 +1,102 @@ +{ + "version": 2, + "waiters": { + "DBInstanceAvailable": { + "delay": 30, + "operation": "DescribeDBInstances", + "maxAttempts": 60, + "acceptors": [ + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "deleted", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "deleting", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "failed", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "incompatible-restore", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "incompatible-parameters", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "incompatible-parameters", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "incompatible-restore", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + } + ] + }, + "DBInstanceDeleted": { + "delay": 30, + "operation": "DescribeDBInstances", + "maxAttempts": 60, + "acceptors": [ + { + "expected": "deleted", + "matcher": "pathAll", + "state": "success", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "DBInstanceNotFound", + "matcher": "error", + "state": "success" + }, + { + "expected": "creating", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "modifying", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "rebooting", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "resetting-master-credentials", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + } + ] + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/redshift/2012-12-01/api-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/redshift/2012-12-01/api-2.json new file mode 100644 index 000000000..c8771991d --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/redshift/2012-12-01/api-2.json @@ -0,0 +1,3768 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2012-12-01", + "endpointPrefix":"redshift", + "protocol":"query", + "serviceFullName":"Amazon Redshift", + "signatureVersion":"v4", + "xmlNamespace":"http://redshift.amazonaws.com/doc/2012-12-01/" + }, + "operations":{ + "AuthorizeClusterSecurityGroupIngress":{ + "name":"AuthorizeClusterSecurityGroupIngress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AuthorizeClusterSecurityGroupIngressMessage"}, + "output":{ + "shape":"AuthorizeClusterSecurityGroupIngressResult", + "resultWrapper":"AuthorizeClusterSecurityGroupIngressResult" + }, + "errors":[ + {"shape":"ClusterSecurityGroupNotFoundFault"}, + {"shape":"InvalidClusterSecurityGroupStateFault"}, + {"shape":"AuthorizationAlreadyExistsFault"}, + {"shape":"AuthorizationQuotaExceededFault"} + ] + }, + "AuthorizeSnapshotAccess":{ + "name":"AuthorizeSnapshotAccess", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AuthorizeSnapshotAccessMessage"}, + "output":{ + "shape":"AuthorizeSnapshotAccessResult", + "resultWrapper":"AuthorizeSnapshotAccessResult" + }, + "errors":[ + {"shape":"ClusterSnapshotNotFoundFault"}, + {"shape":"AuthorizationAlreadyExistsFault"}, + {"shape":"AuthorizationQuotaExceededFault"}, + {"shape":"DependentServiceRequestThrottlingFault"}, + {"shape":"InvalidClusterSnapshotStateFault"}, + {"shape":"LimitExceededFault"} + ] + }, + "CopyClusterSnapshot":{ + "name":"CopyClusterSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CopyClusterSnapshotMessage"}, + "output":{ + "shape":"CopyClusterSnapshotResult", + "resultWrapper":"CopyClusterSnapshotResult" + }, + "errors":[ + {"shape":"ClusterSnapshotAlreadyExistsFault"}, + {"shape":"ClusterSnapshotNotFoundFault"}, + {"shape":"InvalidClusterSnapshotStateFault"}, + {"shape":"ClusterSnapshotQuotaExceededFault"} + ] + }, + "CreateCluster":{ + "name":"CreateCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateClusterMessage"}, + "output":{ + "shape":"CreateClusterResult", + "resultWrapper":"CreateClusterResult" + }, + "errors":[ + {"shape":"ClusterAlreadyExistsFault"}, + {"shape":"InsufficientClusterCapacityFault"}, + {"shape":"ClusterParameterGroupNotFoundFault"}, + {"shape":"ClusterSecurityGroupNotFoundFault"}, + {"shape":"ClusterQuotaExceededFault"}, + {"shape":"NumberOfNodesQuotaExceededFault"}, + {"shape":"NumberOfNodesPerClusterLimitExceededFault"}, + {"shape":"ClusterSubnetGroupNotFoundFault"}, + {"shape":"InvalidVPCNetworkStateFault"}, + {"shape":"InvalidClusterSubnetGroupStateFault"}, + {"shape":"InvalidSubnet"}, + {"shape":"UnauthorizedOperation"}, + {"shape":"HsmClientCertificateNotFoundFault"}, + {"shape":"HsmConfigurationNotFoundFault"}, + {"shape":"InvalidElasticIpFault"}, + {"shape":"TagLimitExceededFault"}, + {"shape":"InvalidTagFault"}, + {"shape":"LimitExceededFault"}, + {"shape":"DependentServiceRequestThrottlingFault"} + ] + }, + "CreateClusterParameterGroup":{ + "name":"CreateClusterParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateClusterParameterGroupMessage"}, + "output":{ + "shape":"CreateClusterParameterGroupResult", + "resultWrapper":"CreateClusterParameterGroupResult" + }, + "errors":[ + {"shape":"ClusterParameterGroupQuotaExceededFault"}, + {"shape":"ClusterParameterGroupAlreadyExistsFault"}, + {"shape":"TagLimitExceededFault"}, + {"shape":"InvalidTagFault"} + ] + }, + "CreateClusterSecurityGroup":{ + "name":"CreateClusterSecurityGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateClusterSecurityGroupMessage"}, + "output":{ + "shape":"CreateClusterSecurityGroupResult", + "resultWrapper":"CreateClusterSecurityGroupResult" + }, + "errors":[ + {"shape":"ClusterSecurityGroupAlreadyExistsFault"}, + {"shape":"ClusterSecurityGroupQuotaExceededFault"}, + {"shape":"TagLimitExceededFault"}, + {"shape":"InvalidTagFault"} + ] + }, + "CreateClusterSnapshot":{ + "name":"CreateClusterSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateClusterSnapshotMessage"}, + "output":{ + "shape":"CreateClusterSnapshotResult", + "resultWrapper":"CreateClusterSnapshotResult" + }, + "errors":[ + {"shape":"ClusterSnapshotAlreadyExistsFault"}, + {"shape":"InvalidClusterStateFault"}, + {"shape":"ClusterNotFoundFault"}, + {"shape":"ClusterSnapshotQuotaExceededFault"}, + {"shape":"TagLimitExceededFault"}, + {"shape":"InvalidTagFault"} + ] + }, + "CreateClusterSubnetGroup":{ + "name":"CreateClusterSubnetGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateClusterSubnetGroupMessage"}, + "output":{ + "shape":"CreateClusterSubnetGroupResult", + "resultWrapper":"CreateClusterSubnetGroupResult" + }, + "errors":[ + {"shape":"ClusterSubnetGroupAlreadyExistsFault"}, + {"shape":"ClusterSubnetGroupQuotaExceededFault"}, + {"shape":"ClusterSubnetQuotaExceededFault"}, + {"shape":"InvalidSubnet"}, + {"shape":"UnauthorizedOperation"}, + {"shape":"TagLimitExceededFault"}, + {"shape":"InvalidTagFault"}, + {"shape":"DependentServiceRequestThrottlingFault"} + ] + }, + "CreateEventSubscription":{ + "name":"CreateEventSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateEventSubscriptionMessage"}, + "output":{ + "shape":"CreateEventSubscriptionResult", + "resultWrapper":"CreateEventSubscriptionResult" + }, + "errors":[ + {"shape":"EventSubscriptionQuotaExceededFault"}, + {"shape":"SubscriptionAlreadyExistFault"}, + {"shape":"SNSInvalidTopicFault"}, + {"shape":"SNSNoAuthorizationFault"}, + {"shape":"SNSTopicArnNotFoundFault"}, + {"shape":"SubscriptionEventIdNotFoundFault"}, + {"shape":"SubscriptionCategoryNotFoundFault"}, + {"shape":"SubscriptionSeverityNotFoundFault"}, + {"shape":"SourceNotFoundFault"}, + {"shape":"TagLimitExceededFault"}, + {"shape":"InvalidTagFault"} + ] + }, + "CreateHsmClientCertificate":{ + "name":"CreateHsmClientCertificate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateHsmClientCertificateMessage"}, + "output":{ + "shape":"CreateHsmClientCertificateResult", + "resultWrapper":"CreateHsmClientCertificateResult" + }, + "errors":[ + {"shape":"HsmClientCertificateAlreadyExistsFault"}, + {"shape":"HsmClientCertificateQuotaExceededFault"}, + {"shape":"TagLimitExceededFault"}, + {"shape":"InvalidTagFault"} + ] + }, + "CreateHsmConfiguration":{ + "name":"CreateHsmConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateHsmConfigurationMessage"}, + "output":{ + "shape":"CreateHsmConfigurationResult", + "resultWrapper":"CreateHsmConfigurationResult" + }, + "errors":[ + {"shape":"HsmConfigurationAlreadyExistsFault"}, + {"shape":"HsmConfigurationQuotaExceededFault"}, + {"shape":"TagLimitExceededFault"}, + {"shape":"InvalidTagFault"} + ] + }, + "CreateSnapshotCopyGrant":{ + "name":"CreateSnapshotCopyGrant", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateSnapshotCopyGrantMessage"}, + "output":{ + "shape":"CreateSnapshotCopyGrantResult", + "resultWrapper":"CreateSnapshotCopyGrantResult" + }, + "errors":[ + {"shape":"SnapshotCopyGrantAlreadyExistsFault"}, + {"shape":"SnapshotCopyGrantQuotaExceededFault"}, + {"shape":"LimitExceededFault"}, + {"shape":"TagLimitExceededFault"}, + {"shape":"InvalidTagFault"}, + {"shape":"DependentServiceRequestThrottlingFault"} + ] + }, + "CreateTags":{ + "name":"CreateTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateTagsMessage"}, + "errors":[ + {"shape":"TagLimitExceededFault"}, + {"shape":"ResourceNotFoundFault"}, + {"shape":"InvalidTagFault"} + ] + }, + "DeleteCluster":{ + "name":"DeleteCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteClusterMessage"}, + "output":{ + "shape":"DeleteClusterResult", + "resultWrapper":"DeleteClusterResult" + }, + "errors":[ + {"shape":"ClusterNotFoundFault"}, + {"shape":"InvalidClusterStateFault"}, + {"shape":"ClusterSnapshotAlreadyExistsFault"}, + {"shape":"ClusterSnapshotQuotaExceededFault"} + ] + }, + "DeleteClusterParameterGroup":{ + "name":"DeleteClusterParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteClusterParameterGroupMessage"}, + "errors":[ + {"shape":"InvalidClusterParameterGroupStateFault"}, + {"shape":"ClusterParameterGroupNotFoundFault"} + ] + }, + "DeleteClusterSecurityGroup":{ + "name":"DeleteClusterSecurityGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteClusterSecurityGroupMessage"}, + "errors":[ + {"shape":"InvalidClusterSecurityGroupStateFault"}, + {"shape":"ClusterSecurityGroupNotFoundFault"} + ] + }, + "DeleteClusterSnapshot":{ + "name":"DeleteClusterSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteClusterSnapshotMessage"}, + "output":{ + "shape":"DeleteClusterSnapshotResult", + "resultWrapper":"DeleteClusterSnapshotResult" + }, + "errors":[ + {"shape":"InvalidClusterSnapshotStateFault"}, + {"shape":"ClusterSnapshotNotFoundFault"} + ] + }, + "DeleteClusterSubnetGroup":{ + "name":"DeleteClusterSubnetGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteClusterSubnetGroupMessage"}, + "errors":[ + {"shape":"InvalidClusterSubnetGroupStateFault"}, + {"shape":"InvalidClusterSubnetStateFault"}, + {"shape":"ClusterSubnetGroupNotFoundFault"} + ] + }, + "DeleteEventSubscription":{ + "name":"DeleteEventSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteEventSubscriptionMessage"}, + "errors":[ + {"shape":"SubscriptionNotFoundFault"}, + {"shape":"InvalidSubscriptionStateFault"} + ] + }, + "DeleteHsmClientCertificate":{ + "name":"DeleteHsmClientCertificate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteHsmClientCertificateMessage"}, + "errors":[ + {"shape":"InvalidHsmClientCertificateStateFault"}, + {"shape":"HsmClientCertificateNotFoundFault"} + ] + }, + "DeleteHsmConfiguration":{ + "name":"DeleteHsmConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteHsmConfigurationMessage"}, + "errors":[ + {"shape":"InvalidHsmConfigurationStateFault"}, + {"shape":"HsmConfigurationNotFoundFault"} + ] + }, + "DeleteSnapshotCopyGrant":{ + "name":"DeleteSnapshotCopyGrant", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSnapshotCopyGrantMessage"}, + "errors":[ + {"shape":"InvalidSnapshotCopyGrantStateFault"}, + {"shape":"SnapshotCopyGrantNotFoundFault"} + ] + }, + "DeleteTags":{ + "name":"DeleteTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteTagsMessage"}, + "errors":[ + {"shape":"ResourceNotFoundFault"}, + {"shape":"InvalidTagFault"} + ] + }, + "DescribeClusterParameterGroups":{ + "name":"DescribeClusterParameterGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeClusterParameterGroupsMessage"}, + "output":{ + "shape":"ClusterParameterGroupsMessage", + "resultWrapper":"DescribeClusterParameterGroupsResult" + }, + "errors":[ + {"shape":"ClusterParameterGroupNotFoundFault"}, + {"shape":"InvalidTagFault"} + ] + }, + "DescribeClusterParameters":{ + "name":"DescribeClusterParameters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeClusterParametersMessage"}, + "output":{ + "shape":"ClusterParameterGroupDetails", + "resultWrapper":"DescribeClusterParametersResult" + }, + "errors":[ + {"shape":"ClusterParameterGroupNotFoundFault"} + ] + }, + "DescribeClusterSecurityGroups":{ + "name":"DescribeClusterSecurityGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeClusterSecurityGroupsMessage"}, + "output":{ + "shape":"ClusterSecurityGroupMessage", + "resultWrapper":"DescribeClusterSecurityGroupsResult" + }, + "errors":[ + {"shape":"ClusterSecurityGroupNotFoundFault"}, + {"shape":"InvalidTagFault"} + ] + }, + "DescribeClusterSnapshots":{ + "name":"DescribeClusterSnapshots", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeClusterSnapshotsMessage"}, + "output":{ + "shape":"SnapshotMessage", + "resultWrapper":"DescribeClusterSnapshotsResult" + }, + "errors":[ + {"shape":"ClusterSnapshotNotFoundFault"}, + {"shape":"InvalidTagFault"} + ] + }, + "DescribeClusterSubnetGroups":{ + "name":"DescribeClusterSubnetGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeClusterSubnetGroupsMessage"}, + "output":{ + "shape":"ClusterSubnetGroupMessage", + "resultWrapper":"DescribeClusterSubnetGroupsResult" + }, + "errors":[ + {"shape":"ClusterSubnetGroupNotFoundFault"}, + {"shape":"InvalidTagFault"} + ] + }, + "DescribeClusterVersions":{ + "name":"DescribeClusterVersions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeClusterVersionsMessage"}, + "output":{ + "shape":"ClusterVersionsMessage", + "resultWrapper":"DescribeClusterVersionsResult" + } + }, + "DescribeClusters":{ + "name":"DescribeClusters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeClustersMessage"}, + "output":{ + "shape":"ClustersMessage", + "resultWrapper":"DescribeClustersResult" + }, + "errors":[ + {"shape":"ClusterNotFoundFault"}, + {"shape":"InvalidTagFault"} + ] + }, + "DescribeDefaultClusterParameters":{ + "name":"DescribeDefaultClusterParameters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDefaultClusterParametersMessage"}, + "output":{ + "shape":"DescribeDefaultClusterParametersResult", + "resultWrapper":"DescribeDefaultClusterParametersResult" + } + }, + "DescribeEventCategories":{ + "name":"DescribeEventCategories", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEventCategoriesMessage"}, + "output":{ + "shape":"EventCategoriesMessage", + "resultWrapper":"DescribeEventCategoriesResult" + } + }, + "DescribeEventSubscriptions":{ + "name":"DescribeEventSubscriptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEventSubscriptionsMessage"}, + "output":{ + "shape":"EventSubscriptionsMessage", + "resultWrapper":"DescribeEventSubscriptionsResult" + }, + "errors":[ + {"shape":"SubscriptionNotFoundFault"} + ] + }, + "DescribeEvents":{ + "name":"DescribeEvents", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEventsMessage"}, + "output":{ + "shape":"EventsMessage", + "resultWrapper":"DescribeEventsResult" + } + }, + "DescribeHsmClientCertificates":{ + "name":"DescribeHsmClientCertificates", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeHsmClientCertificatesMessage"}, + "output":{ + "shape":"HsmClientCertificateMessage", + "resultWrapper":"DescribeHsmClientCertificatesResult" + }, + "errors":[ + {"shape":"HsmClientCertificateNotFoundFault"}, + {"shape":"InvalidTagFault"} + ] + }, + "DescribeHsmConfigurations":{ + "name":"DescribeHsmConfigurations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeHsmConfigurationsMessage"}, + "output":{ + "shape":"HsmConfigurationMessage", + "resultWrapper":"DescribeHsmConfigurationsResult" + }, + "errors":[ + {"shape":"HsmConfigurationNotFoundFault"}, + {"shape":"InvalidTagFault"} + ] + }, + "DescribeLoggingStatus":{ + "name":"DescribeLoggingStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeLoggingStatusMessage"}, + "output":{ + "shape":"LoggingStatus", + "resultWrapper":"DescribeLoggingStatusResult" + }, + "errors":[ + {"shape":"ClusterNotFoundFault"} + ] + }, + "DescribeOrderableClusterOptions":{ + "name":"DescribeOrderableClusterOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeOrderableClusterOptionsMessage"}, + "output":{ + "shape":"OrderableClusterOptionsMessage", + "resultWrapper":"DescribeOrderableClusterOptionsResult" + } + }, + "DescribeReservedNodeOfferings":{ + "name":"DescribeReservedNodeOfferings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeReservedNodeOfferingsMessage"}, + "output":{ + "shape":"ReservedNodeOfferingsMessage", + "resultWrapper":"DescribeReservedNodeOfferingsResult" + }, + "errors":[ + {"shape":"ReservedNodeOfferingNotFoundFault"}, + {"shape":"UnsupportedOperationFault"} + ] + }, + "DescribeReservedNodes":{ + "name":"DescribeReservedNodes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeReservedNodesMessage"}, + "output":{ + "shape":"ReservedNodesMessage", + "resultWrapper":"DescribeReservedNodesResult" + }, + "errors":[ + {"shape":"ReservedNodeNotFoundFault"} + ] + }, + "DescribeResize":{ + "name":"DescribeResize", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeResizeMessage"}, + "output":{ + "shape":"ResizeProgressMessage", + "resultWrapper":"DescribeResizeResult" + }, + "errors":[ + {"shape":"ClusterNotFoundFault"}, + {"shape":"ResizeNotFoundFault"} + ] + }, + "DescribeSnapshotCopyGrants":{ + "name":"DescribeSnapshotCopyGrants", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSnapshotCopyGrantsMessage"}, + "output":{ + "shape":"SnapshotCopyGrantMessage", + "resultWrapper":"DescribeSnapshotCopyGrantsResult" + }, + "errors":[ + {"shape":"SnapshotCopyGrantNotFoundFault"}, + {"shape":"InvalidTagFault"} + ] + }, + "DescribeTableRestoreStatus":{ + "name":"DescribeTableRestoreStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeTableRestoreStatusMessage"}, + "output":{ + "shape":"TableRestoreStatusMessage", + "resultWrapper":"DescribeTableRestoreStatusResult" + }, + "errors":[ + {"shape":"TableRestoreNotFoundFault"}, + {"shape":"ClusterNotFoundFault"} + ] + }, + "DescribeTags":{ + "name":"DescribeTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeTagsMessage"}, + "output":{ + "shape":"TaggedResourceListMessage", + "resultWrapper":"DescribeTagsResult" + }, + "errors":[ + {"shape":"ResourceNotFoundFault"}, + {"shape":"InvalidTagFault"} + ] + }, + "DisableLogging":{ + "name":"DisableLogging", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisableLoggingMessage"}, + "output":{ + "shape":"LoggingStatus", + "resultWrapper":"DisableLoggingResult" + }, + "errors":[ + {"shape":"ClusterNotFoundFault"} + ] + }, + "DisableSnapshotCopy":{ + "name":"DisableSnapshotCopy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisableSnapshotCopyMessage"}, + "output":{ + "shape":"DisableSnapshotCopyResult", + "resultWrapper":"DisableSnapshotCopyResult" + }, + "errors":[ + {"shape":"ClusterNotFoundFault"}, + {"shape":"SnapshotCopyAlreadyDisabledFault"}, + {"shape":"InvalidClusterStateFault"}, + {"shape":"UnauthorizedOperation"} + ] + }, + "EnableLogging":{ + "name":"EnableLogging", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"EnableLoggingMessage"}, + "output":{ + "shape":"LoggingStatus", + "resultWrapper":"EnableLoggingResult" + }, + "errors":[ + {"shape":"ClusterNotFoundFault"}, + {"shape":"BucketNotFoundFault"}, + {"shape":"InsufficientS3BucketPolicyFault"}, + {"shape":"InvalidS3KeyPrefixFault"}, + {"shape":"InvalidS3BucketNameFault"} + ] + }, + "EnableSnapshotCopy":{ + "name":"EnableSnapshotCopy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"EnableSnapshotCopyMessage"}, + "output":{ + "shape":"EnableSnapshotCopyResult", + "resultWrapper":"EnableSnapshotCopyResult" + }, + "errors":[ + {"shape":"IncompatibleOrderableOptions"}, + {"shape":"InvalidClusterStateFault"}, + {"shape":"ClusterNotFoundFault"}, + {"shape":"CopyToRegionDisabledFault"}, + {"shape":"SnapshotCopyAlreadyEnabledFault"}, + {"shape":"UnknownSnapshotCopyRegionFault"}, + {"shape":"UnauthorizedOperation"}, + {"shape":"SnapshotCopyGrantNotFoundFault"}, + {"shape":"LimitExceededFault"}, + {"shape":"DependentServiceRequestThrottlingFault"} + ] + }, + "ModifyCluster":{ + "name":"ModifyCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyClusterMessage"}, + "output":{ + "shape":"ModifyClusterResult", + "resultWrapper":"ModifyClusterResult" + }, + "errors":[ + {"shape":"InvalidClusterStateFault"}, + {"shape":"InvalidClusterSecurityGroupStateFault"}, + {"shape":"ClusterNotFoundFault"}, + {"shape":"NumberOfNodesQuotaExceededFault"}, + {"shape":"ClusterSecurityGroupNotFoundFault"}, + {"shape":"ClusterParameterGroupNotFoundFault"}, + {"shape":"InsufficientClusterCapacityFault"}, + {"shape":"UnsupportedOptionFault"}, + {"shape":"UnauthorizedOperation"}, + {"shape":"HsmClientCertificateNotFoundFault"}, + {"shape":"HsmConfigurationNotFoundFault"}, + {"shape":"ClusterAlreadyExistsFault"}, + {"shape":"LimitExceededFault"}, + {"shape":"DependentServiceRequestThrottlingFault"}, + {"shape":"InvalidElasticIpFault"} + ] + }, + "ModifyClusterIamRoles":{ + "name":"ModifyClusterIamRoles", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyClusterIamRolesMessage"}, + "output":{ + "shape":"ModifyClusterIamRolesResult", + "resultWrapper":"ModifyClusterIamRolesResult" + }, + "errors":[ + {"shape":"InvalidClusterStateFault"}, + {"shape":"ClusterNotFoundFault"} + ] + }, + "ModifyClusterParameterGroup":{ + "name":"ModifyClusterParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyClusterParameterGroupMessage"}, + "output":{ + "shape":"ClusterParameterGroupNameMessage", + "resultWrapper":"ModifyClusterParameterGroupResult" + }, + "errors":[ + {"shape":"ClusterParameterGroupNotFoundFault"}, + {"shape":"InvalidClusterParameterGroupStateFault"} + ] + }, + "ModifyClusterSubnetGroup":{ + "name":"ModifyClusterSubnetGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyClusterSubnetGroupMessage"}, + "output":{ + "shape":"ModifyClusterSubnetGroupResult", + "resultWrapper":"ModifyClusterSubnetGroupResult" + }, + "errors":[ + {"shape":"ClusterSubnetGroupNotFoundFault"}, + {"shape":"ClusterSubnetQuotaExceededFault"}, + {"shape":"SubnetAlreadyInUse"}, + {"shape":"InvalidSubnet"}, + {"shape":"UnauthorizedOperation"}, + {"shape":"DependentServiceRequestThrottlingFault"} + ] + }, + "ModifyEventSubscription":{ + "name":"ModifyEventSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyEventSubscriptionMessage"}, + "output":{ + "shape":"ModifyEventSubscriptionResult", + "resultWrapper":"ModifyEventSubscriptionResult" + }, + "errors":[ + {"shape":"SubscriptionNotFoundFault"}, + {"shape":"SNSInvalidTopicFault"}, + {"shape":"SNSNoAuthorizationFault"}, + {"shape":"SNSTopicArnNotFoundFault"}, + {"shape":"SubscriptionEventIdNotFoundFault"}, + {"shape":"SubscriptionCategoryNotFoundFault"}, + {"shape":"SubscriptionSeverityNotFoundFault"}, + {"shape":"SourceNotFoundFault"}, + {"shape":"InvalidSubscriptionStateFault"} + ] + }, + "ModifySnapshotCopyRetentionPeriod":{ + "name":"ModifySnapshotCopyRetentionPeriod", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifySnapshotCopyRetentionPeriodMessage"}, + "output":{ + "shape":"ModifySnapshotCopyRetentionPeriodResult", + "resultWrapper":"ModifySnapshotCopyRetentionPeriodResult" + }, + "errors":[ + {"shape":"ClusterNotFoundFault"}, + {"shape":"SnapshotCopyDisabledFault"}, + {"shape":"UnauthorizedOperation"}, + {"shape":"InvalidClusterStateFault"} + ] + }, + "PurchaseReservedNodeOffering":{ + "name":"PurchaseReservedNodeOffering", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PurchaseReservedNodeOfferingMessage"}, + "output":{ + "shape":"PurchaseReservedNodeOfferingResult", + "resultWrapper":"PurchaseReservedNodeOfferingResult" + }, + "errors":[ + {"shape":"ReservedNodeOfferingNotFoundFault"}, + {"shape":"ReservedNodeAlreadyExistsFault"}, + {"shape":"ReservedNodeQuotaExceededFault"}, + {"shape":"UnsupportedOperationFault"} + ] + }, + "RebootCluster":{ + "name":"RebootCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RebootClusterMessage"}, + "output":{ + "shape":"RebootClusterResult", + "resultWrapper":"RebootClusterResult" + }, + "errors":[ + {"shape":"InvalidClusterStateFault"}, + {"shape":"ClusterNotFoundFault"} + ] + }, + "ResetClusterParameterGroup":{ + "name":"ResetClusterParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResetClusterParameterGroupMessage"}, + "output":{ + "shape":"ClusterParameterGroupNameMessage", + "resultWrapper":"ResetClusterParameterGroupResult" + }, + "errors":[ + {"shape":"InvalidClusterParameterGroupStateFault"}, + {"shape":"ClusterParameterGroupNotFoundFault"} + ] + }, + "RestoreFromClusterSnapshot":{ + "name":"RestoreFromClusterSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RestoreFromClusterSnapshotMessage"}, + "output":{ + "shape":"RestoreFromClusterSnapshotResult", + "resultWrapper":"RestoreFromClusterSnapshotResult" + }, + "errors":[ + {"shape":"AccessToSnapshotDeniedFault"}, + {"shape":"ClusterAlreadyExistsFault"}, + {"shape":"ClusterSnapshotNotFoundFault"}, + {"shape":"ClusterQuotaExceededFault"}, + {"shape":"InsufficientClusterCapacityFault"}, + {"shape":"InvalidClusterSnapshotStateFault"}, + {"shape":"InvalidRestoreFault"}, + {"shape":"NumberOfNodesQuotaExceededFault"}, + {"shape":"NumberOfNodesPerClusterLimitExceededFault"}, + {"shape":"InvalidVPCNetworkStateFault"}, + {"shape":"InvalidClusterSubnetGroupStateFault"}, + {"shape":"InvalidSubnet"}, + {"shape":"ClusterSubnetGroupNotFoundFault"}, + {"shape":"UnauthorizedOperation"}, + {"shape":"HsmClientCertificateNotFoundFault"}, + {"shape":"HsmConfigurationNotFoundFault"}, + {"shape":"InvalidElasticIpFault"}, + {"shape":"ClusterParameterGroupNotFoundFault"}, + {"shape":"ClusterSecurityGroupNotFoundFault"}, + {"shape":"LimitExceededFault"}, + {"shape":"DependentServiceRequestThrottlingFault"} + ] + }, + "RestoreTableFromClusterSnapshot":{ + "name":"RestoreTableFromClusterSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RestoreTableFromClusterSnapshotMessage"}, + "output":{ + "shape":"RestoreTableFromClusterSnapshotResult", + "resultWrapper":"RestoreTableFromClusterSnapshotResult" + }, + "errors":[ + {"shape":"ClusterSnapshotNotFoundFault"}, + {"shape":"InProgressTableRestoreQuotaExceededFault"}, + {"shape":"InvalidClusterSnapshotStateFault"}, + {"shape":"InvalidTableRestoreArgumentFault"}, + {"shape":"ClusterNotFoundFault"}, + {"shape":"InvalidClusterStateFault"}, + {"shape":"UnsupportedOperationFault"} + ] + }, + "RevokeClusterSecurityGroupIngress":{ + "name":"RevokeClusterSecurityGroupIngress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RevokeClusterSecurityGroupIngressMessage"}, + "output":{ + "shape":"RevokeClusterSecurityGroupIngressResult", + "resultWrapper":"RevokeClusterSecurityGroupIngressResult" + }, + "errors":[ + {"shape":"ClusterSecurityGroupNotFoundFault"}, + {"shape":"AuthorizationNotFoundFault"}, + {"shape":"InvalidClusterSecurityGroupStateFault"} + ] + }, + "RevokeSnapshotAccess":{ + "name":"RevokeSnapshotAccess", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RevokeSnapshotAccessMessage"}, + "output":{ + "shape":"RevokeSnapshotAccessResult", + "resultWrapper":"RevokeSnapshotAccessResult" + }, + "errors":[ + {"shape":"AccessToSnapshotDeniedFault"}, + {"shape":"AuthorizationNotFoundFault"}, + {"shape":"ClusterSnapshotNotFoundFault"} + ] + }, + "RotateEncryptionKey":{ + "name":"RotateEncryptionKey", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RotateEncryptionKeyMessage"}, + "output":{ + "shape":"RotateEncryptionKeyResult", + "resultWrapper":"RotateEncryptionKeyResult" + }, + "errors":[ + {"shape":"ClusterNotFoundFault"}, + {"shape":"InvalidClusterStateFault"}, + {"shape":"DependentServiceRequestThrottlingFault"} + ] + } + }, + "shapes":{ + "AccessToSnapshotDeniedFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"AccessToSnapshotDenied", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "AccountWithRestoreAccess":{ + "type":"structure", + "members":{ + "AccountId":{"shape":"String"} + } + }, + "AccountsWithRestoreAccessList":{ + "type":"list", + "member":{ + "shape":"AccountWithRestoreAccess", + "locationName":"AccountWithRestoreAccess" + } + }, + "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 + }, + "AuthorizationQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"AuthorizationQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "AuthorizeClusterSecurityGroupIngressMessage":{ + "type":"structure", + "required":["ClusterSecurityGroupName"], + "members":{ + "ClusterSecurityGroupName":{"shape":"String"}, + "CIDRIP":{"shape":"String"}, + "EC2SecurityGroupName":{"shape":"String"}, + "EC2SecurityGroupOwnerId":{"shape":"String"} + } + }, + "AuthorizeClusterSecurityGroupIngressResult":{ + "type":"structure", + "members":{ + "ClusterSecurityGroup":{"shape":"ClusterSecurityGroup"} + } + }, + "AuthorizeSnapshotAccessMessage":{ + "type":"structure", + "required":[ + "SnapshotIdentifier", + "AccountWithRestoreAccess" + ], + "members":{ + "SnapshotIdentifier":{"shape":"String"}, + "SnapshotClusterIdentifier":{"shape":"String"}, + "AccountWithRestoreAccess":{"shape":"String"} + } + }, + "AuthorizeSnapshotAccessResult":{ + "type":"structure", + "members":{ + "Snapshot":{"shape":"Snapshot"} + } + }, + "AvailabilityZone":{ + "type":"structure", + "members":{ + "Name":{"shape":"String"} + }, + "wrapper":true + }, + "AvailabilityZoneList":{ + "type":"list", + "member":{ + "shape":"AvailabilityZone", + "locationName":"AvailabilityZone" + } + }, + "Boolean":{"type":"boolean"}, + "BooleanOptional":{"type":"boolean"}, + "BucketNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"BucketNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "Cluster":{ + "type":"structure", + "members":{ + "ClusterIdentifier":{"shape":"String"}, + "NodeType":{"shape":"String"}, + "ClusterStatus":{"shape":"String"}, + "ModifyStatus":{"shape":"String"}, + "MasterUsername":{"shape":"String"}, + "DBName":{"shape":"String"}, + "Endpoint":{"shape":"Endpoint"}, + "ClusterCreateTime":{"shape":"TStamp"}, + "AutomatedSnapshotRetentionPeriod":{"shape":"Integer"}, + "ClusterSecurityGroups":{"shape":"ClusterSecurityGroupMembershipList"}, + "VpcSecurityGroups":{"shape":"VpcSecurityGroupMembershipList"}, + "ClusterParameterGroups":{"shape":"ClusterParameterGroupStatusList"}, + "ClusterSubnetGroupName":{"shape":"String"}, + "VpcId":{"shape":"String"}, + "AvailabilityZone":{"shape":"String"}, + "PreferredMaintenanceWindow":{"shape":"String"}, + "PendingModifiedValues":{"shape":"PendingModifiedValues"}, + "ClusterVersion":{"shape":"String"}, + "AllowVersionUpgrade":{"shape":"Boolean"}, + "NumberOfNodes":{"shape":"Integer"}, + "PubliclyAccessible":{"shape":"Boolean"}, + "Encrypted":{"shape":"Boolean"}, + "RestoreStatus":{"shape":"RestoreStatus"}, + "HsmStatus":{"shape":"HsmStatus"}, + "ClusterSnapshotCopyStatus":{"shape":"ClusterSnapshotCopyStatus"}, + "ClusterPublicKey":{"shape":"String"}, + "ClusterNodes":{"shape":"ClusterNodesList"}, + "ElasticIpStatus":{"shape":"ElasticIpStatus"}, + "ClusterRevisionNumber":{"shape":"String"}, + "Tags":{"shape":"TagList"}, + "KmsKeyId":{"shape":"String"}, + "IamRoles":{"shape":"ClusterIamRoleList"} + }, + "wrapper":true + }, + "ClusterAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ClusterAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ClusterIamRole":{ + "type":"structure", + "members":{ + "IamRoleArn":{"shape":"String"}, + "ApplyStatus":{"shape":"String"} + } + }, + "ClusterIamRoleList":{ + "type":"list", + "member":{ + "shape":"ClusterIamRole", + "locationName":"ClusterIamRole" + } + }, + "ClusterList":{ + "type":"list", + "member":{ + "shape":"Cluster", + "locationName":"Cluster" + } + }, + "ClusterNode":{ + "type":"structure", + "members":{ + "NodeRole":{"shape":"String"}, + "PrivateIPAddress":{"shape":"String"}, + "PublicIPAddress":{"shape":"String"} + } + }, + "ClusterNodesList":{ + "type":"list", + "member":{"shape":"ClusterNode"} + }, + "ClusterNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ClusterNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ClusterParameterGroup":{ + "type":"structure", + "members":{ + "ParameterGroupName":{"shape":"String"}, + "ParameterGroupFamily":{"shape":"String"}, + "Description":{"shape":"String"}, + "Tags":{"shape":"TagList"} + }, + "wrapper":true + }, + "ClusterParameterGroupAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ClusterParameterGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ClusterParameterGroupDetails":{ + "type":"structure", + "members":{ + "Parameters":{"shape":"ParametersList"}, + "Marker":{"shape":"String"} + } + }, + "ClusterParameterGroupNameMessage":{ + "type":"structure", + "members":{ + "ParameterGroupName":{"shape":"String"}, + "ParameterGroupStatus":{"shape":"String"} + } + }, + "ClusterParameterGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ClusterParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ClusterParameterGroupQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ClusterParameterGroupQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ClusterParameterGroupStatus":{ + "type":"structure", + "members":{ + "ParameterGroupName":{"shape":"String"}, + "ParameterApplyStatus":{"shape":"String"}, + "ClusterParameterStatusList":{"shape":"ClusterParameterStatusList"} + } + }, + "ClusterParameterGroupStatusList":{ + "type":"list", + "member":{ + "shape":"ClusterParameterGroupStatus", + "locationName":"ClusterParameterGroup" + } + }, + "ClusterParameterGroupsMessage":{ + "type":"structure", + "members":{ + "Marker":{"shape":"String"}, + "ParameterGroups":{"shape":"ParameterGroupList"} + } + }, + "ClusterParameterStatus":{ + "type":"structure", + "members":{ + "ParameterName":{"shape":"String"}, + "ParameterApplyStatus":{"shape":"String"}, + "ParameterApplyErrorDescription":{"shape":"String"} + } + }, + "ClusterParameterStatusList":{ + "type":"list", + "member":{"shape":"ClusterParameterStatus"} + }, + "ClusterQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ClusterQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ClusterSecurityGroup":{ + "type":"structure", + "members":{ + "ClusterSecurityGroupName":{"shape":"String"}, + "Description":{"shape":"String"}, + "EC2SecurityGroups":{"shape":"EC2SecurityGroupList"}, + "IPRanges":{"shape":"IPRangeList"}, + "Tags":{"shape":"TagList"} + }, + "wrapper":true + }, + "ClusterSecurityGroupAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ClusterSecurityGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ClusterSecurityGroupMembership":{ + "type":"structure", + "members":{ + "ClusterSecurityGroupName":{"shape":"String"}, + "Status":{"shape":"String"} + } + }, + "ClusterSecurityGroupMembershipList":{ + "type":"list", + "member":{ + "shape":"ClusterSecurityGroupMembership", + "locationName":"ClusterSecurityGroup" + } + }, + "ClusterSecurityGroupMessage":{ + "type":"structure", + "members":{ + "Marker":{"shape":"String"}, + "ClusterSecurityGroups":{"shape":"ClusterSecurityGroups"} + } + }, + "ClusterSecurityGroupNameList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ClusterSecurityGroupName" + } + }, + "ClusterSecurityGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ClusterSecurityGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ClusterSecurityGroupQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"QuotaExceeded.ClusterSecurityGroup", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ClusterSecurityGroups":{ + "type":"list", + "member":{ + "shape":"ClusterSecurityGroup", + "locationName":"ClusterSecurityGroup" + } + }, + "ClusterSnapshotAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ClusterSnapshotAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ClusterSnapshotCopyStatus":{ + "type":"structure", + "members":{ + "DestinationRegion":{"shape":"String"}, + "RetentionPeriod":{"shape":"Long"}, + "SnapshotCopyGrantName":{"shape":"String"} + } + }, + "ClusterSnapshotNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ClusterSnapshotNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ClusterSnapshotQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ClusterSnapshotQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ClusterSubnetGroup":{ + "type":"structure", + "members":{ + "ClusterSubnetGroupName":{"shape":"String"}, + "Description":{"shape":"String"}, + "VpcId":{"shape":"String"}, + "SubnetGroupStatus":{"shape":"String"}, + "Subnets":{"shape":"SubnetList"}, + "Tags":{"shape":"TagList"} + }, + "wrapper":true + }, + "ClusterSubnetGroupAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ClusterSubnetGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ClusterSubnetGroupMessage":{ + "type":"structure", + "members":{ + "Marker":{"shape":"String"}, + "ClusterSubnetGroups":{"shape":"ClusterSubnetGroups"} + } + }, + "ClusterSubnetGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ClusterSubnetGroupNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ClusterSubnetGroupQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ClusterSubnetGroupQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ClusterSubnetGroups":{ + "type":"list", + "member":{ + "shape":"ClusterSubnetGroup", + "locationName":"ClusterSubnetGroup" + } + }, + "ClusterSubnetQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ClusterSubnetQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ClusterVersion":{ + "type":"structure", + "members":{ + "ClusterVersion":{"shape":"String"}, + "ClusterParameterGroupFamily":{"shape":"String"}, + "Description":{"shape":"String"} + } + }, + "ClusterVersionList":{ + "type":"list", + "member":{ + "shape":"ClusterVersion", + "locationName":"ClusterVersion" + } + }, + "ClusterVersionsMessage":{ + "type":"structure", + "members":{ + "Marker":{"shape":"String"}, + "ClusterVersions":{"shape":"ClusterVersionList"} + } + }, + "ClustersMessage":{ + "type":"structure", + "members":{ + "Marker":{"shape":"String"}, + "Clusters":{"shape":"ClusterList"} + } + }, + "CopyClusterSnapshotMessage":{ + "type":"structure", + "required":[ + "SourceSnapshotIdentifier", + "TargetSnapshotIdentifier" + ], + "members":{ + "SourceSnapshotIdentifier":{"shape":"String"}, + "SourceSnapshotClusterIdentifier":{"shape":"String"}, + "TargetSnapshotIdentifier":{"shape":"String"} + } + }, + "CopyClusterSnapshotResult":{ + "type":"structure", + "members":{ + "Snapshot":{"shape":"Snapshot"} + } + }, + "CopyToRegionDisabledFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"CopyToRegionDisabledFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "CreateClusterMessage":{ + "type":"structure", + "required":[ + "ClusterIdentifier", + "NodeType", + "MasterUsername", + "MasterUserPassword" + ], + "members":{ + "DBName":{"shape":"String"}, + "ClusterIdentifier":{"shape":"String"}, + "ClusterType":{"shape":"String"}, + "NodeType":{"shape":"String"}, + "MasterUsername":{"shape":"String"}, + "MasterUserPassword":{"shape":"String"}, + "ClusterSecurityGroups":{"shape":"ClusterSecurityGroupNameList"}, + "VpcSecurityGroupIds":{"shape":"VpcSecurityGroupIdList"}, + "ClusterSubnetGroupName":{"shape":"String"}, + "AvailabilityZone":{"shape":"String"}, + "PreferredMaintenanceWindow":{"shape":"String"}, + "ClusterParameterGroupName":{"shape":"String"}, + "AutomatedSnapshotRetentionPeriod":{"shape":"IntegerOptional"}, + "Port":{"shape":"IntegerOptional"}, + "ClusterVersion":{"shape":"String"}, + "AllowVersionUpgrade":{"shape":"BooleanOptional"}, + "NumberOfNodes":{"shape":"IntegerOptional"}, + "PubliclyAccessible":{"shape":"BooleanOptional"}, + "Encrypted":{"shape":"BooleanOptional"}, + "HsmClientCertificateIdentifier":{"shape":"String"}, + "HsmConfigurationIdentifier":{"shape":"String"}, + "ElasticIp":{"shape":"String"}, + "Tags":{"shape":"TagList"}, + "KmsKeyId":{"shape":"String"}, + "AdditionalInfo":{"shape":"String"}, + "IamRoles":{"shape":"IamRoleArnList"} + } + }, + "CreateClusterParameterGroupMessage":{ + "type":"structure", + "required":[ + "ParameterGroupName", + "ParameterGroupFamily", + "Description" + ], + "members":{ + "ParameterGroupName":{"shape":"String"}, + "ParameterGroupFamily":{"shape":"String"}, + "Description":{"shape":"String"}, + "Tags":{"shape":"TagList"} + } + }, + "CreateClusterParameterGroupResult":{ + "type":"structure", + "members":{ + "ClusterParameterGroup":{"shape":"ClusterParameterGroup"} + } + }, + "CreateClusterResult":{ + "type":"structure", + "members":{ + "Cluster":{"shape":"Cluster"} + } + }, + "CreateClusterSecurityGroupMessage":{ + "type":"structure", + "required":[ + "ClusterSecurityGroupName", + "Description" + ], + "members":{ + "ClusterSecurityGroupName":{"shape":"String"}, + "Description":{"shape":"String"}, + "Tags":{"shape":"TagList"} + } + }, + "CreateClusterSecurityGroupResult":{ + "type":"structure", + "members":{ + "ClusterSecurityGroup":{"shape":"ClusterSecurityGroup"} + } + }, + "CreateClusterSnapshotMessage":{ + "type":"structure", + "required":[ + "SnapshotIdentifier", + "ClusterIdentifier" + ], + "members":{ + "SnapshotIdentifier":{"shape":"String"}, + "ClusterIdentifier":{"shape":"String"}, + "Tags":{"shape":"TagList"} + } + }, + "CreateClusterSnapshotResult":{ + "type":"structure", + "members":{ + "Snapshot":{"shape":"Snapshot"} + } + }, + "CreateClusterSubnetGroupMessage":{ + "type":"structure", + "required":[ + "ClusterSubnetGroupName", + "Description", + "SubnetIds" + ], + "members":{ + "ClusterSubnetGroupName":{"shape":"String"}, + "Description":{"shape":"String"}, + "SubnetIds":{"shape":"SubnetIdentifierList"}, + "Tags":{"shape":"TagList"} + } + }, + "CreateClusterSubnetGroupResult":{ + "type":"structure", + "members":{ + "ClusterSubnetGroup":{"shape":"ClusterSubnetGroup"} + } + }, + "CreateEventSubscriptionMessage":{ + "type":"structure", + "required":[ + "SubscriptionName", + "SnsTopicArn" + ], + "members":{ + "SubscriptionName":{"shape":"String"}, + "SnsTopicArn":{"shape":"String"}, + "SourceType":{"shape":"String"}, + "SourceIds":{"shape":"SourceIdsList"}, + "EventCategories":{"shape":"EventCategoriesList"}, + "Severity":{"shape":"String"}, + "Enabled":{"shape":"BooleanOptional"}, + "Tags":{"shape":"TagList"} + } + }, + "CreateEventSubscriptionResult":{ + "type":"structure", + "members":{ + "EventSubscription":{"shape":"EventSubscription"} + } + }, + "CreateHsmClientCertificateMessage":{ + "type":"structure", + "required":["HsmClientCertificateIdentifier"], + "members":{ + "HsmClientCertificateIdentifier":{"shape":"String"}, + "Tags":{"shape":"TagList"} + } + }, + "CreateHsmClientCertificateResult":{ + "type":"structure", + "members":{ + "HsmClientCertificate":{"shape":"HsmClientCertificate"} + } + }, + "CreateHsmConfigurationMessage":{ + "type":"structure", + "required":[ + "HsmConfigurationIdentifier", + "Description", + "HsmIpAddress", + "HsmPartitionName", + "HsmPartitionPassword", + "HsmServerPublicCertificate" + ], + "members":{ + "HsmConfigurationIdentifier":{"shape":"String"}, + "Description":{"shape":"String"}, + "HsmIpAddress":{"shape":"String"}, + "HsmPartitionName":{"shape":"String"}, + "HsmPartitionPassword":{"shape":"String"}, + "HsmServerPublicCertificate":{"shape":"String"}, + "Tags":{"shape":"TagList"} + } + }, + "CreateHsmConfigurationResult":{ + "type":"structure", + "members":{ + "HsmConfiguration":{"shape":"HsmConfiguration"} + } + }, + "CreateSnapshotCopyGrantMessage":{ + "type":"structure", + "required":["SnapshotCopyGrantName"], + "members":{ + "SnapshotCopyGrantName":{"shape":"String"}, + "KmsKeyId":{"shape":"String"}, + "Tags":{"shape":"TagList"} + } + }, + "CreateSnapshotCopyGrantResult":{ + "type":"structure", + "members":{ + "SnapshotCopyGrant":{"shape":"SnapshotCopyGrant"} + } + }, + "CreateTagsMessage":{ + "type":"structure", + "required":[ + "ResourceName", + "Tags" + ], + "members":{ + "ResourceName":{"shape":"String"}, + "Tags":{"shape":"TagList"} + } + }, + "DefaultClusterParameters":{ + "type":"structure", + "members":{ + "ParameterGroupFamily":{"shape":"String"}, + "Marker":{"shape":"String"}, + "Parameters":{"shape":"ParametersList"} + }, + "wrapper":true + }, + "DeleteClusterMessage":{ + "type":"structure", + "required":["ClusterIdentifier"], + "members":{ + "ClusterIdentifier":{"shape":"String"}, + "SkipFinalClusterSnapshot":{"shape":"Boolean"}, + "FinalClusterSnapshotIdentifier":{"shape":"String"} + } + }, + "DeleteClusterParameterGroupMessage":{ + "type":"structure", + "required":["ParameterGroupName"], + "members":{ + "ParameterGroupName":{"shape":"String"} + } + }, + "DeleteClusterResult":{ + "type":"structure", + "members":{ + "Cluster":{"shape":"Cluster"} + } + }, + "DeleteClusterSecurityGroupMessage":{ + "type":"structure", + "required":["ClusterSecurityGroupName"], + "members":{ + "ClusterSecurityGroupName":{"shape":"String"} + } + }, + "DeleteClusterSnapshotMessage":{ + "type":"structure", + "required":["SnapshotIdentifier"], + "members":{ + "SnapshotIdentifier":{"shape":"String"}, + "SnapshotClusterIdentifier":{"shape":"String"} + } + }, + "DeleteClusterSnapshotResult":{ + "type":"structure", + "members":{ + "Snapshot":{"shape":"Snapshot"} + } + }, + "DeleteClusterSubnetGroupMessage":{ + "type":"structure", + "required":["ClusterSubnetGroupName"], + "members":{ + "ClusterSubnetGroupName":{"shape":"String"} + } + }, + "DeleteEventSubscriptionMessage":{ + "type":"structure", + "required":["SubscriptionName"], + "members":{ + "SubscriptionName":{"shape":"String"} + } + }, + "DeleteHsmClientCertificateMessage":{ + "type":"structure", + "required":["HsmClientCertificateIdentifier"], + "members":{ + "HsmClientCertificateIdentifier":{"shape":"String"} + } + }, + "DeleteHsmConfigurationMessage":{ + "type":"structure", + "required":["HsmConfigurationIdentifier"], + "members":{ + "HsmConfigurationIdentifier":{"shape":"String"} + } + }, + "DeleteSnapshotCopyGrantMessage":{ + "type":"structure", + "required":["SnapshotCopyGrantName"], + "members":{ + "SnapshotCopyGrantName":{"shape":"String"} + } + }, + "DeleteTagsMessage":{ + "type":"structure", + "required":[ + "ResourceName", + "TagKeys" + ], + "members":{ + "ResourceName":{"shape":"String"}, + "TagKeys":{"shape":"TagKeyList"} + } + }, + "DependentServiceRequestThrottlingFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DependentServiceRequestThrottlingFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DescribeClusterParameterGroupsMessage":{ + "type":"structure", + "members":{ + "ParameterGroupName":{"shape":"String"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"}, + "TagKeys":{"shape":"TagKeyList"}, + "TagValues":{"shape":"TagValueList"} + } + }, + "DescribeClusterParametersMessage":{ + "type":"structure", + "required":["ParameterGroupName"], + "members":{ + "ParameterGroupName":{"shape":"String"}, + "Source":{"shape":"String"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "DescribeClusterSecurityGroupsMessage":{ + "type":"structure", + "members":{ + "ClusterSecurityGroupName":{"shape":"String"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"}, + "TagKeys":{"shape":"TagKeyList"}, + "TagValues":{"shape":"TagValueList"} + } + }, + "DescribeClusterSnapshotsMessage":{ + "type":"structure", + "members":{ + "ClusterIdentifier":{"shape":"String"}, + "SnapshotIdentifier":{"shape":"String"}, + "SnapshotType":{"shape":"String"}, + "StartTime":{"shape":"TStamp"}, + "EndTime":{"shape":"TStamp"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"}, + "OwnerAccount":{"shape":"String"}, + "TagKeys":{"shape":"TagKeyList"}, + "TagValues":{"shape":"TagValueList"} + } + }, + "DescribeClusterSubnetGroupsMessage":{ + "type":"structure", + "members":{ + "ClusterSubnetGroupName":{"shape":"String"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"}, + "TagKeys":{"shape":"TagKeyList"}, + "TagValues":{"shape":"TagValueList"} + } + }, + "DescribeClusterVersionsMessage":{ + "type":"structure", + "members":{ + "ClusterVersion":{"shape":"String"}, + "ClusterParameterGroupFamily":{"shape":"String"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "DescribeClustersMessage":{ + "type":"structure", + "members":{ + "ClusterIdentifier":{"shape":"String"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"}, + "TagKeys":{"shape":"TagKeyList"}, + "TagValues":{"shape":"TagValueList"} + } + }, + "DescribeDefaultClusterParametersMessage":{ + "type":"structure", + "required":["ParameterGroupFamily"], + "members":{ + "ParameterGroupFamily":{"shape":"String"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "DescribeDefaultClusterParametersResult":{ + "type":"structure", + "members":{ + "DefaultClusterParameters":{"shape":"DefaultClusterParameters"} + } + }, + "DescribeEventCategoriesMessage":{ + "type":"structure", + "members":{ + "SourceType":{"shape":"String"} + } + }, + "DescribeEventSubscriptionsMessage":{ + "type":"structure", + "members":{ + "SubscriptionName":{"shape":"String"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "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"} + } + }, + "DescribeHsmClientCertificatesMessage":{ + "type":"structure", + "members":{ + "HsmClientCertificateIdentifier":{"shape":"String"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"}, + "TagKeys":{"shape":"TagKeyList"}, + "TagValues":{"shape":"TagValueList"} + } + }, + "DescribeHsmConfigurationsMessage":{ + "type":"structure", + "members":{ + "HsmConfigurationIdentifier":{"shape":"String"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"}, + "TagKeys":{"shape":"TagKeyList"}, + "TagValues":{"shape":"TagValueList"} + } + }, + "DescribeLoggingStatusMessage":{ + "type":"structure", + "required":["ClusterIdentifier"], + "members":{ + "ClusterIdentifier":{"shape":"String"} + } + }, + "DescribeOrderableClusterOptionsMessage":{ + "type":"structure", + "members":{ + "ClusterVersion":{"shape":"String"}, + "NodeType":{"shape":"String"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "DescribeReservedNodeOfferingsMessage":{ + "type":"structure", + "members":{ + "ReservedNodeOfferingId":{"shape":"String"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "DescribeReservedNodesMessage":{ + "type":"structure", + "members":{ + "ReservedNodeId":{"shape":"String"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "DescribeResizeMessage":{ + "type":"structure", + "required":["ClusterIdentifier"], + "members":{ + "ClusterIdentifier":{"shape":"String"} + } + }, + "DescribeSnapshotCopyGrantsMessage":{ + "type":"structure", + "members":{ + "SnapshotCopyGrantName":{"shape":"String"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"}, + "TagKeys":{"shape":"TagKeyList"}, + "TagValues":{"shape":"TagValueList"} + } + }, + "DescribeTableRestoreStatusMessage":{ + "type":"structure", + "members":{ + "ClusterIdentifier":{"shape":"String"}, + "TableRestoreRequestId":{"shape":"String"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"} + } + }, + "DescribeTagsMessage":{ + "type":"structure", + "members":{ + "ResourceName":{"shape":"String"}, + "ResourceType":{"shape":"String"}, + "MaxRecords":{"shape":"IntegerOptional"}, + "Marker":{"shape":"String"}, + "TagKeys":{"shape":"TagKeyList"}, + "TagValues":{"shape":"TagValueList"} + } + }, + "DisableLoggingMessage":{ + "type":"structure", + "required":["ClusterIdentifier"], + "members":{ + "ClusterIdentifier":{"shape":"String"} + } + }, + "DisableSnapshotCopyMessage":{ + "type":"structure", + "required":["ClusterIdentifier"], + "members":{ + "ClusterIdentifier":{"shape":"String"} + } + }, + "DisableSnapshotCopyResult":{ + "type":"structure", + "members":{ + "Cluster":{"shape":"Cluster"} + } + }, + "Double":{"type":"double"}, + "DoubleOptional":{"type":"double"}, + "EC2SecurityGroup":{ + "type":"structure", + "members":{ + "Status":{"shape":"String"}, + "EC2SecurityGroupName":{"shape":"String"}, + "EC2SecurityGroupOwnerId":{"shape":"String"}, + "Tags":{"shape":"TagList"} + } + }, + "EC2SecurityGroupList":{ + "type":"list", + "member":{ + "shape":"EC2SecurityGroup", + "locationName":"EC2SecurityGroup" + } + }, + "ElasticIpStatus":{ + "type":"structure", + "members":{ + "ElasticIp":{"shape":"String"}, + "Status":{"shape":"String"} + } + }, + "EnableLoggingMessage":{ + "type":"structure", + "required":[ + "ClusterIdentifier", + "BucketName" + ], + "members":{ + "ClusterIdentifier":{"shape":"String"}, + "BucketName":{"shape":"String"}, + "S3KeyPrefix":{"shape":"String"} + } + }, + "EnableSnapshotCopyMessage":{ + "type":"structure", + "required":[ + "ClusterIdentifier", + "DestinationRegion" + ], + "members":{ + "ClusterIdentifier":{"shape":"String"}, + "DestinationRegion":{"shape":"String"}, + "RetentionPeriod":{"shape":"IntegerOptional"}, + "SnapshotCopyGrantName":{"shape":"String"} + } + }, + "EnableSnapshotCopyResult":{ + "type":"structure", + "members":{ + "Cluster":{"shape":"Cluster"} + } + }, + "Endpoint":{ + "type":"structure", + "members":{ + "Address":{"shape":"String"}, + "Port":{"shape":"Integer"} + } + }, + "Event":{ + "type":"structure", + "members":{ + "SourceIdentifier":{"shape":"String"}, + "SourceType":{"shape":"SourceType"}, + "Message":{"shape":"String"}, + "EventCategories":{"shape":"EventCategoriesList"}, + "Severity":{"shape":"String"}, + "Date":{"shape":"TStamp"}, + "EventId":{"shape":"String"} + } + }, + "EventCategoriesList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"EventCategory" + } + }, + "EventCategoriesMap":{ + "type":"structure", + "members":{ + "SourceType":{"shape":"String"}, + "Events":{"shape":"EventInfoMapList"} + }, + "wrapper":true + }, + "EventCategoriesMapList":{ + "type":"list", + "member":{ + "shape":"EventCategoriesMap", + "locationName":"EventCategoriesMap" + } + }, + "EventCategoriesMessage":{ + "type":"structure", + "members":{ + "EventCategoriesMapList":{"shape":"EventCategoriesMapList"} + } + }, + "EventInfoMap":{ + "type":"structure", + "members":{ + "EventId":{"shape":"String"}, + "EventCategories":{"shape":"EventCategoriesList"}, + "EventDescription":{"shape":"String"}, + "Severity":{"shape":"String"} + }, + "wrapper":true + }, + "EventInfoMapList":{ + "type":"list", + "member":{ + "shape":"EventInfoMap", + "locationName":"EventInfoMap" + } + }, + "EventList":{ + "type":"list", + "member":{ + "shape":"Event", + "locationName":"Event" + } + }, + "EventSubscription":{ + "type":"structure", + "members":{ + "CustomerAwsId":{"shape":"String"}, + "CustSubscriptionId":{"shape":"String"}, + "SnsTopicArn":{"shape":"String"}, + "Status":{"shape":"String"}, + "SubscriptionCreationTime":{"shape":"TStamp"}, + "SourceType":{"shape":"String"}, + "SourceIdsList":{"shape":"SourceIdsList"}, + "EventCategoriesList":{"shape":"EventCategoriesList"}, + "Severity":{"shape":"String"}, + "Enabled":{"shape":"Boolean"}, + "Tags":{"shape":"TagList"} + }, + "wrapper":true + }, + "EventSubscriptionQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"EventSubscriptionQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "EventSubscriptionsList":{ + "type":"list", + "member":{ + "shape":"EventSubscription", + "locationName":"EventSubscription" + } + }, + "EventSubscriptionsMessage":{ + "type":"structure", + "members":{ + "Marker":{"shape":"String"}, + "EventSubscriptionsList":{"shape":"EventSubscriptionsList"} + } + }, + "EventsMessage":{ + "type":"structure", + "members":{ + "Marker":{"shape":"String"}, + "Events":{"shape":"EventList"} + } + }, + "HsmClientCertificate":{ + "type":"structure", + "members":{ + "HsmClientCertificateIdentifier":{"shape":"String"}, + "HsmClientCertificatePublicKey":{"shape":"String"}, + "Tags":{"shape":"TagList"} + }, + "wrapper":true + }, + "HsmClientCertificateAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"HsmClientCertificateAlreadyExistsFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "HsmClientCertificateList":{ + "type":"list", + "member":{ + "shape":"HsmClientCertificate", + "locationName":"HsmClientCertificate" + } + }, + "HsmClientCertificateMessage":{ + "type":"structure", + "members":{ + "Marker":{"shape":"String"}, + "HsmClientCertificates":{"shape":"HsmClientCertificateList"} + } + }, + "HsmClientCertificateNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"HsmClientCertificateNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "HsmClientCertificateQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"HsmClientCertificateQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "HsmConfiguration":{ + "type":"structure", + "members":{ + "HsmConfigurationIdentifier":{"shape":"String"}, + "Description":{"shape":"String"}, + "HsmIpAddress":{"shape":"String"}, + "HsmPartitionName":{"shape":"String"}, + "Tags":{"shape":"TagList"} + }, + "wrapper":true + }, + "HsmConfigurationAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"HsmConfigurationAlreadyExistsFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "HsmConfigurationList":{ + "type":"list", + "member":{ + "shape":"HsmConfiguration", + "locationName":"HsmConfiguration" + } + }, + "HsmConfigurationMessage":{ + "type":"structure", + "members":{ + "Marker":{"shape":"String"}, + "HsmConfigurations":{"shape":"HsmConfigurationList"} + } + }, + "HsmConfigurationNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"HsmConfigurationNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "HsmConfigurationQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"HsmConfigurationQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "HsmStatus":{ + "type":"structure", + "members":{ + "HsmClientCertificateIdentifier":{"shape":"String"}, + "HsmConfigurationIdentifier":{"shape":"String"}, + "Status":{"shape":"String"} + } + }, + "IPRange":{ + "type":"structure", + "members":{ + "Status":{"shape":"String"}, + "CIDRIP":{"shape":"String"}, + "Tags":{"shape":"TagList"} + } + }, + "IPRangeList":{ + "type":"list", + "member":{ + "shape":"IPRange", + "locationName":"IPRange" + } + }, + "IamRoleArnList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"IamRoleArn" + } + }, + "ImportTablesCompleted":{ + "type":"list", + "member":{"shape":"String"} + }, + "ImportTablesInProgress":{ + "type":"list", + "member":{"shape":"String"} + }, + "ImportTablesNotStarted":{ + "type":"list", + "member":{"shape":"String"} + }, + "InProgressTableRestoreQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InProgressTableRestoreQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "IncompatibleOrderableOptions":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"IncompatibleOrderableOptions", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InsufficientClusterCapacityFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InsufficientClusterCapacity", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InsufficientS3BucketPolicyFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InsufficientS3BucketPolicyFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "Integer":{"type":"integer"}, + "IntegerOptional":{"type":"integer"}, + "InvalidClusterParameterGroupStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidClusterParameterGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidClusterSecurityGroupStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidClusterSecurityGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidClusterSnapshotStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidClusterSnapshotState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidClusterStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidClusterState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidClusterSubnetGroupStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidClusterSubnetGroupStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidClusterSubnetStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidClusterSubnetStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidElasticIpFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidElasticIpFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidHsmClientCertificateStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidHsmClientCertificateStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidHsmConfigurationStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidHsmConfigurationStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidRestoreFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidRestore", + "httpStatusCode":406, + "senderFault":true + }, + "exception":true + }, + "InvalidS3BucketNameFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidS3BucketNameFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidS3KeyPrefixFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidS3KeyPrefixFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidSnapshotCopyGrantStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidSnapshotCopyGrantStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidSubnet":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidSubnet", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidSubscriptionStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidSubscriptionStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidTableRestoreArgumentFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidTableRestoreArgument", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidTagFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidTagFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidVPCNetworkStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidVPCNetworkStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "LimitExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"LimitExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "LoggingStatus":{ + "type":"structure", + "members":{ + "LoggingEnabled":{"shape":"Boolean"}, + "BucketName":{"shape":"String"}, + "S3KeyPrefix":{"shape":"String"}, + "LastSuccessfulDeliveryTime":{"shape":"TStamp"}, + "LastFailureTime":{"shape":"TStamp"}, + "LastFailureMessage":{"shape":"String"} + } + }, + "Long":{"type":"long"}, + "LongOptional":{"type":"long"}, + "ModifyClusterIamRolesMessage":{ + "type":"structure", + "required":["ClusterIdentifier"], + "members":{ + "ClusterIdentifier":{"shape":"String"}, + "AddIamRoles":{"shape":"IamRoleArnList"}, + "RemoveIamRoles":{"shape":"IamRoleArnList"} + } + }, + "ModifyClusterIamRolesResult":{ + "type":"structure", + "members":{ + "Cluster":{"shape":"Cluster"} + } + }, + "ModifyClusterMessage":{ + "type":"structure", + "required":["ClusterIdentifier"], + "members":{ + "ClusterIdentifier":{"shape":"String"}, + "ClusterType":{"shape":"String"}, + "NodeType":{"shape":"String"}, + "NumberOfNodes":{"shape":"IntegerOptional"}, + "ClusterSecurityGroups":{"shape":"ClusterSecurityGroupNameList"}, + "VpcSecurityGroupIds":{"shape":"VpcSecurityGroupIdList"}, + "MasterUserPassword":{"shape":"String"}, + "ClusterParameterGroupName":{"shape":"String"}, + "AutomatedSnapshotRetentionPeriod":{"shape":"IntegerOptional"}, + "PreferredMaintenanceWindow":{"shape":"String"}, + "ClusterVersion":{"shape":"String"}, + "AllowVersionUpgrade":{"shape":"BooleanOptional"}, + "HsmClientCertificateIdentifier":{"shape":"String"}, + "HsmConfigurationIdentifier":{"shape":"String"}, + "NewClusterIdentifier":{"shape":"String"}, + "PubliclyAccessible":{"shape":"BooleanOptional"}, + "ElasticIp":{"shape":"String"} + } + }, + "ModifyClusterParameterGroupMessage":{ + "type":"structure", + "required":[ + "ParameterGroupName", + "Parameters" + ], + "members":{ + "ParameterGroupName":{"shape":"String"}, + "Parameters":{"shape":"ParametersList"} + } + }, + "ModifyClusterResult":{ + "type":"structure", + "members":{ + "Cluster":{"shape":"Cluster"} + } + }, + "ModifyClusterSubnetGroupMessage":{ + "type":"structure", + "required":[ + "ClusterSubnetGroupName", + "SubnetIds" + ], + "members":{ + "ClusterSubnetGroupName":{"shape":"String"}, + "Description":{"shape":"String"}, + "SubnetIds":{"shape":"SubnetIdentifierList"} + } + }, + "ModifyClusterSubnetGroupResult":{ + "type":"structure", + "members":{ + "ClusterSubnetGroup":{"shape":"ClusterSubnetGroup"} + } + }, + "ModifyEventSubscriptionMessage":{ + "type":"structure", + "required":["SubscriptionName"], + "members":{ + "SubscriptionName":{"shape":"String"}, + "SnsTopicArn":{"shape":"String"}, + "SourceType":{"shape":"String"}, + "SourceIds":{"shape":"SourceIdsList"}, + "EventCategories":{"shape":"EventCategoriesList"}, + "Severity":{"shape":"String"}, + "Enabled":{"shape":"BooleanOptional"} + } + }, + "ModifyEventSubscriptionResult":{ + "type":"structure", + "members":{ + "EventSubscription":{"shape":"EventSubscription"} + } + }, + "ModifySnapshotCopyRetentionPeriodMessage":{ + "type":"structure", + "required":[ + "ClusterIdentifier", + "RetentionPeriod" + ], + "members":{ + "ClusterIdentifier":{"shape":"String"}, + "RetentionPeriod":{"shape":"Integer"} + } + }, + "ModifySnapshotCopyRetentionPeriodResult":{ + "type":"structure", + "members":{ + "Cluster":{"shape":"Cluster"} + } + }, + "NumberOfNodesPerClusterLimitExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"NumberOfNodesPerClusterLimitExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "NumberOfNodesQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"NumberOfNodesQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "OrderableClusterOption":{ + "type":"structure", + "members":{ + "ClusterVersion":{"shape":"String"}, + "ClusterType":{"shape":"String"}, + "NodeType":{"shape":"String"}, + "AvailabilityZones":{"shape":"AvailabilityZoneList"} + }, + "wrapper":true + }, + "OrderableClusterOptionsList":{ + "type":"list", + "member":{ + "shape":"OrderableClusterOption", + "locationName":"OrderableClusterOption" + } + }, + "OrderableClusterOptionsMessage":{ + "type":"structure", + "members":{ + "OrderableClusterOptions":{"shape":"OrderableClusterOptionsList"}, + "Marker":{"shape":"String"} + } + }, + "Parameter":{ + "type":"structure", + "members":{ + "ParameterName":{"shape":"String"}, + "ParameterValue":{"shape":"String"}, + "Description":{"shape":"String"}, + "Source":{"shape":"String"}, + "DataType":{"shape":"String"}, + "AllowedValues":{"shape":"String"}, + "ApplyType":{"shape":"ParameterApplyType"}, + "IsModifiable":{"shape":"Boolean"}, + "MinimumEngineVersion":{"shape":"String"} + } + }, + "ParameterApplyType":{ + "type":"string", + "enum":[ + "static", + "dynamic" + ] + }, + "ParameterGroupList":{ + "type":"list", + "member":{ + "shape":"ClusterParameterGroup", + "locationName":"ClusterParameterGroup" + } + }, + "ParametersList":{ + "type":"list", + "member":{ + "shape":"Parameter", + "locationName":"Parameter" + } + }, + "PendingModifiedValues":{ + "type":"structure", + "members":{ + "MasterUserPassword":{"shape":"String"}, + "NodeType":{"shape":"String"}, + "NumberOfNodes":{"shape":"IntegerOptional"}, + "ClusterType":{"shape":"String"}, + "ClusterVersion":{"shape":"String"}, + "AutomatedSnapshotRetentionPeriod":{"shape":"IntegerOptional"}, + "ClusterIdentifier":{"shape":"String"}, + "PubliclyAccessible":{"shape":"BooleanOptional"} + } + }, + "PurchaseReservedNodeOfferingMessage":{ + "type":"structure", + "required":["ReservedNodeOfferingId"], + "members":{ + "ReservedNodeOfferingId":{"shape":"String"}, + "NodeCount":{"shape":"IntegerOptional"} + } + }, + "PurchaseReservedNodeOfferingResult":{ + "type":"structure", + "members":{ + "ReservedNode":{"shape":"ReservedNode"} + } + }, + "RebootClusterMessage":{ + "type":"structure", + "required":["ClusterIdentifier"], + "members":{ + "ClusterIdentifier":{"shape":"String"} + } + }, + "RebootClusterResult":{ + "type":"structure", + "members":{ + "Cluster":{"shape":"Cluster"} + } + }, + "RecurringCharge":{ + "type":"structure", + "members":{ + "RecurringChargeAmount":{"shape":"Double"}, + "RecurringChargeFrequency":{"shape":"String"} + }, + "wrapper":true + }, + "RecurringChargeList":{ + "type":"list", + "member":{ + "shape":"RecurringCharge", + "locationName":"RecurringCharge" + } + }, + "ReservedNode":{ + "type":"structure", + "members":{ + "ReservedNodeId":{"shape":"String"}, + "ReservedNodeOfferingId":{"shape":"String"}, + "NodeType":{"shape":"String"}, + "StartTime":{"shape":"TStamp"}, + "Duration":{"shape":"Integer"}, + "FixedPrice":{"shape":"Double"}, + "UsagePrice":{"shape":"Double"}, + "CurrencyCode":{"shape":"String"}, + "NodeCount":{"shape":"Integer"}, + "State":{"shape":"String"}, + "OfferingType":{"shape":"String"}, + "RecurringCharges":{"shape":"RecurringChargeList"} + }, + "wrapper":true + }, + "ReservedNodeAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ReservedNodeAlreadyExists", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ReservedNodeList":{ + "type":"list", + "member":{ + "shape":"ReservedNode", + "locationName":"ReservedNode" + } + }, + "ReservedNodeNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ReservedNodeNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ReservedNodeOffering":{ + "type":"structure", + "members":{ + "ReservedNodeOfferingId":{"shape":"String"}, + "NodeType":{"shape":"String"}, + "Duration":{"shape":"Integer"}, + "FixedPrice":{"shape":"Double"}, + "UsagePrice":{"shape":"Double"}, + "CurrencyCode":{"shape":"String"}, + "OfferingType":{"shape":"String"}, + "RecurringCharges":{"shape":"RecurringChargeList"} + }, + "wrapper":true + }, + "ReservedNodeOfferingList":{ + "type":"list", + "member":{ + "shape":"ReservedNodeOffering", + "locationName":"ReservedNodeOffering" + } + }, + "ReservedNodeOfferingNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ReservedNodeOfferingNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ReservedNodeOfferingsMessage":{ + "type":"structure", + "members":{ + "Marker":{"shape":"String"}, + "ReservedNodeOfferings":{"shape":"ReservedNodeOfferingList"} + } + }, + "ReservedNodeQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ReservedNodeQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ReservedNodesMessage":{ + "type":"structure", + "members":{ + "Marker":{"shape":"String"}, + "ReservedNodes":{"shape":"ReservedNodeList"} + } + }, + "ResetClusterParameterGroupMessage":{ + "type":"structure", + "required":["ParameterGroupName"], + "members":{ + "ParameterGroupName":{"shape":"String"}, + "ResetAllParameters":{"shape":"Boolean"}, + "Parameters":{"shape":"ParametersList"} + } + }, + "ResizeNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ResizeNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ResizeProgressMessage":{ + "type":"structure", + "members":{ + "TargetNodeType":{"shape":"String"}, + "TargetNumberOfNodes":{"shape":"IntegerOptional"}, + "TargetClusterType":{"shape":"String"}, + "Status":{"shape":"String"}, + "ImportTablesCompleted":{"shape":"ImportTablesCompleted"}, + "ImportTablesInProgress":{"shape":"ImportTablesInProgress"}, + "ImportTablesNotStarted":{"shape":"ImportTablesNotStarted"}, + "AvgResizeRateInMegaBytesPerSecond":{"shape":"DoubleOptional"}, + "TotalResizeDataInMegaBytes":{"shape":"LongOptional"}, + "ProgressInMegaBytes":{"shape":"LongOptional"}, + "ElapsedTimeInSeconds":{"shape":"LongOptional"}, + "EstimatedTimeToCompletionInSeconds":{"shape":"LongOptional"} + } + }, + "ResourceNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ResourceNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "RestorableNodeTypeList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"NodeType" + } + }, + "RestoreFromClusterSnapshotMessage":{ + "type":"structure", + "required":[ + "ClusterIdentifier", + "SnapshotIdentifier" + ], + "members":{ + "ClusterIdentifier":{"shape":"String"}, + "SnapshotIdentifier":{"shape":"String"}, + "SnapshotClusterIdentifier":{"shape":"String"}, + "Port":{"shape":"IntegerOptional"}, + "AvailabilityZone":{"shape":"String"}, + "AllowVersionUpgrade":{"shape":"BooleanOptional"}, + "ClusterSubnetGroupName":{"shape":"String"}, + "PubliclyAccessible":{"shape":"BooleanOptional"}, + "OwnerAccount":{"shape":"String"}, + "HsmClientCertificateIdentifier":{"shape":"String"}, + "HsmConfigurationIdentifier":{"shape":"String"}, + "ElasticIp":{"shape":"String"}, + "ClusterParameterGroupName":{"shape":"String"}, + "ClusterSecurityGroups":{"shape":"ClusterSecurityGroupNameList"}, + "VpcSecurityGroupIds":{"shape":"VpcSecurityGroupIdList"}, + "PreferredMaintenanceWindow":{"shape":"String"}, + "AutomatedSnapshotRetentionPeriod":{"shape":"IntegerOptional"}, + "KmsKeyId":{"shape":"String"}, + "NodeType":{"shape":"String"}, + "AdditionalInfo":{"shape":"String"}, + "IamRoles":{"shape":"IamRoleArnList"} + } + }, + "RestoreFromClusterSnapshotResult":{ + "type":"structure", + "members":{ + "Cluster":{"shape":"Cluster"} + } + }, + "RestoreStatus":{ + "type":"structure", + "members":{ + "Status":{"shape":"String"}, + "CurrentRestoreRateInMegaBytesPerSecond":{"shape":"Double"}, + "SnapshotSizeInMegaBytes":{"shape":"Long"}, + "ProgressInMegaBytes":{"shape":"Long"}, + "ElapsedTimeInSeconds":{"shape":"Long"}, + "EstimatedTimeToCompletionInSeconds":{"shape":"Long"} + } + }, + "RestoreTableFromClusterSnapshotMessage":{ + "type":"structure", + "required":[ + "ClusterIdentifier", + "SnapshotIdentifier", + "SourceDatabaseName", + "SourceTableName", + "NewTableName" + ], + "members":{ + "ClusterIdentifier":{"shape":"String"}, + "SnapshotIdentifier":{"shape":"String"}, + "SourceDatabaseName":{"shape":"String"}, + "SourceSchemaName":{"shape":"String"}, + "SourceTableName":{"shape":"String"}, + "TargetDatabaseName":{"shape":"String"}, + "TargetSchemaName":{"shape":"String"}, + "NewTableName":{"shape":"String"} + } + }, + "RestoreTableFromClusterSnapshotResult":{ + "type":"structure", + "members":{ + "TableRestoreStatus":{"shape":"TableRestoreStatus"} + } + }, + "RevokeClusterSecurityGroupIngressMessage":{ + "type":"structure", + "required":["ClusterSecurityGroupName"], + "members":{ + "ClusterSecurityGroupName":{"shape":"String"}, + "CIDRIP":{"shape":"String"}, + "EC2SecurityGroupName":{"shape":"String"}, + "EC2SecurityGroupOwnerId":{"shape":"String"} + } + }, + "RevokeClusterSecurityGroupIngressResult":{ + "type":"structure", + "members":{ + "ClusterSecurityGroup":{"shape":"ClusterSecurityGroup"} + } + }, + "RevokeSnapshotAccessMessage":{ + "type":"structure", + "required":[ + "SnapshotIdentifier", + "AccountWithRestoreAccess" + ], + "members":{ + "SnapshotIdentifier":{"shape":"String"}, + "SnapshotClusterIdentifier":{"shape":"String"}, + "AccountWithRestoreAccess":{"shape":"String"} + } + }, + "RevokeSnapshotAccessResult":{ + "type":"structure", + "members":{ + "Snapshot":{"shape":"Snapshot"} + } + }, + "RotateEncryptionKeyMessage":{ + "type":"structure", + "required":["ClusterIdentifier"], + "members":{ + "ClusterIdentifier":{"shape":"String"} + } + }, + "RotateEncryptionKeyResult":{ + "type":"structure", + "members":{ + "Cluster":{"shape":"Cluster"} + } + }, + "SNSInvalidTopicFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SNSInvalidTopic", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "SNSNoAuthorizationFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SNSNoAuthorization", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "SNSTopicArnNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SNSTopicArnNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "Snapshot":{ + "type":"structure", + "members":{ + "SnapshotIdentifier":{"shape":"String"}, + "ClusterIdentifier":{"shape":"String"}, + "SnapshotCreateTime":{"shape":"TStamp"}, + "Status":{"shape":"String"}, + "Port":{"shape":"Integer"}, + "AvailabilityZone":{"shape":"String"}, + "ClusterCreateTime":{"shape":"TStamp"}, + "MasterUsername":{"shape":"String"}, + "ClusterVersion":{"shape":"String"}, + "SnapshotType":{"shape":"String"}, + "NodeType":{"shape":"String"}, + "NumberOfNodes":{"shape":"Integer"}, + "DBName":{"shape":"String"}, + "VpcId":{"shape":"String"}, + "Encrypted":{"shape":"Boolean"}, + "KmsKeyId":{"shape":"String"}, + "EncryptedWithHSM":{"shape":"Boolean"}, + "AccountsWithRestoreAccess":{"shape":"AccountsWithRestoreAccessList"}, + "OwnerAccount":{"shape":"String"}, + "TotalBackupSizeInMegaBytes":{"shape":"Double"}, + "ActualIncrementalBackupSizeInMegaBytes":{"shape":"Double"}, + "BackupProgressInMegaBytes":{"shape":"Double"}, + "CurrentBackupRateInMegaBytesPerSecond":{"shape":"Double"}, + "EstimatedSecondsToCompletion":{"shape":"Long"}, + "ElapsedTimeInSeconds":{"shape":"Long"}, + "SourceRegion":{"shape":"String"}, + "Tags":{"shape":"TagList"}, + "RestorableNodeTypes":{"shape":"RestorableNodeTypeList"} + }, + "wrapper":true + }, + "SnapshotCopyAlreadyDisabledFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SnapshotCopyAlreadyDisabledFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "SnapshotCopyAlreadyEnabledFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SnapshotCopyAlreadyEnabledFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "SnapshotCopyDisabledFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SnapshotCopyDisabledFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "SnapshotCopyGrant":{ + "type":"structure", + "members":{ + "SnapshotCopyGrantName":{"shape":"String"}, + "KmsKeyId":{"shape":"String"}, + "Tags":{"shape":"TagList"} + }, + "wrapper":true + }, + "SnapshotCopyGrantAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SnapshotCopyGrantAlreadyExistsFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "SnapshotCopyGrantList":{ + "type":"list", + "member":{ + "shape":"SnapshotCopyGrant", + "locationName":"SnapshotCopyGrant" + } + }, + "SnapshotCopyGrantMessage":{ + "type":"structure", + "members":{ + "Marker":{"shape":"String"}, + "SnapshotCopyGrants":{"shape":"SnapshotCopyGrantList"} + } + }, + "SnapshotCopyGrantNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SnapshotCopyGrantNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "SnapshotCopyGrantQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SnapshotCopyGrantQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "SnapshotList":{ + "type":"list", + "member":{ + "shape":"Snapshot", + "locationName":"Snapshot" + } + }, + "SnapshotMessage":{ + "type":"structure", + "members":{ + "Marker":{"shape":"String"}, + "Snapshots":{"shape":"SnapshotList"} + } + }, + "SourceIdsList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SourceId" + } + }, + "SourceNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SourceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "SourceType":{ + "type":"string", + "enum":[ + "cluster", + "cluster-parameter-group", + "cluster-security-group", + "cluster-snapshot" + ] + }, + "String":{"type":"string"}, + "Subnet":{ + "type":"structure", + "members":{ + "SubnetIdentifier":{"shape":"String"}, + "SubnetAvailabilityZone":{"shape":"AvailabilityZone"}, + "SubnetStatus":{"shape":"String"} + } + }, + "SubnetAlreadyInUse":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SubnetAlreadyInUse", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "SubnetIdentifierList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SubnetIdentifier" + } + }, + "SubnetList":{ + "type":"list", + "member":{ + "shape":"Subnet", + "locationName":"Subnet" + } + }, + "SubscriptionAlreadyExistFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SubscriptionAlreadyExist", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "SubscriptionCategoryNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SubscriptionCategoryNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "SubscriptionEventIdNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SubscriptionEventIdNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "SubscriptionNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SubscriptionNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "SubscriptionSeverityNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SubscriptionSeverityNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "TStamp":{"type":"timestamp"}, + "TableRestoreNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"TableRestoreNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "TableRestoreStatus":{ + "type":"structure", + "members":{ + "TableRestoreRequestId":{"shape":"String"}, + "Status":{"shape":"TableRestoreStatusType"}, + "Message":{"shape":"String"}, + "RequestTime":{"shape":"TStamp"}, + "ProgressInMegaBytes":{"shape":"LongOptional"}, + "TotalDataInMegaBytes":{"shape":"LongOptional"}, + "ClusterIdentifier":{"shape":"String"}, + "SnapshotIdentifier":{"shape":"String"}, + "SourceDatabaseName":{"shape":"String"}, + "SourceSchemaName":{"shape":"String"}, + "SourceTableName":{"shape":"String"}, + "TargetDatabaseName":{"shape":"String"}, + "TargetSchemaName":{"shape":"String"}, + "NewTableName":{"shape":"String"} + }, + "wrapper":true + }, + "TableRestoreStatusList":{ + "type":"list", + "member":{ + "shape":"TableRestoreStatus", + "locationName":"TableRestoreStatus" + } + }, + "TableRestoreStatusMessage":{ + "type":"structure", + "members":{ + "TableRestoreStatusDetails":{"shape":"TableRestoreStatusList"}, + "Marker":{"shape":"String"} + } + }, + "TableRestoreStatusType":{ + "type":"string", + "enum":[ + "PENDING", + "IN_PROGRESS", + "SUCCEEDED", + "FAILED", + "CANCELED" + ] + }, + "Tag":{ + "type":"structure", + "members":{ + "Key":{"shape":"String"}, + "Value":{"shape":"String"} + } + }, + "TagKeyList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"TagKey" + } + }, + "TagLimitExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"TagLimitExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "TagList":{ + "type":"list", + "member":{ + "shape":"Tag", + "locationName":"Tag" + } + }, + "TagValueList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"TagValue" + } + }, + "TaggedResource":{ + "type":"structure", + "members":{ + "Tag":{"shape":"Tag"}, + "ResourceName":{"shape":"String"}, + "ResourceType":{"shape":"String"} + } + }, + "TaggedResourceList":{ + "type":"list", + "member":{ + "shape":"TaggedResource", + "locationName":"TaggedResource" + } + }, + "TaggedResourceListMessage":{ + "type":"structure", + "members":{ + "TaggedResources":{"shape":"TaggedResourceList"}, + "Marker":{"shape":"String"} + } + }, + "UnauthorizedOperation":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"UnauthorizedOperation", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "UnknownSnapshotCopyRegionFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"UnknownSnapshotCopyRegionFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "UnsupportedOperationFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"UnsupportedOperation", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "UnsupportedOptionFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"UnsupportedOptionFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "VpcSecurityGroupIdList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"VpcSecurityGroupId" + } + }, + "VpcSecurityGroupMembership":{ + "type":"structure", + "members":{ + "VpcSecurityGroupId":{"shape":"String"}, + "Status":{"shape":"String"} + } + }, + "VpcSecurityGroupMembershipList":{ + "type":"list", + "member":{ + "shape":"VpcSecurityGroupMembership", + "locationName":"VpcSecurityGroup" + } + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/redshift/2012-12-01/docs-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/redshift/2012-12-01/docs-2.json new file mode 100644 index 000000000..221b5c124 --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/redshift/2012-12-01/docs-2.json @@ -0,0 +1,2135 @@ +{ + "version": "2.0", + "service": "This is an interface reference for Amazon Redshift. It contains documentation for one of the programming or command line interfaces you can use to manage Amazon Redshift clusters. Note that Amazon Redshift is asynchronous, which means that some interfaces may require techniques, such as polling or asynchronous callback handlers, to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a change is applied immediately, on the next instance reboot, or during the next maintenance window. For a summary of the Amazon Redshift cluster management interfaces, go to Using the Amazon Redshift Management Interfaces .
Amazon Redshift manages all the work of setting up, operating, and scaling a data warehouse: provisioning capacity, monitoring and backing up the cluster, and applying patches and upgrades to the Amazon Redshift engine. You can focus on using your data to acquire new insights for your business and customers.
If you are a first-time user of Amazon Redshift, we recommend that you begin by reading the The Amazon Redshift Getting Started Guide
If you are a database developer, the Amazon Redshift Database Developer Guide explains how to design, build, query, and maintain the databases that make up your data warehouse.
", + "operations": { + "AuthorizeClusterSecurityGroupIngress": "Adds an inbound (ingress) rule to an Amazon Redshift security group. Depending on whether the application accessing your cluster is running on the Internet or an Amazon EC2 instance, you can authorize inbound access to either a Classless Interdomain Routing (CIDR)/Internet Protocol (IP) range or to an Amazon EC2 security group. You can add as many as 20 ingress rules to an Amazon Redshift security group.
If you authorize access to an Amazon EC2 security group, specify EC2SecurityGroupName and EC2SecurityGroupOwnerId. The Amazon EC2 security group and Amazon Redshift cluster must be in the same AWS region.
If you authorize access to a CIDR/IP address range, specify CIDRIP. For an overview of CIDR blocks, see the Wikipedia article on Classless Inter-Domain Routing.
You must also associate the security group with a cluster so that clients running on these IP addresses or the EC2 instance are authorized to connect to the cluster. For information about managing security groups, go to Working with Security Groups in the Amazon Redshift Cluster Management Guide.
", + "AuthorizeSnapshotAccess": "Authorizes the specified AWS customer account to restore the specified snapshot.
For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.
", + "CopyClusterSnapshot": "Copies the specified automated cluster snapshot to a new manual cluster snapshot. The source must be an automated snapshot and it must be in the available state.
When you delete a cluster, Amazon Redshift deletes any automated snapshots of the cluster. Also, when the retention period of the snapshot expires, Amazon Redshift automatically deletes it. If you want to keep an automated snapshot for a longer period, you can make a manual copy of the snapshot. Manual snapshots are retained until you delete them.
For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.
", + "CreateCluster": "Creates a new cluster. To create the cluster in virtual private cloud (VPC), you must provide cluster subnet group name. If you don't provide a cluster subnet group name or the cluster security group parameter, Amazon Redshift creates a non-VPC cluster, it associates the default cluster security group with the cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide .
", + "CreateClusterParameterGroup": "Creates an Amazon Redshift parameter group.
Creating parameter groups is independent of creating clusters. You can associate a cluster with a parameter group when you create the cluster. You can also associate an existing cluster with a parameter group after the cluster is created by using ModifyCluster.
Parameters in the parameter group define specific behavior that applies to the databases you create on the cluster. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
", + "CreateClusterSecurityGroup": "Creates a new Amazon Redshift security group. You use security groups to control access to non-VPC clusters.
For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.
", + "CreateClusterSnapshot": " Creates a manual snapshot of the specified cluster. The cluster must be in the available state.
For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.
", + "CreateClusterSubnetGroup": "Creates a new Amazon Redshift subnet group. You must provide a list of one or more subnets in your existing Amazon Virtual Private Cloud (Amazon VPC) when creating Amazon Redshift subnet group.
For information about subnet groups, go to Amazon Redshift Cluster Subnet Groups in the Amazon Redshift Cluster Management Guide.
", + "CreateEventSubscription": "Creates an Amazon Redshift event notification subscription. This action requires an ARN (Amazon Resource Name) of an Amazon SNS topic created by either the Amazon Redshift console, the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.
You can specify the source type, and lists of Amazon Redshift source IDs, event categories, and event severities. Notifications will be sent for all events you want that match those criteria. For example, you can specify source type = cluster, source ID = my-cluster-1 and mycluster2, event categories = Availability, Backup, and severity = ERROR. The subscription will only send notifications for those ERROR events in the Availability and Backup categories for the specified clusters.
If you specify both the source type and source IDs, such as source type = cluster and source identifier = my-cluster-1, notifications will be sent for all the cluster events for my-cluster-1. If you specify a source type but do not specify a source identifier, you will receive notice of the events for the objects of that type in your AWS account. If you do not specify either the SourceType nor the SourceIdentifier, you will be notified of events generated from all Amazon Redshift sources belonging to your AWS account. You must specify a source type if you specify a source ID.
", + "CreateHsmClientCertificate": "Creates an HSM client certificate that an Amazon Redshift cluster will use to connect to the client's HSM in order to store and retrieve the keys used to encrypt the cluster databases.
The command returns a public key, which you must store in the HSM. In addition to creating the HSM certificate, you must create an Amazon Redshift HSM configuration that provides a cluster the information needed to store and use encryption keys in the HSM. For more information, go to Hardware Security Modules in the Amazon Redshift Cluster Management Guide.
", + "CreateHsmConfiguration": "Creates an HSM configuration that contains the information required by an Amazon Redshift cluster to store and use database encryption keys in a Hardware Security Module (HSM). After creating the HSM configuration, you can specify it as a parameter when creating a cluster. The cluster will then store its encryption keys in the HSM.
In addition to creating an HSM configuration, you must also create an HSM client certificate. For more information, go to Hardware Security Modules in the Amazon Redshift Cluster Management Guide.
", + "CreateSnapshotCopyGrant": "Creates a snapshot copy grant that permits Amazon Redshift to use a customer master key (CMK) from AWS Key Management Service (AWS KMS) to encrypt copied snapshots in a destination region.
For more information about managing snapshot copy grants, go to Amazon Redshift Database Encryption in the Amazon Redshift Cluster Management Guide.
", + "CreateTags": "Adds one or more tags to a specified resource.
A resource can have up to 10 tags. If you try to create more than 10 tags for a resource, you will receive an error and the attempt will fail.
If you specify a key that already exists for the resource, the value for that key will be updated with the new value.
", + "DeleteCluster": "Deletes a previously provisioned cluster. A successful response from the web service indicates that the request was received correctly. Use DescribeClusters to monitor the status of the deletion. The delete operation cannot be canceled or reverted once submitted. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide .
If you want to shut down the cluster and retain it for future use, set SkipFinalClusterSnapshot to false and specify a name for FinalClusterSnapshotIdentifier. You can later restore this snapshot to resume using the cluster. If a final cluster snapshot is requested, the status of the cluster will be \"final-snapshot\" while the snapshot is being taken, then it's \"deleting\" once Amazon Redshift begins deleting the cluster.
For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide .
", + "DeleteClusterParameterGroup": " Deletes a specified Amazon Redshift parameter group.
Deletes an Amazon Redshift security group.
For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.
", + "DeleteClusterSnapshot": " Deletes the specified manual snapshot. The snapshot must be in the available state, with no other users authorized to access the snapshot.
Unlike automated snapshots, manual snapshots are retained even after you delete your cluster. Amazon Redshift does not delete your manual snapshots. You must delete manual snapshot explicitly to avoid getting charged. If other accounts are authorized to access the snapshot, you must revoke all of the authorizations before you can delete the snapshot.
", + "DeleteClusterSubnetGroup": "Deletes the specified cluster subnet group.
", + "DeleteEventSubscription": "Deletes an Amazon Redshift event notification subscription.
", + "DeleteHsmClientCertificate": "Deletes the specified HSM client certificate.
", + "DeleteHsmConfiguration": "Deletes the specified Amazon Redshift HSM configuration.
", + "DeleteSnapshotCopyGrant": "Deletes the specified snapshot copy grant.
", + "DeleteTags": "Deletes a tag or tags from a resource. You must provide the ARN of the resource from which you want to delete the tag or tags.
", + "DescribeClusterParameterGroups": "Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default parameter group. For each parameter group, the response includes the parameter group name, description, and parameter group family name. You can optionally specify a name to retrieve the description of a specific parameter group.
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all parameter groups that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all parameter groups that have any combination of those values are returned.
If both tag keys and values are omitted from the request, parameter groups are returned regardless of whether they have tag keys or values associated with them.
", + "DescribeClusterParameters": "Returns a detailed list of parameters contained within the specified Amazon Redshift parameter group. For each parameter the response includes information such as parameter name, description, data type, value, whether the parameter value is modifiable, and so on.
You can specify source filter to retrieve parameters of only specific type. For example, to retrieve parameters that were modified by a user action such as from ModifyClusterParameterGroup, you can specify source equal to user.
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
", + "DescribeClusterSecurityGroups": "Returns information about Amazon Redshift security groups. If the name of a security group is specified, the response will contain only information about only that security group.
For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all security groups that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all security groups that have any combination of those values are returned.
If both tag keys and values are omitted from the request, security groups are returned regardless of whether they have tag keys or values associated with them.
", + "DescribeClusterSnapshots": "Returns one or more snapshot objects, which contain metadata about your cluster snapshots. By default, this operation returns information about all snapshots of all clusters that are owned by you AWS customer account. No information is returned for snapshots owned by inactive AWS customer accounts.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all snapshots that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all snapshots that have any combination of those values are returned. Only snapshots that you own are returned in the response; shared snapshots are not returned with the tag key and tag value request parameters.
If both tag keys and values are omitted from the request, snapshots are returned regardless of whether they have tag keys or values associated with them.
", + "DescribeClusterSubnetGroups": "Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups. By default, this operation returns information about all cluster subnet groups that are defined in you AWS account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all subnet groups that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all subnet groups that have any combination of those values are returned.
If both tag keys and values are omitted from the request, subnet groups are returned regardless of whether they have tag keys or values associated with them.
", + "DescribeClusterVersions": "Returns descriptions of the available Amazon Redshift cluster versions. You can call this operation even before creating any clusters to learn more about the Amazon Redshift versions. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide
", + "DescribeClusters": "Returns properties of provisioned clusters including general cluster properties, cluster database properties, maintenance and backup properties, and security and access properties. This operation supports pagination. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide .
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all clusters that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all clusters that have any combination of those values are returned.
If both tag keys and values are omitted from the request, clusters are returned regardless of whether they have tag keys or values associated with them.
", + "DescribeDefaultClusterParameters": "Returns a list of parameter settings for the specified parameter group family.
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
", + "DescribeEventCategories": "Displays a list of event categories for all event source types, or for a specified source type. For a list of the event categories and source types, go to Amazon Redshift Event Notifications.
", + "DescribeEventSubscriptions": "Lists descriptions of all the Amazon Redshift event notifications subscription for a customer account. If you specify a subscription name, lists the description for that subscription.
", + "DescribeEvents": "Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days. Events specific to a particular cluster, security group, snapshot or parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.
", + "DescribeHsmClientCertificates": "Returns information about the specified HSM client certificate. If no certificate ID is specified, returns information about all the HSM certificates owned by your AWS customer account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM client certificates that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all HSM client certificates that have any combination of those values are returned.
If both tag keys and values are omitted from the request, HSM client certificates are returned regardless of whether they have tag keys or values associated with them.
", + "DescribeHsmConfigurations": "Returns information about the specified Amazon Redshift HSM configuration. If no configuration ID is specified, returns information about all the HSM configurations owned by your AWS customer account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM connections that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all HSM connections that have any combination of those values are returned.
If both tag keys and values are omitted from the request, HSM connections are returned regardless of whether they have tag keys or values associated with them.
", + "DescribeLoggingStatus": "Describes whether information, such as queries and connection attempts, is being logged for the specified Amazon Redshift cluster.
", + "DescribeOrderableClusterOptions": "Returns a list of orderable cluster options. Before you create a new cluster you can use this operation to find what options are available, such as the EC2 Availability Zones (AZ) in the specific AWS region that you can specify, and the node types you can request. The node types differ by available storage, memory, CPU and price. With the cost involved you might want to obtain a list of cluster options in the specific region and specify values when creating a cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide
", + "DescribeReservedNodeOfferings": "Returns a list of the available reserved node offerings by Amazon Redshift with their descriptions including the node type, the fixed and recurring costs of reserving the node and duration the node will be reserved for you. These descriptions help you determine which reserve node offering you want to purchase. You then use the unique offering ID in you call to PurchaseReservedNodeOffering to reserve one or more nodes for your Amazon Redshift cluster.
For more information about reserved node offerings, go to Purchasing Reserved Nodes in the Amazon Redshift Cluster Management Guide.
", + "DescribeReservedNodes": "Returns the descriptions of the reserved nodes.
", + "DescribeResize": " Returns information about the last resize operation for the specified cluster. If no resize operation has ever been initiated for the specified cluster, a HTTP 404 error is returned. If a resize operation was initiated and completed, the status of the resize remains as SUCCEEDED until the next resize.
A resize operation can be requested using ModifyCluster and specifying a different number or type of nodes for the cluster.
", + "DescribeSnapshotCopyGrants": "Returns a list of snapshot copy grants owned by the AWS account in the destination region.
For more information about managing snapshot copy grants, go to Amazon Redshift Database Encryption in the Amazon Redshift Cluster Management Guide.
", + "DescribeTableRestoreStatus": "Lists the status of one or more table restore requests made using the RestoreTableFromClusterSnapshot API action. If you don't specify a value for the TableRestoreRequestId parameter, then DescribeTableRestoreStatus returns the status of all table restore requests ordered by the date and time of the request in ascending order. Otherwise DescribeTableRestoreStatus returns the status of the table specified by TableRestoreRequestId.
Returns a list of tags. You can return tags from a specific resource by specifying an ARN, or you can return all tags for a given type of resource, such as clusters, snapshots, and so on.
The following are limitations for DescribeTags:
MaxRecords and Marker parameters together with the ARN parameter.MaxRecords parameter can be a range from 10 to 50 results to return in a request.If you specify both tag keys and tag values in the same request, Amazon Redshift returns all resources that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all resources that have any combination of those values are returned.
If both tag keys and values are omitted from the request, resources are returned regardless of whether they have tag keys or values associated with them.
", + "DisableLogging": "Stops logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
", + "DisableSnapshotCopy": "Disables the automatic copying of snapshots from one region to another region for a specified cluster.
If your cluster and its snapshots are encrypted using a customer master key (CMK) from AWS KMS, use DeleteSnapshotCopyGrant to delete the grant that grants Amazon Redshift permission to the CMK in the destination region.
", + "EnableLogging": "Starts logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
", + "EnableSnapshotCopy": "Enables the automatic copy of snapshots from one region to another region for a specified cluster.
", + "ModifyCluster": "Modifies the settings for a cluster. For example, you can add another security or parameter group, update the preferred maintenance window, or change the master user password. Resetting a cluster password or modifying the security groups associated with a cluster do not need a reboot. However, modifying a parameter group requires a reboot for parameters to take effect. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide .
You can also change node type and the number of nodes to scale up or down the cluster. When resizing a cluster, you must specify both the number of nodes and the node type even if one of the parameters does not change.
", + "ModifyClusterIamRoles": "Modifies the list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.
A cluster can have up to 10 IAM roles associated at any time.
", + "ModifyClusterParameterGroup": "Modifies the parameters of a parameter group.
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
", + "ModifyClusterSubnetGroup": "Modifies a cluster subnet group to include the specified list of VPC subnets. The operation replaces the existing list of subnets with the new list of subnets.
", + "ModifyEventSubscription": "Modifies an existing Amazon Redshift event notification subscription.
", + "ModifySnapshotCopyRetentionPeriod": "Modifies the number of days to retain automated snapshots in the destination region after they are copied from the source region.
", + "PurchaseReservedNodeOffering": "Allows you to purchase reserved nodes. Amazon Redshift offers a predefined set of reserved node offerings. You can purchase one or more of the offerings. You can call the DescribeReservedNodeOfferings API to obtain the available reserved node offerings. You can call this API by providing a specific reserved node offering and the number of nodes you want to reserve.
For more information about reserved node offerings, go to Purchasing Reserved Nodes in the Amazon Redshift Cluster Management Guide.
", + "RebootCluster": " Reboots a cluster. This action is taken as soon as possible. It results in a momentary outage to the cluster, during which the cluster status is set to rebooting. A cluster event is created when the reboot is completed. Any pending cluster modifications (see ModifyCluster) are applied at this reboot. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide
Sets one or more parameters of the specified parameter group to their default values and sets the source values of the parameters to \"engine-default\". To reset the entire parameter group specify the ResetAllParameters parameter. For parameter changes to take effect you must reboot any associated clusters.
", + "RestoreFromClusterSnapshot": "Creates a new cluster from a snapshot. By default, Amazon Redshift creates the resulting cluster with the same configuration as the original cluster from which the snapshot was created, except that the new cluster is created with the default cluster security and parameter groups. After Amazon Redshift creates the cluster, you can use the ModifyCluster API to associate a different security group and different parameter group with the restored cluster. If you are using a DS node type, you can also choose to change to another DS node type of the same size during restore.
If you restore a cluster into a VPC, you must provide a cluster subnet group where you want the cluster restored.
For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.
", + "RestoreTableFromClusterSnapshot": "Creates a new table from a table in an Amazon Redshift cluster snapshot. You must create the new table within the Amazon Redshift cluster that the snapshot was taken from.
You cannot use RestoreTableFromClusterSnapshot to restore a table with the same name as an existing table in an Amazon Redshift cluster. That is, you cannot overwrite an existing table in a cluster with a restored table. If you want to replace your original table with a new, restored table, then rename or drop your original table before you call RestoreTableFromClusterSnapshot. When you have renamed your original table, then you can pass the original name of the table as the NewTableName parameter value in the call to RestoreTableFromClusterSnapshot. This way, you can replace the original table with the table created from the snapshot.
Revokes an ingress rule in an Amazon Redshift security group for a previously authorized IP range or Amazon EC2 security group. To add an ingress rule, see AuthorizeClusterSecurityGroupIngress. For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.
", + "RevokeSnapshotAccess": "Removes the ability of the specified AWS customer account to restore the specified snapshot. If the account is currently restoring the snapshot, the restore will run to completion.
For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.
", + "RotateEncryptionKey": "Rotates the encryption keys for a cluster.
" + }, + "shapes": { + "AccessToSnapshotDeniedFault": { + "base": "The owner of the specified snapshot has not authorized your account to access the snapshot.
", + "refs": { + } + }, + "AccountWithRestoreAccess": { + "base": "Describes an AWS customer account authorized to restore a snapshot.
", + "refs": { + "AccountsWithRestoreAccessList$member": null + } + }, + "AccountsWithRestoreAccessList": { + "base": null, + "refs": { + "Snapshot$AccountsWithRestoreAccess": " A list of the AWS customer accounts authorized to restore the snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner.
The specified CIDR block or EC2 security group is already authorized for the specified cluster security group.
", + "refs": { + } + }, + "AuthorizationNotFoundFault": { + "base": "The specified CIDR IP range or EC2 security group is not authorized for the specified cluster security group.
", + "refs": { + } + }, + "AuthorizationQuotaExceededFault": { + "base": "The authorization quota for the cluster security group has been reached.
", + "refs": { + } + }, + "AuthorizeClusterSecurityGroupIngressMessage": { + "base": "", + "refs": { + } + }, + "AuthorizeClusterSecurityGroupIngressResult": { + "base": null, + "refs": { + } + }, + "AuthorizeSnapshotAccessMessage": { + "base": "", + "refs": { + } + }, + "AuthorizeSnapshotAccessResult": { + "base": null, + "refs": { + } + }, + "AvailabilityZone": { + "base": "
Describes an availability zone.
", + "refs": { + "AvailabilityZoneList$member": null, + "Subnet$SubnetAvailabilityZone": null + } + }, + "AvailabilityZoneList": { + "base": null, + "refs": { + "OrderableClusterOption$AvailabilityZones": "A list of availability zones for the orderable cluster.
" + } + }, + "Boolean": { + "base": null, + "refs": { + "Cluster$AllowVersionUpgrade": " If true, major version upgrades will be applied automatically to the cluster during the maintenance window.
If true, the cluster can be accessed from a public network.
If true, data in the cluster is encrypted at rest.
Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster. If true, a final cluster snapshot is not created. If false, a final cluster snapshot is created before the cluster is deleted.
false.Default: false
A Boolean value indicating whether the subscription is enabled. true indicates the subscription is enabled.
true if logging is on, false if logging is off.
If true, the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
If true, all parameters in the specified parameter group will be reset to their default values.
Default: true
If true, the data in the snapshot is encrypted at rest.
A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster. true indicates that the data is encrypted using HSM keys.
If true, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.
When a new major version of the Amazon Redshift engine is released, you can request that the service automatically apply upgrades during the maintenance window to the Amazon Redshift engine that is running on your cluster.
Default: true
If true, the cluster can be accessed from a public network.
If true, the data in the cluster is encrypted at rest.
Default: false
", + "CreateEventSubscriptionMessage$Enabled": " A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.
If true, major version upgrades will be applied automatically to the cluster during the maintenance window.
Default: false
If true, the cluster can be accessed from a public network. Only clusters in VPCs can be set to be publicly available.
A Boolean value indicating if the subscription is enabled. true indicates the subscription is enabled
The pending or in-progress change of the ability to connect to the cluster from the public network.
", + "RestoreFromClusterSnapshotMessage$AllowVersionUpgrade": "If true, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.
Default: true
If true, the cluster can be accessed from a public network.
Could not find the specified S3 bucket.
", + "refs": { + } + }, + "Cluster": { + "base": "Describes a cluster.
", + "refs": { + "ClusterList$member": null, + "CreateClusterResult$Cluster": null, + "DeleteClusterResult$Cluster": null, + "DisableSnapshotCopyResult$Cluster": null, + "EnableSnapshotCopyResult$Cluster": null, + "ModifyClusterIamRolesResult$Cluster": null, + "ModifyClusterResult$Cluster": null, + "ModifySnapshotCopyRetentionPeriodResult$Cluster": null, + "RebootClusterResult$Cluster": null, + "RestoreFromClusterSnapshotResult$Cluster": null, + "RotateEncryptionKeyResult$Cluster": null + } + }, + "ClusterAlreadyExistsFault": { + "base": "The account already has a cluster with the given identifier.
", + "refs": { + } + }, + "ClusterIamRole": { + "base": "An AWS Identity and Access Management (IAM) role that can be used by the associated Amazon Redshift cluster to access other AWS services.
", + "refs": { + "ClusterIamRoleList$member": null + } + }, + "ClusterIamRoleList": { + "base": null, + "refs": { + "Cluster$IamRoles": "A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.
" + } + }, + "ClusterList": { + "base": null, + "refs": { + "ClustersMessage$Clusters": " A list of Cluster objects, where each object describes one cluster.
The identifier of a node in a cluster.
", + "refs": { + "ClusterNodesList$member": null + } + }, + "ClusterNodesList": { + "base": null, + "refs": { + "Cluster$ClusterNodes": "The nodes in a cluster.
" + } + }, + "ClusterNotFoundFault": { + "base": " The ClusterIdentifier parameter does not refer to an existing cluster.
Describes a parameter group.
", + "refs": { + "CreateClusterParameterGroupResult$ClusterParameterGroup": null, + "ParameterGroupList$member": null + } + }, + "ClusterParameterGroupAlreadyExistsFault": { + "base": "A cluster parameter group with the same name already exists.
", + "refs": { + } + }, + "ClusterParameterGroupDetails": { + "base": "Contains the output from the DescribeClusterParameters action.
", + "refs": { + } + }, + "ClusterParameterGroupNameMessage": { + "base": "", + "refs": { + } + }, + "ClusterParameterGroupNotFoundFault": { + "base": "
The parameter group name does not refer to an existing parameter group.
", + "refs": { + } + }, + "ClusterParameterGroupQuotaExceededFault": { + "base": "The request would result in the user exceeding the allowed number of cluster parameter groups. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
", + "refs": { + } + }, + "ClusterParameterGroupStatus": { + "base": "Describes the status of a parameter group.
", + "refs": { + "ClusterParameterGroupStatusList$member": null + } + }, + "ClusterParameterGroupStatusList": { + "base": null, + "refs": { + "Cluster$ClusterParameterGroups": "The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.
" + } + }, + "ClusterParameterGroupsMessage": { + "base": "Contains the output from the DescribeClusterParameterGroups action.
", + "refs": { + } + }, + "ClusterParameterStatus": { + "base": "Describes the status of a parameter group.
", + "refs": { + "ClusterParameterStatusList$member": null + } + }, + "ClusterParameterStatusList": { + "base": null, + "refs": { + "ClusterParameterGroupStatus$ClusterParameterStatusList": "The list of parameter statuses.
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
" + } + }, + "ClusterQuotaExceededFault": { + "base": "The request would exceed the allowed number of cluster instances for this account. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
", + "refs": { + } + }, + "ClusterSecurityGroup": { + "base": "Describes a security group.
", + "refs": { + "AuthorizeClusterSecurityGroupIngressResult$ClusterSecurityGroup": null, + "ClusterSecurityGroups$member": null, + "CreateClusterSecurityGroupResult$ClusterSecurityGroup": null, + "RevokeClusterSecurityGroupIngressResult$ClusterSecurityGroup": null + } + }, + "ClusterSecurityGroupAlreadyExistsFault": { + "base": "A cluster security group with the same name already exists.
", + "refs": { + } + }, + "ClusterSecurityGroupMembership": { + "base": "Describes a cluster security group.
", + "refs": { + "ClusterSecurityGroupMembershipList$member": null + } + }, + "ClusterSecurityGroupMembershipList": { + "base": null, + "refs": { + "Cluster$ClusterSecurityGroups": " A list of cluster security group that are associated with the cluster. Each security group is represented by an element that contains ClusterSecurityGroup.Name and ClusterSecurityGroup.Status subelements.
Cluster security groups are used when the cluster is not created in a VPC. Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.
" + } + }, + "ClusterSecurityGroupMessage": { + "base": "", + "refs": { + } + }, + "ClusterSecurityGroupNameList": { + "base": null, + "refs": { + "CreateClusterMessage$ClusterSecurityGroups": "
A list of security groups to be associated with this cluster.
Default: The default cluster security group for Amazon Redshift.
", + "ModifyClusterMessage$ClusterSecurityGroups": "A list of cluster security groups to be authorized on this cluster. This change is asynchronously applied as soon as possible.
Security groups currently associated with the cluster, and not in the list of groups to apply, will be revoked from the cluster.
Constraints:
A list of security groups to be associated with this cluster.
Default: The default cluster security group for Amazon Redshift.
Cluster security groups only apply to clusters outside of VPCs.
" + } + }, + "ClusterSecurityGroupNotFoundFault": { + "base": "The cluster security group name does not refer to an existing cluster security group.
", + "refs": { + } + }, + "ClusterSecurityGroupQuotaExceededFault": { + "base": "The request would result in the user exceeding the allowed number of cluster security groups. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
", + "refs": { + } + }, + "ClusterSecurityGroups": { + "base": null, + "refs": { + "ClusterSecurityGroupMessage$ClusterSecurityGroups": "A list of ClusterSecurityGroup instances.
" + } + }, + "ClusterSnapshotAlreadyExistsFault": { + "base": "The value specified as a snapshot identifier is already used by an existing snapshot.
", + "refs": { + } + }, + "ClusterSnapshotCopyStatus": { + "base": "Returns the destination region and retention period that are configured for cross-region snapshot copy.
", + "refs": { + "Cluster$ClusterSnapshotCopyStatus": "Returns the destination region and retention period that are configured for cross-region snapshot copy.
" + } + }, + "ClusterSnapshotNotFoundFault": { + "base": "The snapshot identifier does not refer to an existing cluster snapshot.
", + "refs": { + } + }, + "ClusterSnapshotQuotaExceededFault": { + "base": "The request would result in the user exceeding the allowed number of cluster snapshots.
", + "refs": { + } + }, + "ClusterSubnetGroup": { + "base": "Describes a subnet group.
", + "refs": { + "ClusterSubnetGroups$member": null, + "CreateClusterSubnetGroupResult$ClusterSubnetGroup": null, + "ModifyClusterSubnetGroupResult$ClusterSubnetGroup": null + } + }, + "ClusterSubnetGroupAlreadyExistsFault": { + "base": "A ClusterSubnetGroupName is already used by an existing cluster subnet group.
", + "refs": { + } + }, + "ClusterSubnetGroupMessage": { + "base": "Contains the output from the DescribeClusterSubnetGroups action.
", + "refs": { + } + }, + "ClusterSubnetGroupNotFoundFault": { + "base": "The cluster subnet group name does not refer to an existing cluster subnet group.
", + "refs": { + } + }, + "ClusterSubnetGroupQuotaExceededFault": { + "base": "The request would result in user exceeding the allowed number of cluster subnet groups. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
", + "refs": { + } + }, + "ClusterSubnetGroups": { + "base": null, + "refs": { + "ClusterSubnetGroupMessage$ClusterSubnetGroups": "A list of ClusterSubnetGroup instances.
" + } + }, + "ClusterSubnetQuotaExceededFault": { + "base": "The request would result in user exceeding the allowed number of subnets in a cluster subnet groups. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
", + "refs": { + } + }, + "ClusterVersion": { + "base": "Describes a cluster version, including the parameter group family and description of the version.
", + "refs": { + "ClusterVersionList$member": null + } + }, + "ClusterVersionList": { + "base": null, + "refs": { + "ClusterVersionsMessage$ClusterVersions": " A list of Version elements.
Contains the output from the DescribeClusterVersions action.
", + "refs": { + } + }, + "ClustersMessage": { + "base": "Contains the output from the DescribeClusters action.
", + "refs": { + } + }, + "CopyClusterSnapshotMessage": { + "base": "", + "refs": { + } + }, + "CopyClusterSnapshotResult": { + "base": null, + "refs": { + } + }, + "CopyToRegionDisabledFault": { + "base": "
Cross-region snapshot copy was temporarily disabled. Try your request again.
", + "refs": { + } + }, + "CreateClusterMessage": { + "base": "", + "refs": { + } + }, + "CreateClusterParameterGroupMessage": { + "base": "", + "refs": { + } + }, + "CreateClusterParameterGroupResult": { + "base": null, + "refs": { + } + }, + "CreateClusterResult": { + "base": null, + "refs": { + } + }, + "CreateClusterSecurityGroupMessage": { + "base": "", + "refs": { + } + }, + "CreateClusterSecurityGroupResult": { + "base": null, + "refs": { + } + }, + "CreateClusterSnapshotMessage": { + "base": "
", + "refs": { + } + }, + "CreateClusterSnapshotResult": { + "base": null, + "refs": { + } + }, + "CreateClusterSubnetGroupMessage": { + "base": "
", + "refs": { + } + }, + "CreateClusterSubnetGroupResult": { + "base": null, + "refs": { + } + }, + "CreateEventSubscriptionMessage": { + "base": "", + "refs": { + } + }, + "CreateEventSubscriptionResult": { + "base": null, + "refs": { + } + }, + "CreateHsmClientCertificateMessage": { + "base": "", + "refs": { + } + }, + "CreateHsmClientCertificateResult": { + "base": null, + "refs": { + } + }, + "CreateHsmConfigurationMessage": { + "base": "", + "refs": { + } + }, + "CreateHsmConfigurationResult": { + "base": null, + "refs": { + } + }, + "CreateSnapshotCopyGrantMessage": { + "base": "
The result of the CreateSnapshotCopyGrant action.
Contains the output from the CreateTags action.
Describes the default cluster parameters for a parameter group family.
", + "refs": { + "DescribeDefaultClusterParametersResult$DefaultClusterParameters": null + } + }, + "DeleteClusterMessage": { + "base": "", + "refs": { + } + }, + "DeleteClusterParameterGroupMessage": { + "base": "
", + "refs": { + } + }, + "DeleteClusterResult": { + "base": null, + "refs": { + } + }, + "DeleteClusterSecurityGroupMessage": { + "base": "
", + "refs": { + } + }, + "DeleteClusterSnapshotMessage": { + "base": "
", + "refs": { + } + }, + "DeleteClusterSnapshotResult": { + "base": null, + "refs": { + } + }, + "DeleteClusterSubnetGroupMessage": { + "base": "", + "refs": { + } + }, + "DeleteEventSubscriptionMessage": { + "base": "", + "refs": { + } + }, + "DeleteHsmClientCertificateMessage": { + "base": "", + "refs": { + } + }, + "DeleteHsmConfigurationMessage": { + "base": "", + "refs": { + } + }, + "DeleteSnapshotCopyGrantMessage": { + "base": "
The result of the DeleteSnapshotCopyGrant action.
Contains the output from the DeleteTags action.
The request cannot be completed because a dependent service is throttling requests made by Amazon Redshift on your behalf. Wait and retry the request.
", + "refs": { + } + }, + "DescribeClusterParameterGroupsMessage": { + "base": "", + "refs": { + } + }, + "DescribeClusterParametersMessage": { + "base": null, + "refs": { + } + }, + "DescribeClusterSecurityGroupsMessage": { + "base": "", + "refs": { + } + }, + "DescribeClusterSnapshotsMessage": { + "base": "
", + "refs": { + } + }, + "DescribeClusterSubnetGroupsMessage": { + "base": "
", + "refs": { + } + }, + "DescribeClusterVersionsMessage": { + "base": "", + "refs": { + } + }, + "DescribeClustersMessage": { + "base": "
", + "refs": { + } + }, + "DescribeDefaultClusterParametersMessage": { + "base": "
", + "refs": { + } + }, + "DescribeDefaultClusterParametersResult": { + "base": null, + "refs": { + } + }, + "DescribeEventCategoriesMessage": { + "base": "
", + "refs": { + } + }, + "DescribeEventSubscriptionsMessage": { + "base": "", + "refs": { + } + }, + "DescribeEventsMessage": { + "base": "
", + "refs": { + } + }, + "DescribeHsmClientCertificatesMessage": { + "base": "", + "refs": { + } + }, + "DescribeHsmConfigurationsMessage": { + "base": "", + "refs": { + } + }, + "DescribeLoggingStatusMessage": { + "base": "
", + "refs": { + } + }, + "DescribeOrderableClusterOptionsMessage": { + "base": "
", + "refs": { + } + }, + "DescribeReservedNodeOfferingsMessage": { + "base": "", + "refs": { + } + }, + "DescribeReservedNodesMessage": { + "base": "
", + "refs": { + } + }, + "DescribeResizeMessage": { + "base": "
", + "refs": { + } + }, + "DescribeSnapshotCopyGrantsMessage": { + "base": "
The result of the DescribeSnapshotCopyGrants action.
", + "refs": { + } + }, + "DisableLoggingMessage": { + "base": "
", + "refs": { + } + }, + "DisableSnapshotCopyMessage": { + "base": "
", + "refs": { + } + }, + "DisableSnapshotCopyResult": { + "base": null, + "refs": { + } + }, + "Double": { + "base": null, + "refs": { + "RecurringCharge$RecurringChargeAmount": "
The amount charged per the period of time specified by the recurring charge frequency.
", + "ReservedNode$FixedPrice": "The fixed cost Amazon Redshift charges you for this reserved node.
", + "ReservedNode$UsagePrice": "The hourly rate Amazon Redshift charges you for this reserved node.
", + "ReservedNodeOffering$FixedPrice": "The upfront fixed charge you will pay to purchase the specific reserved node offering.
", + "ReservedNodeOffering$UsagePrice": "The rate you are charged for each hour the cluster that is using the offering is running.
", + "RestoreStatus$CurrentRestoreRateInMegaBytesPerSecond": "The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup.
", + "Snapshot$TotalBackupSizeInMegaBytes": "The size of the complete set of backup data that would be used to restore the cluster.
", + "Snapshot$ActualIncrementalBackupSizeInMegaBytes": "The size of the incremental backup.
", + "Snapshot$BackupProgressInMegaBytes": "The number of megabytes that have been transferred to the snapshot backup.
", + "Snapshot$CurrentBackupRateInMegaBytesPerSecond": " The number of megabytes per second being transferred to the snapshot backup. Returns 0 for a completed backup.
The average rate of the resize operation over the last few minutes, measured in megabytes per second. After the resize operation completes, this value shows the average rate of the entire resize operation.
" + } + }, + "EC2SecurityGroup": { + "base": "Describes an Amazon EC2 security group.
", + "refs": { + "EC2SecurityGroupList$member": null + } + }, + "EC2SecurityGroupList": { + "base": null, + "refs": { + "ClusterSecurityGroup$EC2SecurityGroups": "A list of EC2 security groups that are permitted to access clusters associated with this cluster security group.
" + } + }, + "ElasticIpStatus": { + "base": "Describes the status of the elastic IP (EIP) address.
", + "refs": { + "Cluster$ElasticIpStatus": "The status of the elastic IP (EIP) address.
" + } + }, + "EnableLoggingMessage": { + "base": "", + "refs": { + } + }, + "EnableSnapshotCopyMessage": { + "base": "
", + "refs": { + } + }, + "EnableSnapshotCopyResult": { + "base": null, + "refs": { + } + }, + "Endpoint": { + "base": "
Describes a connection endpoint.
", + "refs": { + "Cluster$Endpoint": "The connection endpoint.
" + } + }, + "Event": { + "base": "Describes an event.
", + "refs": { + "EventList$member": null + } + }, + "EventCategoriesList": { + "base": null, + "refs": { + "CreateEventSubscriptionMessage$EventCategories": "Specifies the Amazon Redshift event categories to be published by the event notification subscription.
Values: Configuration, Management, Monitoring, Security
", + "Event$EventCategories": "A list of the event categories.
Values: Configuration, Management, Monitoring, Security
", + "EventInfoMap$EventCategories": "The category of an Amazon Redshift event.
", + "EventSubscription$EventCategoriesList": "The list of Amazon Redshift event categories specified in the event notification subscription.
Values: Configuration, Management, Monitoring, Security
", + "ModifyEventSubscriptionMessage$EventCategories": "Specifies the Amazon Redshift event categories to be published by the event notification subscription.
Values: Configuration, Management, Monitoring, Security
" + } + }, + "EventCategoriesMap": { + "base": "Describes event categories.
", + "refs": { + "EventCategoriesMapList$member": null + } + }, + "EventCategoriesMapList": { + "base": null, + "refs": { + "EventCategoriesMessage$EventCategoriesMapList": "A list of event categories descriptions.
" + } + }, + "EventCategoriesMessage": { + "base": "", + "refs": { + } + }, + "EventInfoMap": { + "base": "
Describes event information.
", + "refs": { + "EventInfoMapList$member": null + } + }, + "EventInfoMapList": { + "base": null, + "refs": { + "EventCategoriesMap$Events": "The events in the event category.
" + } + }, + "EventList": { + "base": null, + "refs": { + "EventsMessage$Events": " A list of Event instances.
Describes event subscriptions.
", + "refs": { + "CreateEventSubscriptionResult$EventSubscription": null, + "EventSubscriptionsList$member": null, + "ModifyEventSubscriptionResult$EventSubscription": null + } + }, + "EventSubscriptionQuotaExceededFault": { + "base": "The request would exceed the allowed number of event subscriptions for this account. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
", + "refs": { + } + }, + "EventSubscriptionsList": { + "base": null, + "refs": { + "EventSubscriptionsMessage$EventSubscriptionsList": "A list of event subscriptions.
" + } + }, + "EventSubscriptionsMessage": { + "base": "", + "refs": { + } + }, + "EventsMessage": { + "base": "", + "refs": { + } + }, + "HsmClientCertificate": { + "base": "
Returns information about an HSM client certificate. The certificate is stored in a secure Hardware Storage Module (HSM), and used by the Amazon Redshift cluster to encrypt data files.
", + "refs": { + "CreateHsmClientCertificateResult$HsmClientCertificate": null, + "HsmClientCertificateList$member": null + } + }, + "HsmClientCertificateAlreadyExistsFault": { + "base": "There is already an existing Amazon Redshift HSM client certificate with the specified identifier.
", + "refs": { + } + }, + "HsmClientCertificateList": { + "base": null, + "refs": { + "HsmClientCertificateMessage$HsmClientCertificates": "A list of the identifiers for one or more HSM client certificates used by Amazon Redshift clusters to store and retrieve database encryption keys in an HSM.
" + } + }, + "HsmClientCertificateMessage": { + "base": "", + "refs": { + } + }, + "HsmClientCertificateNotFoundFault": { + "base": "There is no Amazon Redshift HSM client certificate with the specified identifier.
", + "refs": { + } + }, + "HsmClientCertificateQuotaExceededFault": { + "base": "The quota for HSM client certificates has been reached. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
", + "refs": { + } + }, + "HsmConfiguration": { + "base": "Returns information about an HSM configuration, which is an object that describes to Amazon Redshift clusters the information they require to connect to an HSM where they can store database encryption keys.
", + "refs": { + "CreateHsmConfigurationResult$HsmConfiguration": null, + "HsmConfigurationList$member": null + } + }, + "HsmConfigurationAlreadyExistsFault": { + "base": "There is already an existing Amazon Redshift HSM configuration with the specified identifier.
", + "refs": { + } + }, + "HsmConfigurationList": { + "base": null, + "refs": { + "HsmConfigurationMessage$HsmConfigurations": "A list of HsmConfiguration objects.
There is no Amazon Redshift HSM configuration with the specified identifier.
", + "refs": { + } + }, + "HsmConfigurationQuotaExceededFault": { + "base": "The quota for HSM configurations has been reached. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
", + "refs": { + } + }, + "HsmStatus": { + "base": "Describes the status of changes to HSM settings.
", + "refs": { + "Cluster$HsmStatus": "Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command.
Values: active, applying
" + } + }, + "IPRange": { + "base": "Describes an IP range used in a security group.
", + "refs": { + "IPRangeList$member": null + } + }, + "IPRangeList": { + "base": null, + "refs": { + "ClusterSecurityGroup$IPRanges": "A list of IP ranges (CIDR blocks) that are permitted to access clusters associated with this cluster security group.
" + } + }, + "IamRoleArnList": { + "base": null, + "refs": { + "CreateClusterMessage$IamRoles": "A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 10 IAM roles in a single request.
A cluster can have up to 10 IAM roles associated at any time.
", + "ModifyClusterIamRolesMessage$AddIamRoles": "Zero or more IAM roles (in their ARN format) to associate with the cluster. You can associate up to 10 IAM roles with a single cluster in a single request.
", + "ModifyClusterIamRolesMessage$RemoveIamRoles": "Zero or more IAM roles (in their ARN format) to disassociate from the cluster. You can disassociate up to 10 IAM roles from a single cluster in a single request.
", + "RestoreFromClusterSnapshotMessage$IamRoles": "A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 10 IAM roles in a single request.
A cluster can have up to 10 IAM roles associated at any time.
" + } + }, + "ImportTablesCompleted": { + "base": null, + "refs": { + "ResizeProgressMessage$ImportTablesCompleted": "The names of tables that have been completely imported .
Valid Values: List of table names.
" + } + }, + "ImportTablesInProgress": { + "base": null, + "refs": { + "ResizeProgressMessage$ImportTablesInProgress": "The names of tables that are being currently imported.
Valid Values: List of table names.
" + } + }, + "ImportTablesNotStarted": { + "base": null, + "refs": { + "ResizeProgressMessage$ImportTablesNotStarted": "The names of tables that have not been yet imported.
Valid Values: List of table names
" + } + }, + "InProgressTableRestoreQuotaExceededFault": { + "base": "You have exceeded the allowed number of table restore requests. Wait for your current table restore requests to complete before making a new request.
", + "refs": { + } + }, + "IncompatibleOrderableOptions": { + "base": "The specified options are incompatible.
", + "refs": { + } + }, + "InsufficientClusterCapacityFault": { + "base": "The number of nodes specified exceeds the allotted capacity of the cluster.
", + "refs": { + } + }, + "InsufficientS3BucketPolicyFault": { + "base": "The cluster does not have read bucket or put object permissions on the S3 bucket specified when enabling logging.
", + "refs": { + } + }, + "Integer": { + "base": null, + "refs": { + "Cluster$AutomatedSnapshotRetentionPeriod": "The number of days that automatic cluster snapshots are retained.
", + "Cluster$NumberOfNodes": "The number of compute nodes in the cluster.
", + "Endpoint$Port": "The port that the database engine is listening on.
", + "ModifySnapshotCopyRetentionPeriodMessage$RetentionPeriod": "The number of days to retain automated snapshots in the destination region after they are copied from the source region.
If you decrease the retention period for automated snapshots that are copied to a destination region, Amazon Redshift will delete any existing automated snapshots that were copied to the destination region and that fall outside of the new retention period.
Constraints: Must be at least 1 and no more than 35.
", + "ReservedNode$Duration": "The duration of the node reservation in seconds.
", + "ReservedNode$NodeCount": "The number of reserved compute nodes.
", + "ReservedNodeOffering$Duration": "The duration, in seconds, for which the offering will reserve the node.
", + "Snapshot$Port": "The port that the cluster is listening on.
", + "Snapshot$NumberOfNodes": "The number of nodes in the cluster.
" + } + }, + "IntegerOptional": { + "base": null, + "refs": { + "CreateClusterMessage$AutomatedSnapshotRetentionPeriod": "The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot.
Default: 1
Constraints: Must be a value from 0 to 35.
", + "CreateClusterMessage$Port": "The port number on which the cluster accepts incoming connections.
The cluster is accessible only via the JDBC and ODBC connection strings. Part of the connection string requires the port on which the cluster will listen for incoming connections.
Default: 5439
Valid Values: 1150-65535
The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node.
For information about determining how many nodes you need, go to Working with Clusters in the Amazon Redshift Cluster Management Guide.
If you don't specify this parameter, you get a single-node cluster. When requesting a multi-node cluster, you must specify the number of nodes that you want in the cluster.
Default: 1
Constraints: Value must be at least 1 and no more than 100.
", + "DescribeClusterParameterGroupsMessage$MaxRecords": " The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
", + "DescribeClusterParametersMessage$MaxRecords": " The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
", + "DescribeClusterSecurityGroupsMessage$MaxRecords": " The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
", + "DescribeClusterSnapshotsMessage$MaxRecords": " The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
", + "DescribeClusterSubnetGroupsMessage$MaxRecords": " The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
", + "DescribeClusterVersionsMessage$MaxRecords": " The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
", + "DescribeClustersMessage$MaxRecords": " The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
", + "DescribeDefaultClusterParametersMessage$MaxRecords": " The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
", + "DescribeEventSubscriptionsMessage$MaxRecords": " The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
", + "DescribeEventsMessage$Duration": "The number of minutes prior to the time of the request for which to retrieve events. For example, if the request is sent at 18:00 and you specify a duration of 60, then only events which have occurred after 17:00 will be returned.
Default: 60
The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
", + "DescribeHsmClientCertificatesMessage$MaxRecords": " The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
", + "DescribeHsmConfigurationsMessage$MaxRecords": " The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
", + "DescribeOrderableClusterOptionsMessage$MaxRecords": " The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
", + "DescribeReservedNodeOfferingsMessage$MaxRecords": " The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
", + "DescribeReservedNodesMessage$MaxRecords": " The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
", + "DescribeSnapshotCopyGrantsMessage$MaxRecords": " The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
", + "DescribeTableRestoreStatusMessage$MaxRecords": "The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
The maximum number or response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
The number of days to retain automated snapshots in the destination region after they are copied from the source region.
Default: 7.
Constraints: Must be at least 1 and no more than 35.
", + "ModifyClusterMessage$NumberOfNodes": "The new number of nodes of the cluster. If you specify a new number of nodes, you must also specify the node type parameter.
When you submit your request to resize a cluster, Amazon Redshift sets access permissions for the cluster to read-only. After Amazon Redshift provisions a new cluster according to your resize requirements, there will be a temporary outage while the old cluster is deleted and your connection is switched to the new cluster. When the new connection is complete, the original access permissions for the cluster are restored. You can use DescribeResize to track the progress of the resize request.
Valid Values: Integer greater than 0.
The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot.
If you decrease the automated snapshot retention period from its current value, existing automated snapshots that fall outside of the new retention period will be immediately deleted.
Default: Uses existing setting.
Constraints: Must be a value from 0 to 35.
", + "PendingModifiedValues$NumberOfNodes": "The pending or in-progress change of the number of nodes in the cluster.
", + "PendingModifiedValues$AutomatedSnapshotRetentionPeriod": "The pending or in-progress change of the automated snapshot retention period.
", + "PurchaseReservedNodeOfferingMessage$NodeCount": "The number of reserved nodes that you want to purchase.
Default: 1
The number of nodes that the cluster will have after the resize operation is complete.
", + "RestoreFromClusterSnapshotMessage$Port": "The port number on which the cluster accepts connections.
Default: The same port as the original cluster.
Constraints: Must be between 1115 and 65535.
The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot.
Default: The value selected for the cluster from which the snapshot was taken.
Constraints: Must be a value from 0 to 35.
" + } + }, + "InvalidClusterParameterGroupStateFault": { + "base": "The cluster parameter group action can not be completed because another task is in progress that involves the parameter group. Wait a few moments and try the operation again.
", + "refs": { + } + }, + "InvalidClusterSecurityGroupStateFault": { + "base": " The state of the cluster security group is not available.
The specified cluster snapshot is not in the available state, or other accounts are authorized to access the snapshot.
The specified cluster is not in the available state.
The cluster subnet group cannot be deleted because it is in use.
", + "refs": { + } + }, + "InvalidClusterSubnetStateFault": { + "base": "The state of the subnet is invalid.
", + "refs": { + } + }, + "InvalidElasticIpFault": { + "base": "The Elastic IP (EIP) is invalid or cannot be found.
", + "refs": { + } + }, + "InvalidHsmClientCertificateStateFault": { + "base": "The specified HSM client certificate is not in the available state, or it is still in use by one or more Amazon Redshift clusters.
The specified HSM configuration is not in the available state, or it is still in use by one or more Amazon Redshift clusters.
The restore is invalid.
", + "refs": { + } + }, + "InvalidS3BucketNameFault": { + "base": "The S3 bucket name is invalid. For more information about naming rules, go to Bucket Restrictions and Limitations in the Amazon Simple Storage Service (S3) Developer Guide.
", + "refs": { + } + }, + "InvalidS3KeyPrefixFault": { + "base": "The string specified for the logging S3 key prefix does not comply with the documented constraints.
", + "refs": { + } + }, + "InvalidSnapshotCopyGrantStateFault": { + "base": "The snapshot copy grant can't be deleted because it is used by one or more clusters.
", + "refs": { + } + }, + "InvalidSubnet": { + "base": "The requested subnet is not valid, or not all of the subnets are in the same VPC.
", + "refs": { + } + }, + "InvalidSubscriptionStateFault": { + "base": "The subscription request is invalid because it is a duplicate request. This subscription request is already in progress.
", + "refs": { + } + }, + "InvalidTableRestoreArgumentFault": { + "base": "The value specified for the sourceDatabaseName, sourceSchemaName, or sourceTableName parameter, or a combination of these, doesn't exist in the snapshot.
The tag is invalid.
", + "refs": { + } + }, + "InvalidVPCNetworkStateFault": { + "base": "The cluster subnet group does not cover all Availability Zones.
", + "refs": { + } + }, + "LimitExceededFault": { + "base": "The encryption key has exceeded its grant limit in AWS KMS.
", + "refs": { + } + }, + "LoggingStatus": { + "base": "Describes the status of logging for a cluster.
", + "refs": { + } + }, + "Long": { + "base": null, + "refs": { + "ClusterSnapshotCopyStatus$RetentionPeriod": "The number of days that automated snapshots are retained in the destination region after they are copied from a source region.
", + "RestoreStatus$SnapshotSizeInMegaBytes": "The size of the set of snapshot data used to restore the cluster.
", + "RestoreStatus$ProgressInMegaBytes": "The number of megabytes that have been transferred from snapshot storage.
", + "RestoreStatus$ElapsedTimeInSeconds": "The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish.
", + "RestoreStatus$EstimatedTimeToCompletionInSeconds": "The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore.
", + "Snapshot$EstimatedSecondsToCompletion": " The estimate of the time remaining before the snapshot backup will complete. Returns 0 for a completed backup.
The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.
" + } + }, + "LongOptional": { + "base": null, + "refs": { + "ResizeProgressMessage$TotalResizeDataInMegaBytes": "The estimated total amount of data, in megabytes, on the cluster before the resize operation began.
", + "ResizeProgressMessage$ProgressInMegaBytes": "While the resize operation is in progress, this value shows the current amount of data, in megabytes, that has been processed so far. When the resize operation is complete, this value shows the total amount of data, in megabytes, on the cluster, which may be more or less than TotalResizeDataInMegaBytes (the estimated total amount of data before resize).
", + "ResizeProgressMessage$ElapsedTimeInSeconds": "The amount of seconds that have elapsed since the resize operation began. After the resize operation completes, this value shows the total actual time, in seconds, for the resize operation.
", + "ResizeProgressMessage$EstimatedTimeToCompletionInSeconds": "The estimated time remaining, in seconds, until the resize operation is complete. This value is calculated based on the average resize rate and the estimated amount of data remaining to be processed. Once the resize operation is complete, this value will be 0.
", + "TableRestoreStatus$ProgressInMegaBytes": "The amount of data restored to the new table so far, in megabytes (MB).
", + "TableRestoreStatus$TotalDataInMegaBytes": "The total amount of data to restore to the new table, in megabytes (MB).
" + } + }, + "ModifyClusterIamRolesMessage": { + "base": "", + "refs": { + } + }, + "ModifyClusterIamRolesResult": { + "base": null, + "refs": { + } + }, + "ModifyClusterMessage": { + "base": "", + "refs": { + } + }, + "ModifyClusterParameterGroupMessage": { + "base": "", + "refs": { + } + }, + "ModifyClusterResult": { + "base": null, + "refs": { + } + }, + "ModifyClusterSubnetGroupMessage": { + "base": "
", + "refs": { + } + }, + "ModifyClusterSubnetGroupResult": { + "base": null, + "refs": { + } + }, + "ModifyEventSubscriptionMessage": { + "base": "", + "refs": { + } + }, + "ModifyEventSubscriptionResult": { + "base": null, + "refs": { + } + }, + "ModifySnapshotCopyRetentionPeriodMessage": { + "base": "
", + "refs": { + } + }, + "ModifySnapshotCopyRetentionPeriodResult": { + "base": null, + "refs": { + } + }, + "NumberOfNodesPerClusterLimitExceededFault": { + "base": "
The operation would exceed the number of nodes allowed for a cluster.
", + "refs": { + } + }, + "NumberOfNodesQuotaExceededFault": { + "base": "The operation would exceed the number of nodes allotted to the account. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
", + "refs": { + } + }, + "OrderableClusterOption": { + "base": "Describes an orderable cluster option.
", + "refs": { + "OrderableClusterOptionsList$member": null + } + }, + "OrderableClusterOptionsList": { + "base": null, + "refs": { + "OrderableClusterOptionsMessage$OrderableClusterOptions": "An OrderableClusterOption structure containing information about orderable options for the cluster.
Contains the output from the DescribeOrderableClusterOptions action.
", + "refs": { + } + }, + "Parameter": { + "base": "Describes a parameter in a cluster parameter group.
", + "refs": { + "ParametersList$member": null + } + }, + "ParameterApplyType": { + "base": null, + "refs": { + "Parameter$ApplyType": "Specifies how to apply the WLM configuration parameter. Some properties can be applied dynamically, while other properties require that any associated clusters be rebooted for the configuration changes to be applied. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
" + } + }, + "ParameterGroupList": { + "base": null, + "refs": { + "ClusterParameterGroupsMessage$ParameterGroups": "A list of ClusterParameterGroup instances. Each instance describes one cluster parameter group.
" + } + }, + "ParametersList": { + "base": null, + "refs": { + "ClusterParameterGroupDetails$Parameters": "A list of Parameter instances. Each instance lists the parameters of one cluster parameter group.
", + "DefaultClusterParameters$Parameters": "The list of cluster default parameters.
", + "ModifyClusterParameterGroupMessage$Parameters": "An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request.
For each parameter to be modified, you must supply at least the parameter name and parameter value; other name-value pairs of the parameter are optional.
For the workload management (WLM) configuration, you must supply all the name-value pairs in the wlm_json_configuration parameter.
", + "ResetClusterParameterGroupMessage$Parameters": "An array of names of parameters to be reset. If ResetAllParameters option is not used, then at least one parameter name must be supplied.
Constraints: A maximum of 20 parameters can be reset in a single request.
" + } + }, + "PendingModifiedValues": { + "base": "Describes cluster attributes that are in a pending state. A change to one or more the attributes was requested and is in progress or will be applied.
", + "refs": { + "Cluster$PendingModifiedValues": "If present, changes to the cluster are pending. Specific pending changes are identified by subelements.
" + } + }, + "PurchaseReservedNodeOfferingMessage": { + "base": "", + "refs": { + } + }, + "PurchaseReservedNodeOfferingResult": { + "base": null, + "refs": { + } + }, + "RebootClusterMessage": { + "base": "", + "refs": { + } + }, + "RebootClusterResult": { + "base": null, + "refs": { + } + }, + "RecurringCharge": { + "base": "
Describes a recurring charge.
", + "refs": { + "RecurringChargeList$member": null + } + }, + "RecurringChargeList": { + "base": null, + "refs": { + "ReservedNode$RecurringCharges": "The recurring charges for the reserved node.
", + "ReservedNodeOffering$RecurringCharges": "The charge to your account regardless of whether you are creating any clusters using the node offering. Recurring charges are only in effect for heavy-utilization reserved nodes.
" + } + }, + "ReservedNode": { + "base": "Describes a reserved node. You can call the DescribeReservedNodeOfferings API to obtain the available reserved node offerings.
", + "refs": { + "PurchaseReservedNodeOfferingResult$ReservedNode": null, + "ReservedNodeList$member": null + } + }, + "ReservedNodeAlreadyExistsFault": { + "base": "User already has a reservation with the given identifier.
", + "refs": { + } + }, + "ReservedNodeList": { + "base": null, + "refs": { + "ReservedNodesMessage$ReservedNodes": "The list of ReservedNode objects.
The specified reserved compute node not found.
", + "refs": { + } + }, + "ReservedNodeOffering": { + "base": "Describes a reserved node offering.
", + "refs": { + "ReservedNodeOfferingList$member": null + } + }, + "ReservedNodeOfferingList": { + "base": null, + "refs": { + "ReservedNodeOfferingsMessage$ReservedNodeOfferings": "A list of ReservedNodeOffering objects.
Specified offering does not exist.
", + "refs": { + } + }, + "ReservedNodeOfferingsMessage": { + "base": "", + "refs": { + } + }, + "ReservedNodeQuotaExceededFault": { + "base": "
Request would exceed the user's compute node quota. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
", + "refs": { + } + }, + "ReservedNodesMessage": { + "base": "", + "refs": { + } + }, + "ResetClusterParameterGroupMessage": { + "base": "", + "refs": { + } + }, + "ResizeNotFoundFault": { + "base": "
A resize operation for the specified cluster is not found.
", + "refs": { + } + }, + "ResizeProgressMessage": { + "base": "Describes the result of a cluster resize operation.
", + "refs": { + } + }, + "ResourceNotFoundFault": { + "base": "The resource could not be found.
", + "refs": { + } + }, + "RestorableNodeTypeList": { + "base": null, + "refs": { + "Snapshot$RestorableNodeTypes": "The list of node types that this cluster snapshot is able to restore into.
" + } + }, + "RestoreFromClusterSnapshotMessage": { + "base": "", + "refs": { + } + }, + "RestoreFromClusterSnapshotResult": { + "base": null, + "refs": { + } + }, + "RestoreStatus": { + "base": "Describes the status of a cluster restore action. Returns null if the cluster was not created by restoring a snapshot.
", + "refs": { + "Cluster$RestoreStatus": "Describes the status of a cluster restore action. Returns null if the cluster was not created by restoring a snapshot.
" + } + }, + "RestoreTableFromClusterSnapshotMessage": { + "base": null, + "refs": { + } + }, + "RestoreTableFromClusterSnapshotResult": { + "base": null, + "refs": { + } + }, + "RevokeClusterSecurityGroupIngressMessage": { + "base": "", + "refs": { + } + }, + "RevokeClusterSecurityGroupIngressResult": { + "base": null, + "refs": { + } + }, + "RevokeSnapshotAccessMessage": { + "base": "
", + "refs": { + } + }, + "RevokeSnapshotAccessResult": { + "base": null, + "refs": { + } + }, + "RotateEncryptionKeyMessage": { + "base": "
", + "refs": { + } + }, + "RotateEncryptionKeyResult": { + "base": null, + "refs": { + } + }, + "SNSInvalidTopicFault": { + "base": "
Amazon SNS has responded that there is a problem with the specified Amazon SNS topic.
", + "refs": { + } + }, + "SNSNoAuthorizationFault": { + "base": "You do not have permission to publish to the specified Amazon SNS topic.
", + "refs": { + } + }, + "SNSTopicArnNotFoundFault": { + "base": "An Amazon SNS topic with the specified Amazon Resource Name (ARN) does not exist.
", + "refs": { + } + }, + "Snapshot": { + "base": "Describes a snapshot.
", + "refs": { + "AuthorizeSnapshotAccessResult$Snapshot": null, + "CopyClusterSnapshotResult$Snapshot": null, + "CreateClusterSnapshotResult$Snapshot": null, + "DeleteClusterSnapshotResult$Snapshot": null, + "RevokeSnapshotAccessResult$Snapshot": null, + "SnapshotList$member": null + } + }, + "SnapshotCopyAlreadyDisabledFault": { + "base": "The cluster already has cross-region snapshot copy disabled.
", + "refs": { + } + }, + "SnapshotCopyAlreadyEnabledFault": { + "base": "The cluster already has cross-region snapshot copy enabled.
", + "refs": { + } + }, + "SnapshotCopyDisabledFault": { + "base": "Cross-region snapshot copy was temporarily disabled. Try your request again.
", + "refs": { + } + }, + "SnapshotCopyGrant": { + "base": "The snapshot copy grant that grants Amazon Redshift permission to encrypt copied snapshots with the specified customer master key (CMK) from AWS KMS in the destination region.
For more information about managing snapshot copy grants, go to Amazon Redshift Database Encryption in the Amazon Redshift Cluster Management Guide.
", + "refs": { + "CreateSnapshotCopyGrantResult$SnapshotCopyGrant": null, + "SnapshotCopyGrantList$member": null + } + }, + "SnapshotCopyGrantAlreadyExistsFault": { + "base": "The snapshot copy grant can't be created because a grant with the same name already exists.
", + "refs": { + } + }, + "SnapshotCopyGrantList": { + "base": null, + "refs": { + "SnapshotCopyGrantMessage$SnapshotCopyGrants": "The list of SnapshotCopyGrant objects.
The specified snapshot copy grant can't be found. Make sure that the name is typed correctly and that the grant exists in the destination region.
", + "refs": { + } + }, + "SnapshotCopyGrantQuotaExceededFault": { + "base": "The AWS account has exceeded the maximum number of snapshot copy grants in this region.
", + "refs": { + } + }, + "SnapshotList": { + "base": null, + "refs": { + "SnapshotMessage$Snapshots": "A list of Snapshot instances.
" + } + }, + "SnapshotMessage": { + "base": "Contains the output from the DescribeClusterSnapshots action.
", + "refs": { + } + }, + "SourceIdsList": { + "base": null, + "refs": { + "CreateEventSubscriptionMessage$SourceIds": "A list of one or more identifiers of Amazon Redshift source objects. All of the objects must be of the same type as was specified in the source type parameter. The event subscription will return only events generated by the specified objects. If not specified, then events are returned for all objects within the source type specified.
Example: my-cluster-1, my-cluster-2
Example: my-snapshot-20131010
", + "EventSubscription$SourceIdsList": "A list of the sources that publish events to the Amazon Redshift event notification subscription.
", + "ModifyEventSubscriptionMessage$SourceIds": "A list of one or more identifiers of Amazon Redshift source objects. All of the objects must be of the same type as was specified in the source type parameter. The event subscription will return only events generated by the specified objects. If not specified, then events are returned for all objects within the source type specified.
Example: my-cluster-1, my-cluster-2
Example: my-snapshot-20131010
" + } + }, + "SourceNotFoundFault": { + "base": "The specified Amazon Redshift event source could not be found.
", + "refs": { + } + }, + "SourceType": { + "base": null, + "refs": { + "DescribeEventsMessage$SourceType": "The event source to retrieve events for. If no value is specified, all events are returned.
Constraints:
If SourceType is supplied, SourceIdentifier must also be provided.
cluster when SourceIdentifier is a cluster identifier.cluster-security-group when SourceIdentifier is a cluster security group name.cluster-parameter-group when SourceIdentifier is a cluster parameter group name.cluster-snapshot when SourceIdentifier is a cluster snapshot identifier.The source type for this event.
" + } + }, + "String": { + "base": null, + "refs": { + "AccountWithRestoreAccess$AccountId": "The identifier of an AWS customer account authorized to restore a snapshot.
", + "AuthorizeClusterSecurityGroupIngressMessage$ClusterSecurityGroupName": "The name of the security group to which the ingress rule is added.
", + "AuthorizeClusterSecurityGroupIngressMessage$CIDRIP": "The IP range to be added the Amazon Redshift security group.
", + "AuthorizeClusterSecurityGroupIngressMessage$EC2SecurityGroupName": "The EC2 security group to be added the Amazon Redshift security group.
", + "AuthorizeClusterSecurityGroupIngressMessage$EC2SecurityGroupOwnerId": "The AWS account number of the owner of the security group specified by the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value.
Example: 111122223333
The identifier of the snapshot the account is authorized to restore.
", + "AuthorizeSnapshotAccessMessage$SnapshotClusterIdentifier": "The identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.
", + "AuthorizeSnapshotAccessMessage$AccountWithRestoreAccess": "The identifier of the AWS customer account authorized to restore the specified snapshot.
", + "AvailabilityZone$Name": "The name of the availability zone.
", + "Cluster$ClusterIdentifier": "The unique identifier of the cluster.
", + "Cluster$NodeType": "The node type for the nodes in the cluster.
", + "Cluster$ClusterStatus": "The current state of the cluster. Possible values are:
availablecreatingdeletingfinal-snapshothardware-failureincompatible-hsmincompatible-networkincompatible-parametersincompatible-restoremodifyingrebootingrenamingresizingrotating-keysstorage-fullupdating-hsmThe status of a modify operation, if any, initiated for the cluster.
", + "Cluster$MasterUsername": "The master user name for the cluster. This name is used to connect to the database that is specified in DBName.
", + "Cluster$DBName": "The name of the initial database that was created when the cluster was created. This same name is returned for the life of the cluster. If an initial database was not specified, a database named \"dev\" was created by default.
", + "Cluster$ClusterSubnetGroupName": "The name of the subnet group that is associated with the cluster. This parameter is valid only when the cluster is in a VPC.
", + "Cluster$VpcId": "The identifier of the VPC the cluster is in, if the cluster is in a VPC.
", + "Cluster$AvailabilityZone": "The name of the Availability Zone in which the cluster is located.
", + "Cluster$PreferredMaintenanceWindow": "The weekly time range (in UTC) during which system maintenance can occur.
", + "Cluster$ClusterVersion": "The version ID of the Amazon Redshift engine that is running on the cluster.
", + "Cluster$ClusterPublicKey": "The public key for the cluster.
", + "Cluster$ClusterRevisionNumber": "The specific revision number of the database in the cluster.
", + "Cluster$KmsKeyId": "The AWS Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.
", + "ClusterIamRole$IamRoleArn": "The Amazon Resource Name (ARN) of the IAM role. For example, arn:aws:iam::123456789012:role/RedshiftCopyUnload.
Describes the status of the IAM role's association with an Amazon Redshift cluster.
The following are possible statuses and descriptions.
in-sync: The role is available for use by the cluster.adding: The role is in the process of being associated with the cluster.removing: The role is in the process of being disassociated with the cluster.Whether the node is a leader node or a compute node.
", + "ClusterNode$PrivateIPAddress": "The private IP address of a node within a cluster.
", + "ClusterNode$PublicIPAddress": "The public IP address of a node within a cluster.
", + "ClusterParameterGroup$ParameterGroupName": "The name of the cluster parameter group.
", + "ClusterParameterGroup$ParameterGroupFamily": "The name of the cluster parameter group family that this cluster parameter group is compatible with.
", + "ClusterParameterGroup$Description": "The description of the parameter group.
", + "ClusterParameterGroupDetails$Marker": " A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
The name of the cluster parameter group.
", + "ClusterParameterGroupNameMessage$ParameterGroupStatus": "The status of the parameter group. For example, if you made a change to a parameter group name-value pair, then the change could be pending a reboot of an associated cluster.
", + "ClusterParameterGroupStatus$ParameterGroupName": "The name of the cluster parameter group.
", + "ClusterParameterGroupStatus$ParameterApplyStatus": "The status of parameter updates.
", + "ClusterParameterGroupsMessage$Marker": " A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
The name of the parameter.
", + "ClusterParameterStatus$ParameterApplyStatus": "The status of the parameter that indicates whether the parameter is in sync with the database, waiting for a cluster reboot, or encountered an error when being applied.
The following are possible statuses and descriptions.
in-sync: The parameter value is in sync with the database.pending-reboot: The parameter value will be applied after the cluster reboots.applying: The parameter value is being applied to the database.invalid-parameter: Cannot apply the parameter value because it has an invalid value or syntax.apply-deferred: The parameter contains static property changes. The changes are deferred until the cluster reboots.apply-error: Cannot connect to the cluster. The parameter change will be applied after the cluster reboots.unknown-error: Cannot apply the parameter change right now. The change will be applied after the cluster reboots.The error that prevented the parameter from being applied to the database.
", + "ClusterSecurityGroup$ClusterSecurityGroupName": "The name of the cluster security group to which the operation was applied.
", + "ClusterSecurityGroup$Description": "A description of the security group.
", + "ClusterSecurityGroupMembership$ClusterSecurityGroupName": "The name of the cluster security group.
", + "ClusterSecurityGroupMembership$Status": "The status of the cluster security group.
", + "ClusterSecurityGroupMessage$Marker": " A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.
", + "ClusterSnapshotCopyStatus$SnapshotCopyGrantName": "The name of the snapshot copy grant.
", + "ClusterSubnetGroup$ClusterSubnetGroupName": "The name of the cluster subnet group.
", + "ClusterSubnetGroup$Description": "The description of the cluster subnet group.
", + "ClusterSubnetGroup$VpcId": "The VPC ID of the cluster subnet group.
", + "ClusterSubnetGroup$SubnetGroupStatus": " The status of the cluster subnet group. Possible values are Complete, Incomplete and Invalid.
A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
The version number used by the cluster.
", + "ClusterVersion$ClusterParameterGroupFamily": "The name of the cluster parameter group family for the cluster.
", + "ClusterVersion$Description": "The description of the cluster version.
", + "ClusterVersionsMessage$Marker": " A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
The identifier for the source snapshot.
Constraints:
available.The identifier of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.
Constraints:
The identifier given to the new manual snapshot.
Constraints:
The name of the first database to be created when the cluster is created.
To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database. For more information, go to Create a Database in the Amazon Redshift Database Developer Guide.
Default: dev
Constraints:
A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. The identifier also appears in the Amazon Redshift console.
Constraints:
Example: myexamplecluster
The type of the cluster. When cluster type is specified as
single-node, the NumberOfNodes parameter is not required.multi-node, the NumberOfNodes parameter is required. Valid Values: multi-node | single-node
Default: multi-node
The node type to be provisioned for the cluster. For information about node types, go to Working with Clusters in the Amazon Redshift Cluster Management Guide.
Valid Values: ds1.xlarge | ds1.8xlarge | ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge.
The user name associated with the master user account for the cluster that is being created.
Constraints:
The password associated with the master user account for the cluster that is being created.
Constraints:
The name of a cluster subnet group to be associated with this cluster.
If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC).
", + "CreateClusterMessage$AvailabilityZone": "The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency.
Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint.
Example: us-east-1d
Constraint: The specified Availability Zone must be in the same region as the current endpoint.
", + "CreateClusterMessage$PreferredMaintenanceWindow": "The weekly time range (in UTC) during which automated cluster maintenance can occur.
Format: ddd:hh24:mi-ddd:hh24:mi
Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide.
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Minimum 30-minute window.
", + "CreateClusterMessage$ClusterParameterGroupName": "The name of the parameter group to be associated with this cluster.
Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups
Constraints:
The version of the Amazon Redshift engine software that you want to deploy on the cluster.
The version selected runs on all the nodes in the cluster.
Constraints: Only version 1.0 is currently available.
Example: 1.0
Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
", + "CreateClusterMessage$HsmConfigurationIdentifier": "Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.
", + "CreateClusterMessage$ElasticIp": "The Elastic IP (EIP) address for the cluster.
Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. For more information about provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide.
", + "CreateClusterMessage$KmsKeyId": "The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.
", + "CreateClusterMessage$AdditionalInfo": "Reserved.
", + "CreateClusterParameterGroupMessage$ParameterGroupName": "The name of the cluster parameter group.
Constraints:
The Amazon Redshift engine version to which the cluster parameter group applies. The cluster engine version determines the set of parameters.
To get a list of valid parameter group family names, you can call DescribeClusterParameterGroups. By default, Amazon Redshift returns a list of all the parameter groups that are owned by your AWS account, including the default parameter groups for each Amazon Redshift engine version. The parameter group family names associated with the default parameter groups provide you the valid values. For example, a valid family name is \"redshift-1.0\".
", + "CreateClusterParameterGroupMessage$Description": "A description of the parameter group.
", + "CreateClusterSecurityGroupMessage$ClusterSecurityGroupName": "The name for the security group. Amazon Redshift stores the value as a lowercase string.
Constraints:
Example: examplesecuritygroup
A description for the security group.
", + "CreateClusterSnapshotMessage$SnapshotIdentifier": "A unique identifier for the snapshot that you are requesting. This identifier must be unique for all snapshots within the AWS account.
Constraints:
Example: my-snapshot-id
The cluster identifier for which you want a snapshot.
", + "CreateClusterSubnetGroupMessage$ClusterSubnetGroupName": "The name for the subnet group. Amazon Redshift stores the value as a lowercase string.
Constraints:
Example: examplesubnetgroup
A description for the subnet group.
", + "CreateEventSubscriptionMessage$SubscriptionName": "The name of the event subscription to be created.
Constraints:
The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications. The ARN is created by Amazon SNS when you create a topic and subscribe to it.
", + "CreateEventSubscriptionMessage$SourceType": "The type of source that will be generating the events. For example, if you want to be notified of events generated by a cluster, you would set this parameter to cluster. If this value is not specified, events are returned for all Amazon Redshift objects in your AWS account. You must specify a source type in order to specify source IDs.
Valid values: cluster, cluster-parameter-group, cluster-security-group, and cluster-snapshot.
", + "CreateEventSubscriptionMessage$Severity": "Specifies the Amazon Redshift event severity to be published by the event notification subscription.
Values: ERROR, INFO
", + "CreateHsmClientCertificateMessage$HsmClientCertificateIdentifier": "The identifier to be assigned to the new HSM client certificate that the cluster will use to connect to the HSM to use the database encryption keys.
", + "CreateHsmConfigurationMessage$HsmConfigurationIdentifier": "The identifier to be assigned to the new Amazon Redshift HSM configuration.
", + "CreateHsmConfigurationMessage$Description": "A text description of the HSM configuration to be created.
", + "CreateHsmConfigurationMessage$HsmIpAddress": "The IP address that the Amazon Redshift cluster must use to access the HSM.
", + "CreateHsmConfigurationMessage$HsmPartitionName": "The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys.
", + "CreateHsmConfigurationMessage$HsmPartitionPassword": "The password required to access the HSM partition.
", + "CreateHsmConfigurationMessage$HsmServerPublicCertificate": "The HSMs public certificate file. When using Cloud HSM, the file name is server.pem.
", + "CreateSnapshotCopyGrantMessage$SnapshotCopyGrantName": "The name of the snapshot copy grant. This name must be unique in the region for the AWS account.
Constraints:
The unique identifier of the customer master key (CMK) to which to grant Amazon Redshift permission. If no key is specified, the default key is used.
", + "CreateTagsMessage$ResourceName": " The Amazon Resource Name (ARN) to which you want to add the tag or tags. For example, arn:aws:redshift:us-east-1:123456789:cluster:t1.
The name of the cluster parameter group family to which the engine default parameters apply.
", + "DefaultClusterParameters$Marker": " A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
The identifier of the cluster to be deleted.
Constraints:
The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided, SkipFinalClusterSnapshot must be false.
Constraints:
The name of the parameter group to be deleted.
Constraints:
The name of the cluster security group to be deleted.
", + "DeleteClusterSnapshotMessage$SnapshotIdentifier": "The unique identifier of the manual snapshot to be deleted.
Constraints: Must be the name of an existing snapshot that is in the available state.
The unique identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.
Constraints: Must be the name of valid cluster.
", + "DeleteClusterSubnetGroupMessage$ClusterSubnetGroupName": "The name of the cluster subnet group name to be deleted.
", + "DeleteEventSubscriptionMessage$SubscriptionName": "The name of the Amazon Redshift event notification subscription to be deleted.
", + "DeleteHsmClientCertificateMessage$HsmClientCertificateIdentifier": "The identifier of the HSM client certificate to be deleted.
", + "DeleteHsmConfigurationMessage$HsmConfigurationIdentifier": "The identifier of the Amazon Redshift HSM configuration to be deleted.
", + "DeleteSnapshotCopyGrantMessage$SnapshotCopyGrantName": "The name of the snapshot copy grant to delete.
", + "DeleteTagsMessage$ResourceName": " The Amazon Resource Name (ARN) from which you want to remove the tag or tags. For example, arn:aws:redshift:us-east-1:123456789:cluster:t1.
The name of a specific parameter group for which to return details. By default, details about all parameter groups and the default parameter group are returned.
", + "DescribeClusterParameterGroupsMessage$Marker": " An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
The name of a cluster parameter group for which to return details.
", + "DescribeClusterParametersMessage$Source": " The parameter types to return. Specify user to show parameters that are different form the default. Similarly, specify engine-default to show parameters that are the same as the default parameter group.
Default: All parameter types returned.
Valid Values: user | engine-default
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameters request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
The name of a cluster security group for which you are requesting details. You can specify either the Marker parameter or a ClusterSecurityGroupName parameter, but not both.
Example: securitygroup1
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterSecurityGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
Constraints: You can specify either the ClusterSecurityGroupName parameter or the Marker parameter, but not both.
", + "DescribeClusterSnapshotsMessage$ClusterIdentifier": "The identifier of the cluster for which information about snapshots is requested.
", + "DescribeClusterSnapshotsMessage$SnapshotIdentifier": "The snapshot identifier of the snapshot about which to return information.
", + "DescribeClusterSnapshotsMessage$SnapshotType": "The type of snapshots for which you are requesting information. By default, snapshots of all types are returned.
Valid Values: automated | manual
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterSnapshots request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
The AWS customer account used to create or copy the snapshot. Use this field to filter the results to snapshots owned by a particular account. To describe snapshots you own, either specify your AWS customer account, or do not specify the parameter.
", + "DescribeClusterSubnetGroupsMessage$ClusterSubnetGroupName": "The name of the cluster subnet group for which information is requested.
", + "DescribeClusterSubnetGroupsMessage$Marker": " An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterSubnetGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
The specific cluster version to return.
Example: 1.0
The name of a specific cluster parameter group family to return details for.
Constraints:
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterVersions request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
The unique identifier of a cluster whose properties you are requesting. This parameter is case sensitive.
The default is that all clusters defined for an account are returned.
", + "DescribeClustersMessage$Marker": " An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusters request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
Constraints: You can specify either the ClusterIdentifier parameter or the Marker parameter, but not both.
", + "DescribeDefaultClusterParametersMessage$ParameterGroupFamily": "The name of the cluster parameter group family.
", + "DescribeDefaultClusterParametersMessage$Marker": " An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDefaultClusterParameters request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
The source type, such as cluster or parameter group, to which the described event categories apply.
Valid values: cluster, cluster-snapshot, cluster-parameter-group, and cluster-security-group.
", + "DescribeEventSubscriptionsMessage$SubscriptionName": "The name of the Amazon Redshift event notification subscription to be described.
", + "DescribeEventSubscriptionsMessage$Marker": " An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeEventSubscriptions request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
The identifier of the event source for which events will be returned. If this parameter is not specified, then all sources are included in the response.
Constraints:
If SourceIdentifier is supplied, SourceType must also be provided.
cluster.cluster-security-group.cluster-parameter-group.cluster-snapshot. An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeEvents request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
The identifier of a specific HSM client certificate for which you want information. If no identifier is specified, information is returned for all HSM client certificates owned by your AWS customer account.
", + "DescribeHsmClientCertificatesMessage$Marker": " An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeHsmClientCertificates request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
The identifier of a specific Amazon Redshift HSM configuration to be described. If no identifier is specified, information is returned for all HSM configurations owned by your AWS customer account.
", + "DescribeHsmConfigurationsMessage$Marker": " An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeHsmConfigurations request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
The identifier of the cluster from which to get the logging status.
Example: examplecluster
The version filter value. Specify this parameter to show only the available offerings matching the specified version.
Default: All versions.
Constraints: Must be one of the version returned from DescribeClusterVersions.
", + "DescribeOrderableClusterOptionsMessage$NodeType": "The node type filter value. Specify this parameter to show only the available offerings matching the specified node type.
", + "DescribeOrderableClusterOptionsMessage$Marker": " An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeOrderableClusterOptions request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
The unique identifier for the offering.
", + "DescribeReservedNodeOfferingsMessage$Marker": " An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeReservedNodeOfferings request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
Identifier for the node reservation.
", + "DescribeReservedNodesMessage$Marker": " An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeReservedNodes request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
The unique identifier of a cluster whose resize progress you are requesting. This parameter is case-sensitive.
By default, resize operations for all clusters defined for an AWS account are returned.
", + "DescribeSnapshotCopyGrantsMessage$SnapshotCopyGrantName": "The name of the snapshot copy grant.
", + "DescribeSnapshotCopyGrantsMessage$Marker": " An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeSnapshotCopyGrant request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
Constraints: You can specify either the SnapshotCopyGrantName parameter or the Marker parameter, but not both.
", + "DescribeTableRestoreStatusMessage$ClusterIdentifier": "The Amazon Redshift cluster that the table is being restored to.
", + "DescribeTableRestoreStatusMessage$TableRestoreRequestId": "The identifier of the table restore request to return status for. If you don't specify a TableRestoreRequestId value, then DescribeTableRestoreStatus returns the status of all in-progress table restore requests.
An optional pagination token provided by a previous DescribeTableRestoreStatus request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter.
The Amazon Resource Name (ARN) for which you want to describe the tag or tags. For example, arn:aws:redshift:us-east-1:123456789:cluster:t1.
The type of resource with which you want to view tags. Valid resource types are:
For more information about Amazon Redshift resource types and constructing ARNs, go to Constructing an Amazon Redshift Amazon Resource Name (ARN) in the Amazon Redshift Cluster Management Guide.
", + "DescribeTagsMessage$Marker": " A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the marker parameter and retrying the command. If the marker field is empty, all response records have been retrieved for the request.
The identifier of the cluster on which logging is to be stopped.
Example: examplecluster
The unique identifier of the source cluster that you want to disable copying of snapshots to a destination region.
Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled.
", + "EC2SecurityGroup$Status": "The status of the EC2 security group.
", + "EC2SecurityGroup$EC2SecurityGroupName": "The name of the EC2 Security Group.
", + "EC2SecurityGroup$EC2SecurityGroupOwnerId": " The AWS ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field.
The elastic IP (EIP) address for the cluster.
", + "ElasticIpStatus$Status": "The status of the elastic IP (EIP) address.
", + "EnableLoggingMessage$ClusterIdentifier": "The identifier of the cluster on which logging is to be started.
Example: examplecluster
The name of an existing S3 bucket where the log files are to be stored.
Constraints:
The prefix applied to the log file names.
Constraints:
The unique identifier of the source cluster to copy snapshots from.
Constraints: Must be the valid name of an existing cluster that does not already have cross-region snapshot copy enabled.
", + "EnableSnapshotCopyMessage$DestinationRegion": "The destination region that you want to copy snapshots to.
Constraints: Must be the name of a valid region. For more information, see Regions and Endpoints in the Amazon Web Services General Reference.
", + "EnableSnapshotCopyMessage$SnapshotCopyGrantName": "The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region.
", + "Endpoint$Address": "The DNS address of the Cluster.
", + "Event$SourceIdentifier": "The identifier for the source of the event.
", + "Event$Message": "The text of this event.
", + "Event$Severity": "The severity of the event.
Values: ERROR, INFO
", + "Event$EventId": "The identifier of the event.
", + "EventCategoriesList$member": null, + "EventCategoriesMap$SourceType": "The source type, such as cluster or cluster-snapshot, that the returned categories belong to.
", + "EventInfoMap$EventId": "The identifier of an Amazon Redshift event.
", + "EventInfoMap$EventDescription": "The description of an Amazon Redshift event.
", + "EventInfoMap$Severity": "The severity of the event.
Values: ERROR, INFO
", + "EventSubscription$CustomerAwsId": "The AWS customer account associated with the Amazon Redshift event notification subscription.
", + "EventSubscription$CustSubscriptionId": "The name of the Amazon Redshift event notification subscription.
", + "EventSubscription$SnsTopicArn": "The Amazon Resource Name (ARN) of the Amazon SNS topic used by the event notification subscription.
", + "EventSubscription$Status": "The status of the Amazon Redshift event notification subscription.
Constraints:
The source type of the events returned the Amazon Redshift event notification, such as cluster, or cluster-snapshot.
", + "EventSubscription$Severity": "The event severity specified in the Amazon Redshift event notification subscription.
Values: ERROR, INFO
", + "EventSubscriptionsMessage$Marker": " A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
The identifier of the HSM client certificate.
", + "HsmClientCertificate$HsmClientCertificatePublicKey": "The public key that the Amazon Redshift cluster will use to connect to the HSM. You must register the public key in the HSM.
", + "HsmClientCertificateMessage$Marker": " A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
The name of the Amazon Redshift HSM configuration.
", + "HsmConfiguration$Description": "A text description of the HSM configuration.
", + "HsmConfiguration$HsmIpAddress": "The IP address that the Amazon Redshift cluster must use to access the HSM.
", + "HsmConfiguration$HsmPartitionName": "The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys.
", + "HsmConfigurationMessage$Marker": " A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
", + "HsmStatus$HsmConfigurationIdentifier": "Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.
", + "HsmStatus$Status": "Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command.
Values: active, applying
", + "IPRange$Status": "The status of the IP range, for example, \"authorized\".
", + "IPRange$CIDRIP": "The IP range in Classless Inter-Domain Routing (CIDR) notation.
", + "IamRoleArnList$member": null, + "ImportTablesCompleted$member": null, + "ImportTablesInProgress$member": null, + "ImportTablesNotStarted$member": null, + "LoggingStatus$BucketName": "The name of the S3 bucket where the log files are stored.
", + "LoggingStatus$S3KeyPrefix": "The prefix applied to the log file names.
", + "LoggingStatus$LastFailureMessage": "The message indicating that logs failed to be delivered.
", + "ModifyClusterIamRolesMessage$ClusterIdentifier": "The unique identifier of the cluster for which you want to associate or disassociate IAM roles.
", + "ModifyClusterMessage$ClusterIdentifier": "The unique identifier of the cluster to be modified.
Example: examplecluster
The new cluster type.
When you submit your cluster resize request, your existing cluster goes into a read-only mode. After Amazon Redshift provisions a new cluster based on your resize requirements, there will be outage for a period while the old cluster is deleted and your connection is switched to the new cluster. You can use DescribeResize to track the progress of the resize request.
Valid Values: multi-node | single-node
The new node type of the cluster. If you specify a new node type, you must also specify the number of nodes parameter.
When you submit your request to resize a cluster, Amazon Redshift sets access permissions for the cluster to read-only. After Amazon Redshift provisions a new cluster according to your resize requirements, there will be a temporary outage while the old cluster is deleted and your connection is switched to the new cluster. When the new connection is complete, the original access permissions for the cluster are restored. You can use DescribeResize to track the progress of the resize request.
Valid Values: ds1.xlarge | ds1.8xlarge | ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge.
The new password for the cluster master user. This change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.
Default: Uses existing setting.
Constraints:
The name of the cluster parameter group to apply to this cluster. This change is applied only after the cluster is rebooted. To reboot a cluster use RebootCluster.
Default: Uses existing setting.
Constraints: The cluster parameter group must be in the same parameter group family that matches the cluster version.
", + "ModifyClusterMessage$PreferredMaintenanceWindow": "The weekly time range (in UTC) during which system maintenance can occur, if necessary. If system maintenance is necessary during the window, it may result in an outage.
This maintenance window change is made immediately. If the new maintenance window indicates the current time, there must be at least 120 minutes between the current time and end of the window in order to ensure that pending changes are applied.
Default: Uses existing setting.
Format: ddd:hh24:mi-ddd:hh24:mi, for example wed:07:30-wed:08:00.
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Must be at least 30 minutes.
", + "ModifyClusterMessage$ClusterVersion": "The new version number of the Amazon Redshift engine to upgrade to.
For major version upgrades, if a non-default cluster parameter group is currently in use, a new cluster parameter group in the cluster parameter group family for the new version must be specified. The new cluster parameter group can be the default for that cluster parameter group family. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
Example: 1.0
Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
", + "ModifyClusterMessage$HsmConfigurationIdentifier": "Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.
", + "ModifyClusterMessage$NewClusterIdentifier": "The new identifier for the cluster.
Constraints:
Example: examplecluster
The Elastic IP (EIP) address for the cluster.
Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. For more information about provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide.
", + "ModifyClusterParameterGroupMessage$ParameterGroupName": "The name of the parameter group to be modified.
", + "ModifyClusterSubnetGroupMessage$ClusterSubnetGroupName": "The name of the subnet group to be modified.
", + "ModifyClusterSubnetGroupMessage$Description": "A text description of the subnet group to be modified.
", + "ModifyEventSubscriptionMessage$SubscriptionName": "The name of the modified Amazon Redshift event notification subscription.
", + "ModifyEventSubscriptionMessage$SnsTopicArn": "The Amazon Resource Name (ARN) of the SNS topic to be used by the event notification subscription.
", + "ModifyEventSubscriptionMessage$SourceType": "The type of source that will be generating the events. For example, if you want to be notified of events generated by a cluster, you would set this parameter to cluster. If this value is not specified, events are returned for all Amazon Redshift objects in your AWS account. You must specify a source type in order to specify source IDs.
Valid values: cluster, cluster-parameter-group, cluster-security-group, and cluster-snapshot.
", + "ModifyEventSubscriptionMessage$Severity": "Specifies the Amazon Redshift event severity to be published by the event notification subscription.
Values: ERROR, INFO
", + "ModifySnapshotCopyRetentionPeriodMessage$ClusterIdentifier": "The unique identifier of the cluster for which you want to change the retention period for automated snapshots that are copied to a destination region.
Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled.
", + "OrderableClusterOption$ClusterVersion": "The version of the orderable cluster.
", + "OrderableClusterOption$ClusterType": " The cluster type, for example multi-node.
The node type for the orderable cluster.
", + "OrderableClusterOptionsMessage$Marker": " A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
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 value, such as \"engine-default\" or \"user\".
", + "Parameter$DataType": "The data type of the parameter.
", + "Parameter$AllowedValues": "The valid range of values for the parameter.
", + "Parameter$MinimumEngineVersion": "The earliest engine version to which the parameter can apply.
", + "PendingModifiedValues$MasterUserPassword": "The pending or in-progress change of the master user password for the cluster.
", + "PendingModifiedValues$NodeType": "The pending or in-progress change of the cluster's node type.
", + "PendingModifiedValues$ClusterType": "The pending or in-progress change of the cluster type.
", + "PendingModifiedValues$ClusterVersion": "The pending or in-progress change of the service version.
", + "PendingModifiedValues$ClusterIdentifier": "The pending or in-progress change of the new identifier for the cluster.
", + "PurchaseReservedNodeOfferingMessage$ReservedNodeOfferingId": "The unique identifier of the reserved node offering you want to purchase.
", + "RebootClusterMessage$ClusterIdentifier": "The cluster identifier.
", + "RecurringCharge$RecurringChargeFrequency": "The frequency at which the recurring charge amount is applied.
", + "ReservedNode$ReservedNodeId": "The unique identifier for the reservation.
", + "ReservedNode$ReservedNodeOfferingId": "The identifier for the reserved node offering.
", + "ReservedNode$NodeType": "The node type of the reserved node.
", + "ReservedNode$CurrencyCode": "The currency code for the reserved cluster.
", + "ReservedNode$State": "The state of the reserved compute node.
Possible Values:
The anticipated utilization of the reserved node, as defined in the reserved node offering.
", + "ReservedNodeOffering$ReservedNodeOfferingId": "The offering identifier.
", + "ReservedNodeOffering$NodeType": "The node type offered by the reserved node offering.
", + "ReservedNodeOffering$CurrencyCode": "The currency code for the compute nodes offering.
", + "ReservedNodeOffering$OfferingType": "The anticipated utilization of the reserved node, as defined in the reserved node offering.
", + "ReservedNodeOfferingsMessage$Marker": " A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
The name of the cluster parameter group to be reset.
", + "ResizeProgressMessage$TargetNodeType": "The node type that the cluster will have after the resize operation is complete.
", + "ResizeProgressMessage$TargetClusterType": "The cluster type after the resize operation is complete.
Valid Values: multi-node | single-node
The status of the resize operation.
Valid Values: NONE | IN_PROGRESS | FAILED | SUCCEEDED
The identifier of the cluster that will be created from restoring the snapshot.
Constraints:
The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive.
Example: my-snapshot-id
The name of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.
", + "RestoreFromClusterSnapshotMessage$AvailabilityZone": "The Amazon EC2 Availability Zone in which to restore the cluster.
Default: A random, system-chosen Availability Zone.
Example: us-east-1a
The name of the subnet group where you want to cluster restored.
A snapshot of cluster in VPC can be restored only in VPC. Therefore, you must provide subnet group name where you want the cluster restored.
", + "RestoreFromClusterSnapshotMessage$OwnerAccount": "The AWS customer account used to create or copy the snapshot. Required if you are restoring a snapshot you do not own, optional if you own the snapshot.
", + "RestoreFromClusterSnapshotMessage$HsmClientCertificateIdentifier": "Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
", + "RestoreFromClusterSnapshotMessage$HsmConfigurationIdentifier": "Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.
", + "RestoreFromClusterSnapshotMessage$ElasticIp": "The elastic IP (EIP) address for the cluster.
", + "RestoreFromClusterSnapshotMessage$ClusterParameterGroupName": "The name of the parameter group to be associated with this cluster.
Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups.
Constraints:
The weekly time range (in UTC) during which automated cluster maintenance can occur.
Format: ddd:hh24:mi-ddd:hh24:mi
Default: The value selected for the cluster from which the snapshot was taken. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide.
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Minimum 30-minute window.
", + "RestoreFromClusterSnapshotMessage$KmsKeyId": "The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster that you restore from a shared snapshot.
", + "RestoreFromClusterSnapshotMessage$NodeType": "The node type that the restored cluster will be provisioned with.
Default: The node type of the cluster from which the snapshot was taken. You can modify this if you are using any DS node type. In that case, you can choose to restore into another DS node type of the same size. For example, you can restore ds1.8xlarge into ds2.8xlarge, or ds2.xlarge into ds1.xlarge. If you have a DC instance type, you must restore into that same instance type and size. In other words, you can only restore a dc1.large instance type into another dc1.large instance type. For more information about node types, see About Clusters and Nodes in the Amazon Redshift Cluster Management Guide
", + "RestoreFromClusterSnapshotMessage$AdditionalInfo": "Reserved.
", + "RestoreStatus$Status": "The status of the restore action. Returns starting, restoring, completed, or failed.
", + "RestoreTableFromClusterSnapshotMessage$ClusterIdentifier": "The identifier of the Amazon Redshift cluster to restore the table to.
", + "RestoreTableFromClusterSnapshotMessage$SnapshotIdentifier": "The identifier of the snapshot to restore the table from. This snapshot must have been created from the Amazon Redshift cluster specified by the ClusterIdentifier parameter.
The name of the source database that contains the table to restore from.
", + "RestoreTableFromClusterSnapshotMessage$SourceSchemaName": "The name of the source schema that contains the table to restore from. If you do not specify a SourceSchemaName value, the default is public.
The name of the source table to restore from.
", + "RestoreTableFromClusterSnapshotMessage$TargetDatabaseName": "The name of the database to restore the table to.
", + "RestoreTableFromClusterSnapshotMessage$TargetSchemaName": "The name of the schema to restore the table to.
", + "RestoreTableFromClusterSnapshotMessage$NewTableName": "The name of the table to create as a result of the current request.
", + "RevokeClusterSecurityGroupIngressMessage$ClusterSecurityGroupName": "The name of the security Group from which to revoke the ingress rule.
", + "RevokeClusterSecurityGroupIngressMessage$CIDRIP": " The IP range for which to revoke access. This range must be a valid Classless Inter-Domain Routing (CIDR) block of IP addresses. If CIDRIP is specified, EC2SecurityGroupName and EC2SecurityGroupOwnerId cannot be provided.
The name of the EC2 Security Group whose access is to be revoked. If EC2SecurityGroupName is specified, EC2SecurityGroupOwnerId must also be provided and CIDRIP cannot be provided.
The AWS account number of the owner of the security group specified in the EC2SecurityGroupName parameter. The AWS access key ID is not an acceptable value. If EC2SecurityGroupOwnerId is specified, EC2SecurityGroupName must also be provided. and CIDRIP cannot be provided.
Example: 111122223333
The identifier of the snapshot that the account can no longer access.
", + "RevokeSnapshotAccessMessage$SnapshotClusterIdentifier": "The identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.
", + "RevokeSnapshotAccessMessage$AccountWithRestoreAccess": "The identifier of the AWS customer account that can no longer restore the specified snapshot.
", + "RotateEncryptionKeyMessage$ClusterIdentifier": "The unique identifier of the cluster that you want to rotate the encryption keys for.
Constraints: Must be the name of valid cluster that has encryption enabled.
", + "Snapshot$SnapshotIdentifier": "The snapshot identifier that is provided in the request.
", + "Snapshot$ClusterIdentifier": "The identifier of the cluster for which the snapshot was taken.
", + "Snapshot$Status": "The snapshot status. The value of the status depends on the API operation used.
The Availability Zone in which the cluster was created.
", + "Snapshot$MasterUsername": "The master user name for the cluster.
", + "Snapshot$ClusterVersion": "The version ID of the Amazon Redshift engine that is running on the cluster.
", + "Snapshot$SnapshotType": "The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot will be of type \"manual\".
", + "Snapshot$NodeType": "The node type of the nodes in the cluster.
", + "Snapshot$DBName": "The name of the database that was created when the cluster was created.
", + "Snapshot$VpcId": "The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field is not in the output.
", + "Snapshot$KmsKeyId": "The AWS Key Management Service (KMS) key ID of the encryption key that was used to encrypt data in the cluster from which the snapshot was taken.
", + "Snapshot$OwnerAccount": "For manual snapshots, the AWS customer account used to create or copy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform all snapshot actions, such as sharing a manual snapshot.
", + "Snapshot$SourceRegion": "The source region from which the snapshot was copied.
", + "SnapshotCopyGrant$SnapshotCopyGrantName": "The name of the snapshot copy grant.
", + "SnapshotCopyGrant$KmsKeyId": "The unique identifier of the customer master key (CMK) in AWS KMS to which Amazon Redshift is granted permission.
", + "SnapshotCopyGrantMessage$Marker": " An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeSnapshotCopyGrant request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
Constraints: You can specify either the SnapshotCopyGrantName parameter or the Marker parameter, but not both.
", + "SnapshotMessage$Marker": " A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
The identifier of the subnet.
", + "Subnet$SubnetStatus": "The status of the subnet.
", + "SubnetIdentifierList$member": null, + "TableRestoreStatus$TableRestoreRequestId": "The unique identifier for the table restore request.
", + "TableRestoreStatus$Message": "A description of the status of the table restore request. Status values include SUCCEEDED, FAILED, CANCELED, PENDING, IN_PROGRESS.
The identifier of the Amazon Redshift cluster that the table is being restored to.
", + "TableRestoreStatus$SnapshotIdentifier": "The identifier of the snapshot that the table is being restored from.
", + "TableRestoreStatus$SourceDatabaseName": "The name of the source database that contains the table being restored.
", + "TableRestoreStatus$SourceSchemaName": "The name of the source schema that contains the table being restored.
", + "TableRestoreStatus$SourceTableName": "The name of the source table being restored.
", + "TableRestoreStatus$TargetDatabaseName": "The name of the database to restore the table to.
", + "TableRestoreStatus$TargetSchemaName": "The name of the schema to restore the table to.
", + "TableRestoreStatus$NewTableName": "The name of the table to create as a result of the table restore request.
", + "TableRestoreStatusMessage$Marker": "A pagination token that can be used in a subsequent DescribeTableRestoreStatus request.
", + "Tag$Key": "The key, or name, for the resource tag.
", + "Tag$Value": "The value for the resource tag.
", + "TagKeyList$member": null, + "TagValueList$member": null, + "TaggedResource$ResourceName": "The Amazon Resource Name (ARN) with which the tag is associated. For example, arn:aws:redshift:us-east-1:123456789:cluster:t1.
The type of resource with which the tag is associated. Valid resource types are:
For more information about Amazon Redshift resource types and constructing ARNs, go to Constructing an Amazon Redshift Amazon Resource Name (ARN) in the Amazon Redshift Cluster Management Guide.
", + "TaggedResourceListMessage$Marker": " A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
The identifier of the VPC security group.
", + "VpcSecurityGroupMembership$Status": "The status of the VPC security group.
" + } + }, + "Subnet": { + "base": "Describes a subnet.
", + "refs": { + "SubnetList$member": null + } + }, + "SubnetAlreadyInUse": { + "base": "A specified subnet is already in use by another cluster.
", + "refs": { + } + }, + "SubnetIdentifierList": { + "base": null, + "refs": { + "CreateClusterSubnetGroupMessage$SubnetIds": "An array of VPC subnet IDs. A maximum of 20 subnets can be modified in a single request.
", + "ModifyClusterSubnetGroupMessage$SubnetIds": "An array of VPC subnet IDs. A maximum of 20 subnets can be modified in a single request.
" + } + }, + "SubnetList": { + "base": null, + "refs": { + "ClusterSubnetGroup$Subnets": "A list of the VPC Subnet elements.
" + } + }, + "SubscriptionAlreadyExistFault": { + "base": "There is already an existing event notification subscription with the specified name.
", + "refs": { + } + }, + "SubscriptionCategoryNotFoundFault": { + "base": "The value specified for the event category was not one of the allowed values, or it specified a category that does not apply to the specified source type. The allowed values are Configuration, Management, Monitoring, and Security.
", + "refs": { + } + }, + "SubscriptionEventIdNotFoundFault": { + "base": "An Amazon Redshift event with the specified event ID does not exist.
", + "refs": { + } + }, + "SubscriptionNotFoundFault": { + "base": "An Amazon Redshift event notification subscription with the specified name does not exist.
", + "refs": { + } + }, + "SubscriptionSeverityNotFoundFault": { + "base": "The value specified for the event severity was not one of the allowed values, or it specified a severity that does not apply to the specified source type. The allowed values are ERROR and INFO.
", + "refs": { + } + }, + "TStamp": { + "base": null, + "refs": { + "Cluster$ClusterCreateTime": "The date and time that the cluster was created.
", + "DescribeClusterSnapshotsMessage$StartTime": "A value that requests only snapshots created at or after the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2012-07-16T18:00:00Z
A time value that requests only snapshots created at or before the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2012-07-16T18:00:00Z
The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2009-07-08T18:00Z
The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2009-07-08T18:00Z
The date and time of the event.
", + "EventSubscription$SubscriptionCreationTime": "The date and time the Amazon Redshift event notification subscription was created.
", + "LoggingStatus$LastSuccessfulDeliveryTime": "The last time that logs were delivered.
", + "LoggingStatus$LastFailureTime": "The last time when logs failed to be delivered.
", + "ReservedNode$StartTime": "The time the reservation started. You purchase a reserved node offering for a duration. This is the start time of that duration.
", + "Snapshot$SnapshotCreateTime": "The time (UTC) when Amazon Redshift began the snapshot. A snapshot contains a copy of the cluster data as of this exact time.
", + "Snapshot$ClusterCreateTime": "The time (UTC) when the cluster was originally created.
", + "TableRestoreStatus$RequestTime": "The time that the table restore request was made, in Universal Coordinated Time (UTC).
" + } + }, + "TableRestoreNotFoundFault": { + "base": "The specified TableRestoreRequestId value was not found.
Describes the status of a RestoreTableFromClusterSnapshot operation.
", + "refs": { + "RestoreTableFromClusterSnapshotResult$TableRestoreStatus": null, + "TableRestoreStatusList$member": null + } + }, + "TableRestoreStatusList": { + "base": null, + "refs": { + "TableRestoreStatusMessage$TableRestoreStatusDetails": "A list of status details for one or more table restore requests.
" + } + }, + "TableRestoreStatusMessage": { + "base": null, + "refs": { + } + }, + "TableRestoreStatusType": { + "base": null, + "refs": { + "TableRestoreStatus$Status": "A value that describes the current state of the table restore request.
Valid Values: SUCCEEDED, FAILED, CANCELED, PENDING, IN_PROGRESS
A tag consisting of a name/value pair for a resource.
", + "refs": { + "TagList$member": null, + "TaggedResource$Tag": "The tag for the resource.
" + } + }, + "TagKeyList": { + "base": null, + "refs": { + "DeleteTagsMessage$TagKeys": "The tag key that you want to delete.
", + "DescribeClusterParameterGroupsMessage$TagKeys": "A tag key or keys for which you want to return all matching cluster parameter groups that are associated with the specified key or keys. For example, suppose that you have parameter groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag keys associated with them.
A tag key or keys for which you want to return all matching cluster security groups that are associated with the specified key or keys. For example, suppose that you have security groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the security groups that have either or both of these tag keys associated with them.
A tag key or keys for which you want to return all matching cluster snapshots that are associated with the specified key or keys. For example, suppose that you have snapshots that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the snapshots that have either or both of these tag keys associated with them.
A tag key or keys for which you want to return all matching cluster subnet groups that are associated with the specified key or keys. For example, suppose that you have subnet groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the subnet groups that have either or both of these tag keys associated with them.
A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.
A tag key or keys for which you want to return all matching HSM client certificates that are associated with the specified key or keys. For example, suppose that you have HSM client certificates that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the HSM client certificates that have either or both of these tag keys associated with them.
A tag key or keys for which you want to return all matching HSM configurations that are associated with the specified key or keys. For example, suppose that you have HSM configurations that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the HSM configurations that have either or both of these tag keys associated with them.
A tag key or keys for which you want to return all matching resources that are associated with the specified key or keys. For example, suppose that you have resources tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with all resources that have either or both of these tag keys associated with them.
A tag key or keys for which you want to return all matching resources that are associated with the specified key or keys. For example, suppose that you have resources tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with all resources that have either or both of these tag keys associated with them.
The request exceeds the limit of 10 tags for the resource.
", + "refs": { + } + }, + "TagList": { + "base": null, + "refs": { + "Cluster$Tags": "The list of tags for the cluster.
", + "ClusterParameterGroup$Tags": "The list of tags for the cluster parameter group.
", + "ClusterSecurityGroup$Tags": "The list of tags for the cluster security group.
", + "ClusterSubnetGroup$Tags": "The list of tags for the cluster subnet group.
", + "CreateClusterMessage$Tags": "A list of tag instances.
", + "CreateClusterParameterGroupMessage$Tags": "A list of tag instances.
", + "CreateClusterSecurityGroupMessage$Tags": "A list of tag instances.
", + "CreateClusterSnapshotMessage$Tags": "A list of tag instances.
", + "CreateClusterSubnetGroupMessage$Tags": "A list of tag instances.
", + "CreateEventSubscriptionMessage$Tags": "A list of tag instances.
", + "CreateHsmClientCertificateMessage$Tags": "A list of tag instances.
", + "CreateHsmConfigurationMessage$Tags": "A list of tag instances.
", + "CreateSnapshotCopyGrantMessage$Tags": "A list of tag instances.
", + "CreateTagsMessage$Tags": " One or more name/value pairs to add as tags to the specified resource. Each tag name is passed in with the parameter Key and the corresponding value is passed in with the parameter Value. The Key and Value parameters are separated by a comma (,). Separate multiple tags with a space. For example, --tags \"Key\"=\"owner\",\"Value\"=\"admin\" \"Key\"=\"environment\",\"Value\"=\"test\" \"Key\"=\"version\",\"Value\"=\"1.0\".
The list of tags for the EC2 security group.
", + "EventSubscription$Tags": "The list of tags for the event subscription.
", + "HsmClientCertificate$Tags": "The list of tags for the HSM client certificate.
", + "HsmConfiguration$Tags": "The list of tags for the HSM configuration.
", + "IPRange$Tags": "The list of tags for the IP range.
", + "Snapshot$Tags": "The list of tags for the cluster snapshot.
", + "SnapshotCopyGrant$Tags": "A list of tag instances.
" + } + }, + "TagValueList": { + "base": null, + "refs": { + "DescribeClusterParameterGroupsMessage$TagValues": "A tag value or values for which you want to return all matching cluster parameter groups that are associated with the specified tag value or values. For example, suppose that you have parameter groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag values associated with them.
A tag value or values for which you want to return all matching cluster security groups that are associated with the specified tag value or values. For example, suppose that you have security groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the security groups that have either or both of these tag values associated with them.
A tag value or values for which you want to return all matching cluster snapshots that are associated with the specified tag value or values. For example, suppose that you have snapshots that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the snapshots that have either or both of these tag values associated with them.
A tag value or values for which you want to return all matching cluster subnet groups that are associated with the specified tag value or values. For example, suppose that you have subnet groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the subnet groups that have either or both of these tag values associated with them.
A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.
A tag value or values for which you want to return all matching HSM client certificates that are associated with the specified tag value or values. For example, suppose that you have HSM client certificates that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the HSM client certificates that have either or both of these tag values associated with them.
A tag value or values for which you want to return all matching HSM configurations that are associated with the specified tag value or values. For example, suppose that you have HSM configurations that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the HSM configurations that have either or both of these tag values associated with them.
A tag value or values for which you want to return all matching resources that are associated with the specified value or values. For example, suppose that you have resources tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with all resources that have either or both of these tag values associated with them.
A tag value or values for which you want to return all matching resources that are associated with the specified value or values. For example, suppose that you have resources tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with all resources that have either or both of these tag values associated with them.
A tag and its associated resource.
", + "refs": { + "TaggedResourceList$member": null + } + }, + "TaggedResourceList": { + "base": null, + "refs": { + "TaggedResourceListMessage$TaggedResources": "A list of tags with their associated resources.
" + } + }, + "TaggedResourceListMessage": { + "base": "", + "refs": { + } + }, + "UnauthorizedOperation": { + "base": "Your account is not authorized to perform the requested operation.
", + "refs": { + } + }, + "UnknownSnapshotCopyRegionFault": { + "base": "The specified region is incorrect or does not exist.
", + "refs": { + } + }, + "UnsupportedOperationFault": { + "base": "The requested operation isn't supported.
", + "refs": { + } + }, + "UnsupportedOptionFault": { + "base": "A request option was specified that is not supported.
", + "refs": { + } + }, + "VpcSecurityGroupIdList": { + "base": null, + "refs": { + "CreateClusterMessage$VpcSecurityGroupIds": "A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.
Default: The default VPC security group is associated with the cluster.
", + "ModifyClusterMessage$VpcSecurityGroupIds": "A list of virtual private cloud (VPC) security groups to be associated with the cluster.
", + "RestoreFromClusterSnapshotMessage$VpcSecurityGroupIds": "A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.
Default: The default VPC security group is associated with the cluster.
VPC security groups only apply to clusters in VPCs.
" + } + }, + "VpcSecurityGroupMembership": { + "base": "Describes the members of a VPC security group.
", + "refs": { + "VpcSecurityGroupMembershipList$member": null + } + }, + "VpcSecurityGroupMembershipList": { + "base": null, + "refs": { + "Cluster$VpcSecurityGroups": "A list of Virtual Private Cloud (VPC) security groups that are associated with the cluster. This parameter is returned only if the cluster is in a VPC.
" + } + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/redshift/2012-12-01/examples-1.json b/vendor/github.com/aws/aws-sdk-go/models/apis/redshift/2012-12-01/examples-1.json new file mode 100644 index 000000000..0ea7e3b0b --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/redshift/2012-12-01/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/redshift/2012-12-01/paginators-1.json b/vendor/github.com/aws/aws-sdk-go/models/apis/redshift/2012-12-01/paginators-1.json new file mode 100644 index 000000000..03027de35 --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/redshift/2012-12-01/paginators-1.json @@ -0,0 +1,94 @@ +{ + "pagination": { + "DescribeClusterParameterGroups": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "ParameterGroups" + }, + "DescribeClusterParameters": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "Parameters" + }, + "DescribeClusterSecurityGroups": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "ClusterSecurityGroups" + }, + "DescribeClusterSnapshots": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "Snapshots" + }, + "DescribeClusterSubnetGroups": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "ClusterSubnetGroups" + }, + "DescribeClusterVersions": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "ClusterVersions" + }, + "DescribeClusters": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "Clusters" + }, + "DescribeDefaultClusterParameters": { + "input_token": "Marker", + "output_token": "DefaultClusterParameters.Marker", + "limit_key": "MaxRecords", + "result_key": "DefaultClusterParameters.Parameters" + }, + "DescribeEventSubscriptions": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "EventSubscriptionsList" + }, + "DescribeEvents": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "Events" + }, + "DescribeHsmClientCertificates": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "HsmClientCertificates" + }, + "DescribeHsmConfigurations": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "HsmConfigurations" + }, + "DescribeOrderableClusterOptions": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "OrderableClusterOptions" + }, + "DescribeReservedNodeOfferings": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "ReservedNodeOfferings" + }, + "DescribeReservedNodes": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "ReservedNodes" + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/redshift/2012-12-01/waiters-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/redshift/2012-12-01/waiters-2.json new file mode 100644 index 000000000..3efd9e5b2 --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/redshift/2012-12-01/waiters-2.json @@ -0,0 +1,97 @@ +{ + "version": 2, + "waiters": { + "ClusterAvailable": { + "delay": 60, + "operation": "DescribeClusters", + "maxAttempts": 30, + "acceptors": [ + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "Clusters[].ClusterStatus" + }, + { + "expected": "deleting", + "matcher": "pathAny", + "state": "failure", + "argument": "Clusters[].ClusterStatus" + }, + { + "expected": "ClusterNotFound", + "matcher": "error", + "state": "retry" + } + ] + }, + "ClusterDeleted": { + "delay": 60, + "operation": "DescribeClusters", + "maxAttempts": 30, + "acceptors": [ + { + "expected": "ClusterNotFound", + "matcher": "error", + "state": "success" + }, + { + "expected": "creating", + "matcher": "pathAny", + "state": "failure", + "argument": "Clusters[].ClusterStatus" + }, + { + "expected": "pathAny", + "matcher": "pathList", + "state": "failure", + "argument": "Clusters[].ClusterStatus" + } + ] + }, + "ClusterRestored": { + "operation": "DescribeClusters", + "maxAttempts": 30, + "delay": 60, + "acceptors": [ + { + "state": "success", + "matcher": "pathAll", + "argument": "Clusters[].RestoreStatus.Status", + "expected": "completed" + }, + { + "state": "failure", + "matcher": "pathAny", + "argument": "Clusters[].ClusterStatus", + "expected": "deleting" + } + ] + }, + "SnapshotAvailable": { + "delay": 15, + "operation": "DescribeClusterSnapshots", + "maxAttempts": 20, + "acceptors": [ + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "Snapshots[].Status" + }, + { + "expected": "failed", + "matcher": "pathAny", + "state": "failure", + "argument": "Snapshots[].Status" + }, + { + "expected": "deleted", + "matcher": "pathAny", + "state": "failure", + "argument": "Snapshots[].Status" + } + ] + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/route53/2013-04-01/api-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/route53/2013-04-01/api-2.json new file mode 100644 index 000000000..0d6707610 --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/route53/2013-04-01/api-2.json @@ -0,0 +1,3245 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2013-04-01", + "endpointPrefix":"route53", + "globalEndpoint":"route53.amazonaws.com", + "protocol":"rest-xml", + "serviceAbbreviation":"Route 53", + "serviceFullName":"Amazon Route 53", + "signatureVersion":"v4" + }, + "operations":{ + "AssociateVPCWithHostedZone":{ + "name":"AssociateVPCWithHostedZone", + "http":{ + "method":"POST", + "requestUri":"/2013-04-01/hostedzone/{Id}/associatevpc" + }, + "input":{ + "shape":"AssociateVPCWithHostedZoneRequest", + "locationName":"AssociateVPCWithHostedZoneRequest", + "xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"} + }, + "output":{"shape":"AssociateVPCWithHostedZoneResponse"}, + "errors":[ + {"shape":"NoSuchHostedZone"}, + {"shape":"InvalidVPCId"}, + {"shape":"InvalidInput"}, + {"shape":"PublicZoneVPCAssociation"}, + {"shape":"ConflictingDomainExists"}, + {"shape":"LimitsExceeded"} + ] + }, + "ChangeResourceRecordSets":{ + "name":"ChangeResourceRecordSets", + "http":{ + "method":"POST", + "requestUri":"/2013-04-01/hostedzone/{Id}/rrset/" + }, + "input":{ + "shape":"ChangeResourceRecordSetsRequest", + "locationName":"ChangeResourceRecordSetsRequest", + "xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"} + }, + "output":{"shape":"ChangeResourceRecordSetsResponse"}, + "errors":[ + {"shape":"NoSuchHostedZone"}, + {"shape":"NoSuchHealthCheck"}, + {"shape":"InvalidChangeBatch"}, + {"shape":"InvalidInput"}, + {"shape":"PriorRequestNotComplete"} + ] + }, + "ChangeTagsForResource":{ + "name":"ChangeTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/2013-04-01/tags/{ResourceType}/{ResourceId}" + }, + "input":{ + "shape":"ChangeTagsForResourceRequest", + "locationName":"ChangeTagsForResourceRequest", + "xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"} + }, + "output":{"shape":"ChangeTagsForResourceResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"NoSuchHealthCheck"}, + {"shape":"NoSuchHostedZone"}, + {"shape":"PriorRequestNotComplete"}, + {"shape":"ThrottlingException"} + ] + }, + "CreateHealthCheck":{ + "name":"CreateHealthCheck", + "http":{ + "method":"POST", + "requestUri":"/2013-04-01/healthcheck", + "responseCode":201 + }, + "input":{ + "shape":"CreateHealthCheckRequest", + "locationName":"CreateHealthCheckRequest", + "xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"} + }, + "output":{"shape":"CreateHealthCheckResponse"}, + "errors":[ + {"shape":"TooManyHealthChecks"}, + {"shape":"HealthCheckAlreadyExists"}, + {"shape":"InvalidInput"} + ] + }, + "CreateHostedZone":{ + "name":"CreateHostedZone", + "http":{ + "method":"POST", + "requestUri":"/2013-04-01/hostedzone", + "responseCode":201 + }, + "input":{ + "shape":"CreateHostedZoneRequest", + "locationName":"CreateHostedZoneRequest", + "xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"} + }, + "output":{"shape":"CreateHostedZoneResponse"}, + "errors":[ + {"shape":"InvalidDomainName"}, + {"shape":"HostedZoneAlreadyExists"}, + {"shape":"TooManyHostedZones"}, + {"shape":"InvalidVPCId"}, + {"shape":"InvalidInput"}, + {"shape":"DelegationSetNotAvailable"}, + {"shape":"ConflictingDomainExists"}, + {"shape":"NoSuchDelegationSet"}, + {"shape":"DelegationSetNotReusable"} + ] + }, + "CreateReusableDelegationSet":{ + "name":"CreateReusableDelegationSet", + "http":{ + "method":"POST", + "requestUri":"/2013-04-01/delegationset", + "responseCode":201 + }, + "input":{ + "shape":"CreateReusableDelegationSetRequest", + "locationName":"CreateReusableDelegationSetRequest", + "xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"} + }, + "output":{"shape":"CreateReusableDelegationSetResponse"}, + "errors":[ + {"shape":"DelegationSetAlreadyCreated"}, + {"shape":"LimitsExceeded"}, + {"shape":"HostedZoneNotFound"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidInput"}, + {"shape":"DelegationSetNotAvailable"}, + {"shape":"DelegationSetAlreadyReusable"} + ] + }, + "CreateTrafficPolicy":{ + "name":"CreateTrafficPolicy", + "http":{ + "method":"POST", + "requestUri":"/2013-04-01/trafficpolicy", + "responseCode":201 + }, + "input":{ + "shape":"CreateTrafficPolicyRequest", + "locationName":"CreateTrafficPolicyRequest", + "xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"} + }, + "output":{"shape":"CreateTrafficPolicyResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"TooManyTrafficPolicies"}, + {"shape":"TrafficPolicyAlreadyExists"}, + {"shape":"InvalidTrafficPolicyDocument"} + ] + }, + "CreateTrafficPolicyInstance":{ + "name":"CreateTrafficPolicyInstance", + "http":{ + "method":"POST", + "requestUri":"/2013-04-01/trafficpolicyinstance", + "responseCode":201 + }, + "input":{ + "shape":"CreateTrafficPolicyInstanceRequest", + "locationName":"CreateTrafficPolicyInstanceRequest", + "xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"} + }, + "output":{"shape":"CreateTrafficPolicyInstanceResponse"}, + "errors":[ + {"shape":"NoSuchHostedZone"}, + {"shape":"InvalidInput"}, + {"shape":"TooManyTrafficPolicyInstances"}, + {"shape":"NoSuchTrafficPolicy"}, + {"shape":"TrafficPolicyInstanceAlreadyExists"} + ] + }, + "CreateTrafficPolicyVersion":{ + "name":"CreateTrafficPolicyVersion", + "http":{ + "method":"POST", + "requestUri":"/2013-04-01/trafficpolicy/{Id}", + "responseCode":201 + }, + "input":{ + "shape":"CreateTrafficPolicyVersionRequest", + "locationName":"CreateTrafficPolicyVersionRequest", + "xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"} + }, + "output":{"shape":"CreateTrafficPolicyVersionResponse"}, + "errors":[ + {"shape":"NoSuchTrafficPolicy"}, + {"shape":"InvalidInput"}, + {"shape":"ConcurrentModification"}, + {"shape":"InvalidTrafficPolicyDocument"} + ] + }, + "DeleteHealthCheck":{ + "name":"DeleteHealthCheck", + "http":{ + "method":"DELETE", + "requestUri":"/2013-04-01/healthcheck/{HealthCheckId}" + }, + "input":{"shape":"DeleteHealthCheckRequest"}, + "output":{"shape":"DeleteHealthCheckResponse"}, + "errors":[ + {"shape":"NoSuchHealthCheck"}, + {"shape":"HealthCheckInUse"}, + {"shape":"InvalidInput"} + ] + }, + "DeleteHostedZone":{ + "name":"DeleteHostedZone", + "http":{ + "method":"DELETE", + "requestUri":"/2013-04-01/hostedzone/{Id}" + }, + "input":{"shape":"DeleteHostedZoneRequest"}, + "output":{"shape":"DeleteHostedZoneResponse"}, + "errors":[ + {"shape":"NoSuchHostedZone"}, + {"shape":"HostedZoneNotEmpty"}, + {"shape":"PriorRequestNotComplete"}, + {"shape":"InvalidInput"}, + {"shape":"InvalidDomainName"} + ] + }, + "DeleteReusableDelegationSet":{ + "name":"DeleteReusableDelegationSet", + "http":{ + "method":"DELETE", + "requestUri":"/2013-04-01/delegationset/{Id}" + }, + "input":{"shape":"DeleteReusableDelegationSetRequest"}, + "output":{"shape":"DeleteReusableDelegationSetResponse"}, + "errors":[ + {"shape":"NoSuchDelegationSet"}, + {"shape":"DelegationSetInUse"}, + {"shape":"DelegationSetNotReusable"}, + {"shape":"InvalidInput"} + ] + }, + "DeleteTrafficPolicy":{ + "name":"DeleteTrafficPolicy", + "http":{ + "method":"DELETE", + "requestUri":"/2013-04-01/trafficpolicy/{Id}/{Version}" + }, + "input":{"shape":"DeleteTrafficPolicyRequest"}, + "output":{"shape":"DeleteTrafficPolicyResponse"}, + "errors":[ + {"shape":"NoSuchTrafficPolicy"}, + {"shape":"InvalidInput"}, + {"shape":"TrafficPolicyInUse"}, + {"shape":"ConcurrentModification"} + ] + }, + "DeleteTrafficPolicyInstance":{ + "name":"DeleteTrafficPolicyInstance", + "http":{ + "method":"DELETE", + "requestUri":"/2013-04-01/trafficpolicyinstance/{Id}" + }, + "input":{"shape":"DeleteTrafficPolicyInstanceRequest"}, + "output":{"shape":"DeleteTrafficPolicyInstanceResponse"}, + "errors":[ + {"shape":"NoSuchTrafficPolicyInstance"}, + {"shape":"InvalidInput"}, + {"shape":"PriorRequestNotComplete"} + ] + }, + "DisassociateVPCFromHostedZone":{ + "name":"DisassociateVPCFromHostedZone", + "http":{ + "method":"POST", + "requestUri":"/2013-04-01/hostedzone/{Id}/disassociatevpc" + }, + "input":{ + "shape":"DisassociateVPCFromHostedZoneRequest", + "locationName":"DisassociateVPCFromHostedZoneRequest", + "xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"} + }, + "output":{"shape":"DisassociateVPCFromHostedZoneResponse"}, + "errors":[ + {"shape":"NoSuchHostedZone"}, + {"shape":"InvalidVPCId"}, + {"shape":"VPCAssociationNotFound"}, + {"shape":"LastVPCAssociation"}, + {"shape":"InvalidInput"} + ] + }, + "GetChange":{ + "name":"GetChange", + "http":{ + "method":"GET", + "requestUri":"/2013-04-01/change/{Id}" + }, + "input":{"shape":"GetChangeRequest"}, + "output":{"shape":"GetChangeResponse"}, + "errors":[ + {"shape":"NoSuchChange"}, + {"shape":"InvalidInput"} + ] + }, + "GetChangeDetails":{ + "name":"GetChangeDetails", + "http":{ + "method":"GET", + "requestUri":"/2013-04-01/changedetails/{Id}" + }, + "input":{"shape":"GetChangeDetailsRequest"}, + "output":{"shape":"GetChangeDetailsResponse"}, + "errors":[ + {"shape":"NoSuchChange"}, + {"shape":"InvalidInput"} + ], + "deprecated":true + }, + "GetCheckerIpRanges":{ + "name":"GetCheckerIpRanges", + "http":{ + "method":"GET", + "requestUri":"/2013-04-01/checkeripranges" + }, + "input":{"shape":"GetCheckerIpRangesRequest"}, + "output":{"shape":"GetCheckerIpRangesResponse"} + }, + "GetGeoLocation":{ + "name":"GetGeoLocation", + "http":{ + "method":"GET", + "requestUri":"/2013-04-01/geolocation" + }, + "input":{"shape":"GetGeoLocationRequest"}, + "output":{"shape":"GetGeoLocationResponse"}, + "errors":[ + {"shape":"NoSuchGeoLocation"}, + {"shape":"InvalidInput"} + ] + }, + "GetHealthCheck":{ + "name":"GetHealthCheck", + "http":{ + "method":"GET", + "requestUri":"/2013-04-01/healthcheck/{HealthCheckId}" + }, + "input":{"shape":"GetHealthCheckRequest"}, + "output":{"shape":"GetHealthCheckResponse"}, + "errors":[ + {"shape":"NoSuchHealthCheck"}, + {"shape":"InvalidInput"}, + {"shape":"IncompatibleVersion"} + ] + }, + "GetHealthCheckCount":{ + "name":"GetHealthCheckCount", + "http":{ + "method":"GET", + "requestUri":"/2013-04-01/healthcheckcount" + }, + "input":{"shape":"GetHealthCheckCountRequest"}, + "output":{"shape":"GetHealthCheckCountResponse"} + }, + "GetHealthCheckLastFailureReason":{ + "name":"GetHealthCheckLastFailureReason", + "http":{ + "method":"GET", + "requestUri":"/2013-04-01/healthcheck/{HealthCheckId}/lastfailurereason" + }, + "input":{"shape":"GetHealthCheckLastFailureReasonRequest"}, + "output":{"shape":"GetHealthCheckLastFailureReasonResponse"}, + "errors":[ + {"shape":"NoSuchHealthCheck"}, + {"shape":"InvalidInput"} + ] + }, + "GetHealthCheckStatus":{ + "name":"GetHealthCheckStatus", + "http":{ + "method":"GET", + "requestUri":"/2013-04-01/healthcheck/{HealthCheckId}/status" + }, + "input":{"shape":"GetHealthCheckStatusRequest"}, + "output":{"shape":"GetHealthCheckStatusResponse"}, + "errors":[ + {"shape":"NoSuchHealthCheck"}, + {"shape":"InvalidInput"} + ] + }, + "GetHostedZone":{ + "name":"GetHostedZone", + "http":{ + "method":"GET", + "requestUri":"/2013-04-01/hostedzone/{Id}" + }, + "input":{"shape":"GetHostedZoneRequest"}, + "output":{"shape":"GetHostedZoneResponse"}, + "errors":[ + {"shape":"NoSuchHostedZone"}, + {"shape":"InvalidInput"} + ] + }, + "GetHostedZoneCount":{ + "name":"GetHostedZoneCount", + "http":{ + "method":"GET", + "requestUri":"/2013-04-01/hostedzonecount" + }, + "input":{"shape":"GetHostedZoneCountRequest"}, + "output":{"shape":"GetHostedZoneCountResponse"}, + "errors":[ + {"shape":"InvalidInput"} + ] + }, + "GetReusableDelegationSet":{ + "name":"GetReusableDelegationSet", + "http":{ + "method":"GET", + "requestUri":"/2013-04-01/delegationset/{Id}" + }, + "input":{"shape":"GetReusableDelegationSetRequest"}, + "output":{"shape":"GetReusableDelegationSetResponse"}, + "errors":[ + {"shape":"NoSuchDelegationSet"}, + {"shape":"DelegationSetNotReusable"}, + {"shape":"InvalidInput"} + ] + }, + "GetTrafficPolicy":{ + "name":"GetTrafficPolicy", + "http":{ + "method":"GET", + "requestUri":"/2013-04-01/trafficpolicy/{Id}/{Version}" + }, + "input":{"shape":"GetTrafficPolicyRequest"}, + "output":{"shape":"GetTrafficPolicyResponse"}, + "errors":[ + {"shape":"NoSuchTrafficPolicy"}, + {"shape":"InvalidInput"} + ] + }, + "GetTrafficPolicyInstance":{ + "name":"GetTrafficPolicyInstance", + "http":{ + "method":"GET", + "requestUri":"/2013-04-01/trafficpolicyinstance/{Id}" + }, + "input":{"shape":"GetTrafficPolicyInstanceRequest"}, + "output":{"shape":"GetTrafficPolicyInstanceResponse"}, + "errors":[ + {"shape":"NoSuchTrafficPolicyInstance"}, + {"shape":"InvalidInput"} + ] + }, + "GetTrafficPolicyInstanceCount":{ + "name":"GetTrafficPolicyInstanceCount", + "http":{ + "method":"GET", + "requestUri":"/2013-04-01/trafficpolicyinstancecount" + }, + "input":{"shape":"GetTrafficPolicyInstanceCountRequest"}, + "output":{"shape":"GetTrafficPolicyInstanceCountResponse"} + }, + "ListChangeBatchesByHostedZone":{ + "name":"ListChangeBatchesByHostedZone", + "http":{ + "method":"GET", + "requestUri":"/2013-04-01/hostedzone/{Id}/changes" + }, + "input":{"shape":"ListChangeBatchesByHostedZoneRequest"}, + "output":{"shape":"ListChangeBatchesByHostedZoneResponse"}, + "errors":[ + {"shape":"NoSuchHostedZone"}, + {"shape":"InvalidInput"} + ], + "deprecated":true + }, + "ListChangeBatchesByRRSet":{ + "name":"ListChangeBatchesByRRSet", + "http":{ + "method":"GET", + "requestUri":"/2013-04-01/hostedzone/{Id}/rrsChanges" + }, + "input":{"shape":"ListChangeBatchesByRRSetRequest"}, + "output":{"shape":"ListChangeBatchesByRRSetResponse"}, + "errors":[ + {"shape":"NoSuchHostedZone"}, + {"shape":"InvalidInput"} + ], + "deprecated":true + }, + "ListGeoLocations":{ + "name":"ListGeoLocations", + "http":{ + "method":"GET", + "requestUri":"/2013-04-01/geolocations" + }, + "input":{"shape":"ListGeoLocationsRequest"}, + "output":{"shape":"ListGeoLocationsResponse"}, + "errors":[ + {"shape":"InvalidInput"} + ] + }, + "ListHealthChecks":{ + "name":"ListHealthChecks", + "http":{ + "method":"GET", + "requestUri":"/2013-04-01/healthcheck" + }, + "input":{"shape":"ListHealthChecksRequest"}, + "output":{"shape":"ListHealthChecksResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"IncompatibleVersion"} + ] + }, + "ListHostedZones":{ + "name":"ListHostedZones", + "http":{ + "method":"GET", + "requestUri":"/2013-04-01/hostedzone" + }, + "input":{"shape":"ListHostedZonesRequest"}, + "output":{"shape":"ListHostedZonesResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"NoSuchDelegationSet"}, + {"shape":"DelegationSetNotReusable"} + ] + }, + "ListHostedZonesByName":{ + "name":"ListHostedZonesByName", + "http":{ + "method":"GET", + "requestUri":"/2013-04-01/hostedzonesbyname" + }, + "input":{"shape":"ListHostedZonesByNameRequest"}, + "output":{"shape":"ListHostedZonesByNameResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"InvalidDomainName"} + ] + }, + "ListResourceRecordSets":{ + "name":"ListResourceRecordSets", + "http":{ + "method":"GET", + "requestUri":"/2013-04-01/hostedzone/{Id}/rrset" + }, + "input":{"shape":"ListResourceRecordSetsRequest"}, + "output":{"shape":"ListResourceRecordSetsResponse"}, + "errors":[ + {"shape":"NoSuchHostedZone"}, + {"shape":"InvalidInput"} + ] + }, + "ListReusableDelegationSets":{ + "name":"ListReusableDelegationSets", + "http":{ + "method":"GET", + "requestUri":"/2013-04-01/delegationset" + }, + "input":{"shape":"ListReusableDelegationSetsRequest"}, + "output":{"shape":"ListReusableDelegationSetsResponse"}, + "errors":[ + {"shape":"InvalidInput"} + ] + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/2013-04-01/tags/{ResourceType}/{ResourceId}" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"NoSuchHealthCheck"}, + {"shape":"NoSuchHostedZone"}, + {"shape":"PriorRequestNotComplete"}, + {"shape":"ThrottlingException"} + ] + }, + "ListTagsForResources":{ + "name":"ListTagsForResources", + "http":{ + "method":"POST", + "requestUri":"/2013-04-01/tags/{ResourceType}" + }, + "input":{ + "shape":"ListTagsForResourcesRequest", + "locationName":"ListTagsForResourcesRequest", + "xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"} + }, + "output":{"shape":"ListTagsForResourcesResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"NoSuchHealthCheck"}, + {"shape":"NoSuchHostedZone"}, + {"shape":"PriorRequestNotComplete"}, + {"shape":"ThrottlingException"} + ] + }, + "ListTrafficPolicies":{ + "name":"ListTrafficPolicies", + "http":{ + "method":"GET", + "requestUri":"/2013-04-01/trafficpolicies" + }, + "input":{"shape":"ListTrafficPoliciesRequest"}, + "output":{"shape":"ListTrafficPoliciesResponse"}, + "errors":[ + {"shape":"InvalidInput"} + ] + }, + "ListTrafficPolicyInstances":{ + "name":"ListTrafficPolicyInstances", + "http":{ + "method":"GET", + "requestUri":"/2013-04-01/trafficpolicyinstances" + }, + "input":{"shape":"ListTrafficPolicyInstancesRequest"}, + "output":{"shape":"ListTrafficPolicyInstancesResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"NoSuchTrafficPolicyInstance"} + ] + }, + "ListTrafficPolicyInstancesByHostedZone":{ + "name":"ListTrafficPolicyInstancesByHostedZone", + "http":{ + "method":"GET", + "requestUri":"/2013-04-01/trafficpolicyinstances/hostedzone" + }, + "input":{"shape":"ListTrafficPolicyInstancesByHostedZoneRequest"}, + "output":{"shape":"ListTrafficPolicyInstancesByHostedZoneResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"NoSuchTrafficPolicyInstance"}, + {"shape":"NoSuchHostedZone"} + ] + }, + "ListTrafficPolicyInstancesByPolicy":{ + "name":"ListTrafficPolicyInstancesByPolicy", + "http":{ + "method":"GET", + "requestUri":"/2013-04-01/trafficpolicyinstances/trafficpolicy" + }, + "input":{"shape":"ListTrafficPolicyInstancesByPolicyRequest"}, + "output":{"shape":"ListTrafficPolicyInstancesByPolicyResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"NoSuchTrafficPolicyInstance"}, + {"shape":"NoSuchTrafficPolicy"} + ] + }, + "ListTrafficPolicyVersions":{ + "name":"ListTrafficPolicyVersions", + "http":{ + "method":"GET", + "requestUri":"/2013-04-01/trafficpolicies/{Id}/versions" + }, + "input":{"shape":"ListTrafficPolicyVersionsRequest"}, + "output":{"shape":"ListTrafficPolicyVersionsResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"NoSuchTrafficPolicy"} + ] + }, + "UpdateHealthCheck":{ + "name":"UpdateHealthCheck", + "http":{ + "method":"POST", + "requestUri":"/2013-04-01/healthcheck/{HealthCheckId}" + }, + "input":{ + "shape":"UpdateHealthCheckRequest", + "locationName":"UpdateHealthCheckRequest", + "xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"} + }, + "output":{"shape":"UpdateHealthCheckResponse"}, + "errors":[ + {"shape":"NoSuchHealthCheck"}, + {"shape":"InvalidInput"}, + {"shape":"HealthCheckVersionMismatch"} + ] + }, + "UpdateHostedZoneComment":{ + "name":"UpdateHostedZoneComment", + "http":{ + "method":"POST", + "requestUri":"/2013-04-01/hostedzone/{Id}" + }, + "input":{ + "shape":"UpdateHostedZoneCommentRequest", + "locationName":"UpdateHostedZoneCommentRequest", + "xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"} + }, + "output":{"shape":"UpdateHostedZoneCommentResponse"}, + "errors":[ + {"shape":"NoSuchHostedZone"}, + {"shape":"InvalidInput"} + ] + }, + "UpdateTrafficPolicyComment":{ + "name":"UpdateTrafficPolicyComment", + "http":{ + "method":"POST", + "requestUri":"/2013-04-01/trafficpolicy/{Id}/{Version}" + }, + "input":{ + "shape":"UpdateTrafficPolicyCommentRequest", + "locationName":"UpdateTrafficPolicyCommentRequest", + "xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"} + }, + "output":{"shape":"UpdateTrafficPolicyCommentResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"NoSuchTrafficPolicy"}, + {"shape":"ConcurrentModification"} + ] + }, + "UpdateTrafficPolicyInstance":{ + "name":"UpdateTrafficPolicyInstance", + "http":{ + "method":"POST", + "requestUri":"/2013-04-01/trafficpolicyinstance/{Id}" + }, + "input":{ + "shape":"UpdateTrafficPolicyInstanceRequest", + "locationName":"UpdateTrafficPolicyInstanceRequest", + "xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"} + }, + "output":{"shape":"UpdateTrafficPolicyInstanceResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"NoSuchTrafficPolicy"}, + {"shape":"NoSuchTrafficPolicyInstance"}, + {"shape":"PriorRequestNotComplete"}, + {"shape":"ConflictingTypes"} + ] + } + }, + "shapes":{ + "AWSAccountID":{"type":"string"}, + "AlarmIdentifier":{ + "type":"structure", + "required":[ + "Region", + "Name" + ], + "members":{ + "Region":{"shape":"CloudWatchRegion"}, + "Name":{"shape":"AlarmName"} + } + }, + "AlarmName":{ + "type":"string", + "max":256, + "min":1 + }, + "AliasHealthEnabled":{"type":"boolean"}, + "AliasTarget":{ + "type":"structure", + "required":[ + "HostedZoneId", + "DNSName", + "EvaluateTargetHealth" + ], + "members":{ + "HostedZoneId":{"shape":"ResourceId"}, + "DNSName":{"shape":"DNSName"}, + "EvaluateTargetHealth":{"shape":"AliasHealthEnabled"} + } + }, + "AssociateVPCComment":{"type":"string"}, + "AssociateVPCWithHostedZoneRequest":{ + "type":"structure", + "required":[ + "HostedZoneId", + "VPC" + ], + "members":{ + "HostedZoneId":{ + "shape":"ResourceId", + "location":"uri", + "locationName":"Id" + }, + "VPC":{"shape":"VPC"}, + "Comment":{"shape":"AssociateVPCComment"} + } + }, + "AssociateVPCWithHostedZoneResponse":{ + "type":"structure", + "required":["ChangeInfo"], + "members":{ + "ChangeInfo":{"shape":"ChangeInfo"} + } + }, + "Change":{ + "type":"structure", + "required":[ + "Action", + "ResourceRecordSet" + ], + "members":{ + "Action":{"shape":"ChangeAction"}, + "ResourceRecordSet":{"shape":"ResourceRecordSet"} + } + }, + "ChangeAction":{ + "type":"string", + "enum":[ + "CREATE", + "DELETE", + "UPSERT" + ] + }, + "ChangeBatch":{ + "type":"structure", + "required":["Changes"], + "members":{ + "Comment":{"shape":"ResourceDescription"}, + "Changes":{"shape":"Changes"} + } + }, + "ChangeBatchRecord":{ + "type":"structure", + "required":[ + "Id", + "Status" + ], + "members":{ + "Id":{"shape":"ResourceId"}, + "SubmittedAt":{"shape":"TimeStamp"}, + "Status":{"shape":"ChangeStatus"}, + "Comment":{"shape":"ResourceDescription"}, + "Submitter":{"shape":"AWSAccountID"}, + "Changes":{"shape":"Changes"} + }, + "deprecated":true + }, + "ChangeBatchRecords":{ + "type":"list", + "member":{ + "shape":"ChangeBatchRecord", + "locationName":"ChangeBatchRecord" + }, + "deprecated":true, + "min":1 + }, + "ChangeInfo":{ + "type":"structure", + "required":[ + "Id", + "Status", + "SubmittedAt" + ], + "members":{ + "Id":{"shape":"ResourceId"}, + "Status":{"shape":"ChangeStatus"}, + "SubmittedAt":{"shape":"TimeStamp"}, + "Comment":{"shape":"ResourceDescription"} + } + }, + "ChangeResourceRecordSetsRequest":{ + "type":"structure", + "required":[ + "HostedZoneId", + "ChangeBatch" + ], + "members":{ + "HostedZoneId":{ + "shape":"ResourceId", + "location":"uri", + "locationName":"Id" + }, + "ChangeBatch":{"shape":"ChangeBatch"} + } + }, + "ChangeResourceRecordSetsResponse":{ + "type":"structure", + "required":["ChangeInfo"], + "members":{ + "ChangeInfo":{"shape":"ChangeInfo"} + } + }, + "ChangeStatus":{ + "type":"string", + "enum":[ + "PENDING", + "INSYNC" + ] + }, + "ChangeTagsForResourceRequest":{ + "type":"structure", + "required":[ + "ResourceType", + "ResourceId" + ], + "members":{ + "ResourceType":{ + "shape":"TagResourceType", + "location":"uri", + "locationName":"ResourceType" + }, + "ResourceId":{ + "shape":"TagResourceId", + "location":"uri", + "locationName":"ResourceId" + }, + "AddTags":{"shape":"TagList"}, + "RemoveTagKeys":{"shape":"TagKeyList"} + } + }, + "ChangeTagsForResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "Changes":{ + "type":"list", + "member":{ + "shape":"Change", + "locationName":"Change" + }, + "min":1 + }, + "CheckerIpRanges":{ + "type":"list", + "member":{"shape":"IPAddressCidr"} + }, + "ChildHealthCheckList":{ + "type":"list", + "member":{ + "shape":"HealthCheckId", + "locationName":"ChildHealthCheck" + }, + "max":256 + }, + "CloudWatchAlarmConfiguration":{ + "type":"structure", + "required":[ + "EvaluationPeriods", + "Threshold", + "ComparisonOperator", + "Period", + "MetricName", + "Namespace", + "Statistic" + ], + "members":{ + "EvaluationPeriods":{"shape":"EvaluationPeriods"}, + "Threshold":{"shape":"Threshold"}, + "ComparisonOperator":{"shape":"ComparisonOperator"}, + "Period":{"shape":"Period"}, + "MetricName":{"shape":"MetricName"}, + "Namespace":{"shape":"Namespace"}, + "Statistic":{"shape":"Statistic"}, + "Dimensions":{"shape":"DimensionList"} + } + }, + "CloudWatchRegion":{ + "type":"string", + "enum":[ + "us-east-1", + "us-west-1", + "us-west-2", + "eu-central-1", + "eu-west-1", + "ap-southeast-1", + "ap-southeast-2", + "ap-northeast-1", + "ap-northeast-2", + "sa-east-1" + ], + "max":64, + "min":1 + }, + "ComparisonOperator":{ + "type":"string", + "enum":[ + "GreaterThanOrEqualToThreshold", + "GreaterThanThreshold", + "LessThanThreshold", + "LessThanOrEqualToThreshold" + ] + }, + "ConcurrentModification":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "ConflictingDomainExists":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true + }, + "ConflictingTypes":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "CreateHealthCheckRequest":{ + "type":"structure", + "required":[ + "CallerReference", + "HealthCheckConfig" + ], + "members":{ + "CallerReference":{"shape":"HealthCheckNonce"}, + "HealthCheckConfig":{"shape":"HealthCheckConfig"} + } + }, + "CreateHealthCheckResponse":{ + "type":"structure", + "required":[ + "HealthCheck", + "Location" + ], + "members":{ + "HealthCheck":{"shape":"HealthCheck"}, + "Location":{ + "shape":"ResourceURI", + "location":"header", + "locationName":"Location" + } + } + }, + "CreateHostedZoneRequest":{ + "type":"structure", + "required":[ + "Name", + "CallerReference" + ], + "members":{ + "Name":{"shape":"DNSName"}, + "VPC":{"shape":"VPC"}, + "CallerReference":{"shape":"Nonce"}, + "HostedZoneConfig":{"shape":"HostedZoneConfig"}, + "DelegationSetId":{"shape":"ResourceId"} + } + }, + "CreateHostedZoneResponse":{ + "type":"structure", + "required":[ + "HostedZone", + "ChangeInfo", + "DelegationSet", + "Location" + ], + "members":{ + "HostedZone":{"shape":"HostedZone"}, + "ChangeInfo":{"shape":"ChangeInfo"}, + "DelegationSet":{"shape":"DelegationSet"}, + "VPC":{"shape":"VPC"}, + "Location":{ + "shape":"ResourceURI", + "location":"header", + "locationName":"Location" + } + } + }, + "CreateReusableDelegationSetRequest":{ + "type":"structure", + "required":["CallerReference"], + "members":{ + "CallerReference":{"shape":"Nonce"}, + "HostedZoneId":{"shape":"ResourceId"} + } + }, + "CreateReusableDelegationSetResponse":{ + "type":"structure", + "required":[ + "DelegationSet", + "Location" + ], + "members":{ + "DelegationSet":{"shape":"DelegationSet"}, + "Location":{ + "shape":"ResourceURI", + "location":"header", + "locationName":"Location" + } + } + }, + "CreateTrafficPolicyInstanceRequest":{ + "type":"structure", + "required":[ + "HostedZoneId", + "Name", + "TTL", + "TrafficPolicyId", + "TrafficPolicyVersion" + ], + "members":{ + "HostedZoneId":{"shape":"ResourceId"}, + "Name":{"shape":"DNSName"}, + "TTL":{"shape":"TTL"}, + "TrafficPolicyId":{"shape":"TrafficPolicyId"}, + "TrafficPolicyVersion":{"shape":"TrafficPolicyVersion"} + } + }, + "CreateTrafficPolicyInstanceResponse":{ + "type":"structure", + "required":[ + "TrafficPolicyInstance", + "Location" + ], + "members":{ + "TrafficPolicyInstance":{"shape":"TrafficPolicyInstance"}, + "Location":{ + "shape":"ResourceURI", + "location":"header", + "locationName":"Location" + } + } + }, + "CreateTrafficPolicyRequest":{ + "type":"structure", + "required":[ + "Name", + "Document" + ], + "members":{ + "Name":{"shape":"TrafficPolicyName"}, + "Document":{"shape":"TrafficPolicyDocument"}, + "Comment":{"shape":"TrafficPolicyComment"} + } + }, + "CreateTrafficPolicyResponse":{ + "type":"structure", + "required":[ + "TrafficPolicy", + "Location" + ], + "members":{ + "TrafficPolicy":{"shape":"TrafficPolicy"}, + "Location":{ + "shape":"ResourceURI", + "location":"header", + "locationName":"Location" + } + } + }, + "CreateTrafficPolicyVersionRequest":{ + "type":"structure", + "required":[ + "Id", + "Document" + ], + "members":{ + "Id":{ + "shape":"TrafficPolicyId", + "location":"uri", + "locationName":"Id" + }, + "Document":{"shape":"TrafficPolicyDocument"}, + "Comment":{"shape":"TrafficPolicyComment"} + } + }, + "CreateTrafficPolicyVersionResponse":{ + "type":"structure", + "required":[ + "TrafficPolicy", + "Location" + ], + "members":{ + "TrafficPolicy":{"shape":"TrafficPolicy"}, + "Location":{ + "shape":"ResourceURI", + "location":"header", + "locationName":"Location" + } + } + }, + "DNSName":{ + "type":"string", + "max":1024 + }, + "Date":{ + "type":"string", + "deprecated":true, + "max":256 + }, + "DelegationSet":{ + "type":"structure", + "required":["NameServers"], + "members":{ + "Id":{"shape":"ResourceId"}, + "CallerReference":{"shape":"Nonce"}, + "NameServers":{"shape":"DelegationSetNameServers"} + } + }, + "DelegationSetAlreadyCreated":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true + }, + "DelegationSetAlreadyReusable":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true + }, + "DelegationSetInUse":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true + }, + "DelegationSetNameServers":{ + "type":"list", + "member":{ + "shape":"DNSName", + "locationName":"NameServer" + }, + "min":1 + }, + "DelegationSetNotAvailable":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true + }, + "DelegationSetNotReusable":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true + }, + "DelegationSets":{ + "type":"list", + "member":{ + "shape":"DelegationSet", + "locationName":"DelegationSet" + } + }, + "DeleteHealthCheckRequest":{ + "type":"structure", + "required":["HealthCheckId"], + "members":{ + "HealthCheckId":{ + "shape":"HealthCheckId", + "location":"uri", + "locationName":"HealthCheckId" + } + } + }, + "DeleteHealthCheckResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteHostedZoneRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"ResourceId", + "location":"uri", + "locationName":"Id" + } + } + }, + "DeleteHostedZoneResponse":{ + "type":"structure", + "required":["ChangeInfo"], + "members":{ + "ChangeInfo":{"shape":"ChangeInfo"} + } + }, + "DeleteReusableDelegationSetRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"ResourceId", + "location":"uri", + "locationName":"Id" + } + } + }, + "DeleteReusableDelegationSetResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteTrafficPolicyInstanceRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"TrafficPolicyInstanceId", + "location":"uri", + "locationName":"Id" + } + } + }, + "DeleteTrafficPolicyInstanceResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteTrafficPolicyRequest":{ + "type":"structure", + "required":[ + "Id", + "Version" + ], + "members":{ + "Id":{ + "shape":"TrafficPolicyId", + "location":"uri", + "locationName":"Id" + }, + "Version":{ + "shape":"TrafficPolicyVersion", + "location":"uri", + "locationName":"Version" + } + } + }, + "DeleteTrafficPolicyResponse":{ + "type":"structure", + "members":{ + } + }, + "Dimension":{ + "type":"structure", + "required":[ + "Name", + "Value" + ], + "members":{ + "Name":{"shape":"DimensionField"}, + "Value":{"shape":"DimensionField"} + } + }, + "DimensionField":{ + "type":"string", + "max":255, + "min":1 + }, + "DimensionList":{ + "type":"list", + "member":{ + "shape":"Dimension", + "locationName":"Dimension" + }, + "max":10 + }, + "DisassociateVPCComment":{"type":"string"}, + "DisassociateVPCFromHostedZoneRequest":{ + "type":"structure", + "required":[ + "HostedZoneId", + "VPC" + ], + "members":{ + "HostedZoneId":{ + "shape":"ResourceId", + "location":"uri", + "locationName":"Id" + }, + "VPC":{"shape":"VPC"}, + "Comment":{"shape":"DisassociateVPCComment"} + } + }, + "DisassociateVPCFromHostedZoneResponse":{ + "type":"structure", + "required":["ChangeInfo"], + "members":{ + "ChangeInfo":{"shape":"ChangeInfo"} + } + }, + "EnableSNI":{"type":"boolean"}, + "ErrorMessage":{"type":"string"}, + "ErrorMessages":{ + "type":"list", + "member":{ + "shape":"ErrorMessage", + "locationName":"Message" + } + }, + "EvaluationPeriods":{ + "type":"integer", + "min":1 + }, + "FailureThreshold":{ + "type":"integer", + "max":10, + "min":1 + }, + "FullyQualifiedDomainName":{ + "type":"string", + "max":255 + }, + "GeoLocation":{ + "type":"structure", + "members":{ + "ContinentCode":{"shape":"GeoLocationContinentCode"}, + "CountryCode":{"shape":"GeoLocationCountryCode"}, + "SubdivisionCode":{"shape":"GeoLocationSubdivisionCode"} + } + }, + "GeoLocationContinentCode":{ + "type":"string", + "max":2, + "min":2 + }, + "GeoLocationContinentName":{ + "type":"string", + "max":32, + "min":1 + }, + "GeoLocationCountryCode":{ + "type":"string", + "max":2, + "min":1 + }, + "GeoLocationCountryName":{ + "type":"string", + "max":64, + "min":1 + }, + "GeoLocationDetails":{ + "type":"structure", + "members":{ + "ContinentCode":{"shape":"GeoLocationContinentCode"}, + "ContinentName":{"shape":"GeoLocationContinentName"}, + "CountryCode":{"shape":"GeoLocationCountryCode"}, + "CountryName":{"shape":"GeoLocationCountryName"}, + "SubdivisionCode":{"shape":"GeoLocationSubdivisionCode"}, + "SubdivisionName":{"shape":"GeoLocationSubdivisionName"} + } + }, + "GeoLocationDetailsList":{ + "type":"list", + "member":{ + "shape":"GeoLocationDetails", + "locationName":"GeoLocationDetails" + } + }, + "GeoLocationSubdivisionCode":{ + "type":"string", + "max":3, + "min":1 + }, + "GeoLocationSubdivisionName":{ + "type":"string", + "max":64, + "min":1 + }, + "GetChangeDetailsRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"ResourceId", + "location":"uri", + "locationName":"Id" + } + }, + "deprecated":true + }, + "GetChangeDetailsResponse":{ + "type":"structure", + "required":["ChangeBatchRecord"], + "members":{ + "ChangeBatchRecord":{"shape":"ChangeBatchRecord"} + }, + "deprecated":true + }, + "GetChangeRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"ResourceId", + "location":"uri", + "locationName":"Id" + } + } + }, + "GetChangeResponse":{ + "type":"structure", + "required":["ChangeInfo"], + "members":{ + "ChangeInfo":{"shape":"ChangeInfo"} + } + }, + "GetCheckerIpRangesRequest":{ + "type":"structure", + "members":{ + } + }, + "GetCheckerIpRangesResponse":{ + "type":"structure", + "required":["CheckerIpRanges"], + "members":{ + "CheckerIpRanges":{"shape":"CheckerIpRanges"} + } + }, + "GetGeoLocationRequest":{ + "type":"structure", + "members":{ + "ContinentCode":{ + "shape":"GeoLocationContinentCode", + "location":"querystring", + "locationName":"continentcode" + }, + "CountryCode":{ + "shape":"GeoLocationCountryCode", + "location":"querystring", + "locationName":"countrycode" + }, + "SubdivisionCode":{ + "shape":"GeoLocationSubdivisionCode", + "location":"querystring", + "locationName":"subdivisioncode" + } + } + }, + "GetGeoLocationResponse":{ + "type":"structure", + "required":["GeoLocationDetails"], + "members":{ + "GeoLocationDetails":{"shape":"GeoLocationDetails"} + } + }, + "GetHealthCheckCountRequest":{ + "type":"structure", + "members":{ + } + }, + "GetHealthCheckCountResponse":{ + "type":"structure", + "required":["HealthCheckCount"], + "members":{ + "HealthCheckCount":{"shape":"HealthCheckCount"} + } + }, + "GetHealthCheckLastFailureReasonRequest":{ + "type":"structure", + "required":["HealthCheckId"], + "members":{ + "HealthCheckId":{ + "shape":"HealthCheckId", + "location":"uri", + "locationName":"HealthCheckId" + } + } + }, + "GetHealthCheckLastFailureReasonResponse":{ + "type":"structure", + "required":["HealthCheckObservations"], + "members":{ + "HealthCheckObservations":{"shape":"HealthCheckObservations"} + } + }, + "GetHealthCheckRequest":{ + "type":"structure", + "required":["HealthCheckId"], + "members":{ + "HealthCheckId":{ + "shape":"HealthCheckId", + "location":"uri", + "locationName":"HealthCheckId" + } + } + }, + "GetHealthCheckResponse":{ + "type":"structure", + "required":["HealthCheck"], + "members":{ + "HealthCheck":{"shape":"HealthCheck"} + } + }, + "GetHealthCheckStatusRequest":{ + "type":"structure", + "required":["HealthCheckId"], + "members":{ + "HealthCheckId":{ + "shape":"HealthCheckId", + "location":"uri", + "locationName":"HealthCheckId" + } + } + }, + "GetHealthCheckStatusResponse":{ + "type":"structure", + "required":["HealthCheckObservations"], + "members":{ + "HealthCheckObservations":{"shape":"HealthCheckObservations"} + } + }, + "GetHostedZoneCountRequest":{ + "type":"structure", + "members":{ + } + }, + "GetHostedZoneCountResponse":{ + "type":"structure", + "required":["HostedZoneCount"], + "members":{ + "HostedZoneCount":{"shape":"HostedZoneCount"} + } + }, + "GetHostedZoneRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"ResourceId", + "location":"uri", + "locationName":"Id" + } + } + }, + "GetHostedZoneResponse":{ + "type":"structure", + "required":["HostedZone"], + "members":{ + "HostedZone":{"shape":"HostedZone"}, + "DelegationSet":{"shape":"DelegationSet"}, + "VPCs":{"shape":"VPCs"} + } + }, + "GetReusableDelegationSetRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"ResourceId", + "location":"uri", + "locationName":"Id" + } + } + }, + "GetReusableDelegationSetResponse":{ + "type":"structure", + "required":["DelegationSet"], + "members":{ + "DelegationSet":{"shape":"DelegationSet"} + } + }, + "GetTrafficPolicyInstanceCountRequest":{ + "type":"structure", + "members":{ + } + }, + "GetTrafficPolicyInstanceCountResponse":{ + "type":"structure", + "required":["TrafficPolicyInstanceCount"], + "members":{ + "TrafficPolicyInstanceCount":{"shape":"TrafficPolicyInstanceCount"} + } + }, + "GetTrafficPolicyInstanceRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"TrafficPolicyInstanceId", + "location":"uri", + "locationName":"Id" + } + } + }, + "GetTrafficPolicyInstanceResponse":{ + "type":"structure", + "required":["TrafficPolicyInstance"], + "members":{ + "TrafficPolicyInstance":{"shape":"TrafficPolicyInstance"} + } + }, + "GetTrafficPolicyRequest":{ + "type":"structure", + "required":[ + "Id", + "Version" + ], + "members":{ + "Id":{ + "shape":"TrafficPolicyId", + "location":"uri", + "locationName":"Id" + }, + "Version":{ + "shape":"TrafficPolicyVersion", + "location":"uri", + "locationName":"Version" + } + } + }, + "GetTrafficPolicyResponse":{ + "type":"structure", + "required":["TrafficPolicy"], + "members":{ + "TrafficPolicy":{"shape":"TrafficPolicy"} + } + }, + "HealthCheck":{ + "type":"structure", + "required":[ + "Id", + "CallerReference", + "HealthCheckConfig", + "HealthCheckVersion" + ], + "members":{ + "Id":{"shape":"HealthCheckId"}, + "CallerReference":{"shape":"HealthCheckNonce"}, + "HealthCheckConfig":{"shape":"HealthCheckConfig"}, + "HealthCheckVersion":{"shape":"HealthCheckVersion"}, + "CloudWatchAlarmConfiguration":{"shape":"CloudWatchAlarmConfiguration"} + } + }, + "HealthCheckAlreadyExists":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "HealthCheckConfig":{ + "type":"structure", + "required":["Type"], + "members":{ + "IPAddress":{"shape":"IPAddress"}, + "Port":{"shape":"Port"}, + "Type":{"shape":"HealthCheckType"}, + "ResourcePath":{"shape":"ResourcePath"}, + "FullyQualifiedDomainName":{"shape":"FullyQualifiedDomainName"}, + "SearchString":{"shape":"SearchString"}, + "RequestInterval":{"shape":"RequestInterval"}, + "FailureThreshold":{"shape":"FailureThreshold"}, + "MeasureLatency":{"shape":"MeasureLatency"}, + "Inverted":{"shape":"Inverted"}, + "HealthThreshold":{"shape":"HealthThreshold"}, + "ChildHealthChecks":{"shape":"ChildHealthCheckList"}, + "EnableSNI":{"shape":"EnableSNI"}, + "Regions":{"shape":"HealthCheckRegionList"}, + "AlarmIdentifier":{"shape":"AlarmIdentifier"}, + "InsufficientDataHealthStatus":{"shape":"InsufficientDataHealthStatus"} + } + }, + "HealthCheckCount":{"type":"long"}, + "HealthCheckId":{ + "type":"string", + "max":64 + }, + "HealthCheckInUse":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "HealthCheckNonce":{ + "type":"string", + "max":64, + "min":1 + }, + "HealthCheckObservation":{ + "type":"structure", + "members":{ + "Region":{"shape":"HealthCheckRegion"}, + "IPAddress":{"shape":"IPAddress"}, + "StatusReport":{"shape":"StatusReport"} + } + }, + "HealthCheckObservations":{ + "type":"list", + "member":{ + "shape":"HealthCheckObservation", + "locationName":"HealthCheckObservation" + } + }, + "HealthCheckRegion":{ + "type":"string", + "enum":[ + "us-east-1", + "us-west-1", + "us-west-2", + "eu-west-1", + "ap-southeast-1", + "ap-southeast-2", + "ap-northeast-1", + "sa-east-1" + ], + "max":64, + "min":1 + }, + "HealthCheckRegionList":{ + "type":"list", + "member":{ + "shape":"HealthCheckRegion", + "locationName":"Region" + }, + "max":64, + "min":1 + }, + "HealthCheckType":{ + "type":"string", + "enum":[ + "HTTP", + "HTTPS", + "HTTP_STR_MATCH", + "HTTPS_STR_MATCH", + "TCP", + "CALCULATED", + "CLOUDWATCH_METRIC" + ] + }, + "HealthCheckVersion":{ + "type":"long", + "min":1 + }, + "HealthCheckVersionMismatch":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "HealthChecks":{ + "type":"list", + "member":{ + "shape":"HealthCheck", + "locationName":"HealthCheck" + } + }, + "HealthThreshold":{ + "type":"integer", + "max":256, + "min":0 + }, + "HostedZone":{ + "type":"structure", + "required":[ + "Id", + "Name", + "CallerReference" + ], + "members":{ + "Id":{"shape":"ResourceId"}, + "Name":{"shape":"DNSName"}, + "CallerReference":{"shape":"Nonce"}, + "Config":{"shape":"HostedZoneConfig"}, + "ResourceRecordSetCount":{"shape":"HostedZoneRRSetCount"} + } + }, + "HostedZoneAlreadyExists":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "HostedZoneConfig":{ + "type":"structure", + "members":{ + "Comment":{"shape":"ResourceDescription"}, + "PrivateZone":{"shape":"IsPrivateZone"} + } + }, + "HostedZoneCount":{"type":"long"}, + "HostedZoneNotEmpty":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "HostedZoneNotFound":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true + }, + "HostedZoneRRSetCount":{"type":"long"}, + "HostedZones":{ + "type":"list", + "member":{ + "shape":"HostedZone", + "locationName":"HostedZone" + } + }, + "IPAddress":{ + "type":"string", + "max":15, + "pattern":"^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$" + }, + "IPAddressCidr":{"type":"string"}, + "IncompatibleVersion":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InsufficientDataHealthStatus":{ + "type":"string", + "enum":[ + "Healthy", + "Unhealthy", + "LastKnownStatus" + ] + }, + "InvalidArgument":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true + }, + "InvalidChangeBatch":{ + "type":"structure", + "members":{ + "messages":{"shape":"ErrorMessages"} + }, + "exception":true + }, + "InvalidDomainName":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidInput":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidTrafficPolicyDocument":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidVPCId":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "Inverted":{"type":"boolean"}, + "IsPrivateZone":{"type":"boolean"}, + "LastVPCAssociation":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "LimitsExceeded":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true + }, + "ListChangeBatchesByHostedZoneRequest":{ + "type":"structure", + "required":[ + "HostedZoneId", + "StartDate", + "EndDate" + ], + "members":{ + "HostedZoneId":{ + "shape":"ResourceId", + "location":"uri", + "locationName":"Id" + }, + "StartDate":{ + "shape":"Date", + "location":"querystring", + "locationName":"startDate" + }, + "EndDate":{ + "shape":"Date", + "location":"querystring", + "locationName":"endDate" + }, + "MaxItems":{ + "shape":"PageMaxItems", + "location":"querystring", + "locationName":"maxItems" + }, + "Marker":{ + "shape":"PageMarker", + "location":"querystring", + "locationName":"marker" + } + }, + "deprecated":true + }, + "ListChangeBatchesByHostedZoneResponse":{ + "type":"structure", + "required":[ + "MaxItems", + "Marker", + "ChangeBatchRecords" + ], + "members":{ + "MaxItems":{"shape":"PageMaxItems"}, + "Marker":{"shape":"PageMarker"}, + "IsTruncated":{"shape":"PageTruncated"}, + "ChangeBatchRecords":{"shape":"ChangeBatchRecords"}, + "NextMarker":{"shape":"PageMarker"} + }, + "deprecated":true + }, + "ListChangeBatchesByRRSetRequest":{ + "type":"structure", + "required":[ + "HostedZoneId", + "Name", + "Type", + "StartDate", + "EndDate" + ], + "members":{ + "HostedZoneId":{ + "shape":"ResourceId", + "location":"uri", + "locationName":"Id" + }, + "Name":{ + "shape":"DNSName", + "location":"querystring", + "locationName":"rrSet_name" + }, + "Type":{ + "shape":"RRType", + "location":"querystring", + "locationName":"type" + }, + "SetIdentifier":{ + "shape":"ResourceRecordSetIdentifier", + "location":"querystring", + "locationName":"identifier" + }, + "StartDate":{ + "shape":"Date", + "location":"querystring", + "locationName":"startDate" + }, + "EndDate":{ + "shape":"Date", + "location":"querystring", + "locationName":"endDate" + }, + "MaxItems":{ + "shape":"PageMaxItems", + "location":"querystring", + "locationName":"maxItems" + }, + "Marker":{ + "shape":"PageMarker", + "location":"querystring", + "locationName":"marker" + } + }, + "deprecated":true + }, + "ListChangeBatchesByRRSetResponse":{ + "type":"structure", + "required":[ + "MaxItems", + "Marker", + "ChangeBatchRecords" + ], + "members":{ + "MaxItems":{"shape":"PageMaxItems"}, + "Marker":{"shape":"PageMarker"}, + "IsTruncated":{"shape":"PageTruncated"}, + "ChangeBatchRecords":{"shape":"ChangeBatchRecords"}, + "NextMarker":{"shape":"PageMarker"} + }, + "deprecated":true + }, + "ListGeoLocationsRequest":{ + "type":"structure", + "members":{ + "StartContinentCode":{ + "shape":"GeoLocationContinentCode", + "location":"querystring", + "locationName":"startcontinentcode" + }, + "StartCountryCode":{ + "shape":"GeoLocationCountryCode", + "location":"querystring", + "locationName":"startcountrycode" + }, + "StartSubdivisionCode":{ + "shape":"GeoLocationSubdivisionCode", + "location":"querystring", + "locationName":"startsubdivisioncode" + }, + "MaxItems":{ + "shape":"PageMaxItems", + "location":"querystring", + "locationName":"maxitems" + } + } + }, + "ListGeoLocationsResponse":{ + "type":"structure", + "required":[ + "GeoLocationDetailsList", + "IsTruncated", + "MaxItems" + ], + "members":{ + "GeoLocationDetailsList":{"shape":"GeoLocationDetailsList"}, + "IsTruncated":{"shape":"PageTruncated"}, + "NextContinentCode":{"shape":"GeoLocationContinentCode"}, + "NextCountryCode":{"shape":"GeoLocationCountryCode"}, + "NextSubdivisionCode":{"shape":"GeoLocationSubdivisionCode"}, + "MaxItems":{"shape":"PageMaxItems"} + } + }, + "ListHealthChecksRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"PageMarker", + "location":"querystring", + "locationName":"marker" + }, + "MaxItems":{ + "shape":"PageMaxItems", + "location":"querystring", + "locationName":"maxitems" + } + } + }, + "ListHealthChecksResponse":{ + "type":"structure", + "required":[ + "HealthChecks", + "Marker", + "IsTruncated", + "MaxItems" + ], + "members":{ + "HealthChecks":{"shape":"HealthChecks"}, + "Marker":{"shape":"PageMarker"}, + "IsTruncated":{"shape":"PageTruncated"}, + "NextMarker":{"shape":"PageMarker"}, + "MaxItems":{"shape":"PageMaxItems"} + } + }, + "ListHostedZonesByNameRequest":{ + "type":"structure", + "members":{ + "DNSName":{ + "shape":"DNSName", + "location":"querystring", + "locationName":"dnsname" + }, + "HostedZoneId":{ + "shape":"ResourceId", + "location":"querystring", + "locationName":"hostedzoneid" + }, + "MaxItems":{ + "shape":"PageMaxItems", + "location":"querystring", + "locationName":"maxitems" + } + } + }, + "ListHostedZonesByNameResponse":{ + "type":"structure", + "required":[ + "HostedZones", + "IsTruncated", + "MaxItems" + ], + "members":{ + "HostedZones":{"shape":"HostedZones"}, + "DNSName":{"shape":"DNSName"}, + "HostedZoneId":{"shape":"ResourceId"}, + "IsTruncated":{"shape":"PageTruncated"}, + "NextDNSName":{"shape":"DNSName"}, + "NextHostedZoneId":{"shape":"ResourceId"}, + "MaxItems":{"shape":"PageMaxItems"} + } + }, + "ListHostedZonesRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"PageMarker", + "location":"querystring", + "locationName":"marker" + }, + "MaxItems":{ + "shape":"PageMaxItems", + "location":"querystring", + "locationName":"maxitems" + }, + "DelegationSetId":{ + "shape":"ResourceId", + "location":"querystring", + "locationName":"delegationsetid" + } + } + }, + "ListHostedZonesResponse":{ + "type":"structure", + "required":[ + "HostedZones", + "Marker", + "IsTruncated", + "MaxItems" + ], + "members":{ + "HostedZones":{"shape":"HostedZones"}, + "Marker":{"shape":"PageMarker"}, + "IsTruncated":{"shape":"PageTruncated"}, + "NextMarker":{"shape":"PageMarker"}, + "MaxItems":{"shape":"PageMaxItems"} + } + }, + "ListResourceRecordSetsRequest":{ + "type":"structure", + "required":["HostedZoneId"], + "members":{ + "HostedZoneId":{ + "shape":"ResourceId", + "location":"uri", + "locationName":"Id" + }, + "StartRecordName":{ + "shape":"DNSName", + "location":"querystring", + "locationName":"name" + }, + "StartRecordType":{ + "shape":"RRType", + "location":"querystring", + "locationName":"type" + }, + "StartRecordIdentifier":{ + "shape":"ResourceRecordSetIdentifier", + "location":"querystring", + "locationName":"identifier" + }, + "MaxItems":{ + "shape":"PageMaxItems", + "location":"querystring", + "locationName":"maxitems" + } + } + }, + "ListResourceRecordSetsResponse":{ + "type":"structure", + "required":[ + "ResourceRecordSets", + "IsTruncated", + "MaxItems" + ], + "members":{ + "ResourceRecordSets":{"shape":"ResourceRecordSets"}, + "IsTruncated":{"shape":"PageTruncated"}, + "NextRecordName":{"shape":"DNSName"}, + "NextRecordType":{"shape":"RRType"}, + "NextRecordIdentifier":{"shape":"ResourceRecordSetIdentifier"}, + "MaxItems":{"shape":"PageMaxItems"} + } + }, + "ListReusableDelegationSetsRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"PageMarker", + "location":"querystring", + "locationName":"marker" + }, + "MaxItems":{ + "shape":"PageMaxItems", + "location":"querystring", + "locationName":"maxitems" + } + } + }, + "ListReusableDelegationSetsResponse":{ + "type":"structure", + "required":[ + "DelegationSets", + "Marker", + "IsTruncated", + "MaxItems" + ], + "members":{ + "DelegationSets":{"shape":"DelegationSets"}, + "Marker":{"shape":"PageMarker"}, + "IsTruncated":{"shape":"PageTruncated"}, + "NextMarker":{"shape":"PageMarker"}, + "MaxItems":{"shape":"PageMaxItems"} + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":[ + "ResourceType", + "ResourceId" + ], + "members":{ + "ResourceType":{ + "shape":"TagResourceType", + "location":"uri", + "locationName":"ResourceType" + }, + "ResourceId":{ + "shape":"TagResourceId", + "location":"uri", + "locationName":"ResourceId" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "required":["ResourceTagSet"], + "members":{ + "ResourceTagSet":{"shape":"ResourceTagSet"} + } + }, + "ListTagsForResourcesRequest":{ + "type":"structure", + "required":[ + "ResourceType", + "ResourceIds" + ], + "members":{ + "ResourceType":{ + "shape":"TagResourceType", + "location":"uri", + "locationName":"ResourceType" + }, + "ResourceIds":{"shape":"TagResourceIdList"} + } + }, + "ListTagsForResourcesResponse":{ + "type":"structure", + "required":["ResourceTagSets"], + "members":{ + "ResourceTagSets":{"shape":"ResourceTagSetList"} + } + }, + "ListTrafficPoliciesRequest":{ + "type":"structure", + "members":{ + "TrafficPolicyIdMarker":{ + "shape":"TrafficPolicyId", + "location":"querystring", + "locationName":"trafficpolicyid" + }, + "MaxItems":{ + "shape":"PageMaxItems", + "location":"querystring", + "locationName":"maxitems" + } + } + }, + "ListTrafficPoliciesResponse":{ + "type":"structure", + "required":[ + "TrafficPolicySummaries", + "IsTruncated", + "TrafficPolicyIdMarker", + "MaxItems" + ], + "members":{ + "TrafficPolicySummaries":{"shape":"TrafficPolicySummaries"}, + "IsTruncated":{"shape":"PageTruncated"}, + "TrafficPolicyIdMarker":{"shape":"TrafficPolicyId"}, + "MaxItems":{"shape":"PageMaxItems"} + } + }, + "ListTrafficPolicyInstancesByHostedZoneRequest":{ + "type":"structure", + "required":["HostedZoneId"], + "members":{ + "HostedZoneId":{ + "shape":"ResourceId", + "location":"querystring", + "locationName":"id" + }, + "TrafficPolicyInstanceNameMarker":{ + "shape":"DNSName", + "location":"querystring", + "locationName":"trafficpolicyinstancename" + }, + "TrafficPolicyInstanceTypeMarker":{ + "shape":"RRType", + "location":"querystring", + "locationName":"trafficpolicyinstancetype" + }, + "MaxItems":{ + "shape":"PageMaxItems", + "location":"querystring", + "locationName":"maxitems" + } + } + }, + "ListTrafficPolicyInstancesByHostedZoneResponse":{ + "type":"structure", + "required":[ + "TrafficPolicyInstances", + "IsTruncated", + "MaxItems" + ], + "members":{ + "TrafficPolicyInstances":{"shape":"TrafficPolicyInstances"}, + "TrafficPolicyInstanceNameMarker":{"shape":"DNSName"}, + "TrafficPolicyInstanceTypeMarker":{"shape":"RRType"}, + "IsTruncated":{"shape":"PageTruncated"}, + "MaxItems":{"shape":"PageMaxItems"} + } + }, + "ListTrafficPolicyInstancesByPolicyRequest":{ + "type":"structure", + "required":[ + "TrafficPolicyId", + "TrafficPolicyVersion" + ], + "members":{ + "TrafficPolicyId":{ + "shape":"TrafficPolicyId", + "location":"querystring", + "locationName":"id" + }, + "TrafficPolicyVersion":{ + "shape":"TrafficPolicyVersion", + "location":"querystring", + "locationName":"version" + }, + "HostedZoneIdMarker":{ + "shape":"ResourceId", + "location":"querystring", + "locationName":"hostedzoneid" + }, + "TrafficPolicyInstanceNameMarker":{ + "shape":"DNSName", + "location":"querystring", + "locationName":"trafficpolicyinstancename" + }, + "TrafficPolicyInstanceTypeMarker":{ + "shape":"RRType", + "location":"querystring", + "locationName":"trafficpolicyinstancetype" + }, + "MaxItems":{ + "shape":"PageMaxItems", + "location":"querystring", + "locationName":"maxitems" + } + } + }, + "ListTrafficPolicyInstancesByPolicyResponse":{ + "type":"structure", + "required":[ + "TrafficPolicyInstances", + "IsTruncated", + "MaxItems" + ], + "members":{ + "TrafficPolicyInstances":{"shape":"TrafficPolicyInstances"}, + "HostedZoneIdMarker":{"shape":"ResourceId"}, + "TrafficPolicyInstanceNameMarker":{"shape":"DNSName"}, + "TrafficPolicyInstanceTypeMarker":{"shape":"RRType"}, + "IsTruncated":{"shape":"PageTruncated"}, + "MaxItems":{"shape":"PageMaxItems"} + } + }, + "ListTrafficPolicyInstancesRequest":{ + "type":"structure", + "members":{ + "HostedZoneIdMarker":{ + "shape":"ResourceId", + "location":"querystring", + "locationName":"hostedzoneid" + }, + "TrafficPolicyInstanceNameMarker":{ + "shape":"DNSName", + "location":"querystring", + "locationName":"trafficpolicyinstancename" + }, + "TrafficPolicyInstanceTypeMarker":{ + "shape":"RRType", + "location":"querystring", + "locationName":"trafficpolicyinstancetype" + }, + "MaxItems":{ + "shape":"PageMaxItems", + "location":"querystring", + "locationName":"maxitems" + } + } + }, + "ListTrafficPolicyInstancesResponse":{ + "type":"structure", + "required":[ + "TrafficPolicyInstances", + "IsTruncated", + "MaxItems" + ], + "members":{ + "TrafficPolicyInstances":{"shape":"TrafficPolicyInstances"}, + "HostedZoneIdMarker":{"shape":"ResourceId"}, + "TrafficPolicyInstanceNameMarker":{"shape":"DNSName"}, + "TrafficPolicyInstanceTypeMarker":{"shape":"RRType"}, + "IsTruncated":{"shape":"PageTruncated"}, + "MaxItems":{"shape":"PageMaxItems"} + } + }, + "ListTrafficPolicyVersionsRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"TrafficPolicyId", + "location":"uri", + "locationName":"Id" + }, + "TrafficPolicyVersionMarker":{ + "shape":"TrafficPolicyVersionMarker", + "location":"querystring", + "locationName":"trafficpolicyversion" + }, + "MaxItems":{ + "shape":"PageMaxItems", + "location":"querystring", + "locationName":"maxitems" + } + } + }, + "ListTrafficPolicyVersionsResponse":{ + "type":"structure", + "required":[ + "TrafficPolicies", + "IsTruncated", + "TrafficPolicyVersionMarker", + "MaxItems" + ], + "members":{ + "TrafficPolicies":{"shape":"TrafficPolicies"}, + "IsTruncated":{"shape":"PageTruncated"}, + "TrafficPolicyVersionMarker":{"shape":"TrafficPolicyVersionMarker"}, + "MaxItems":{"shape":"PageMaxItems"} + } + }, + "MeasureLatency":{"type":"boolean"}, + "Message":{ + "type":"string", + "max":1024 + }, + "MetricName":{ + "type":"string", + "max":255, + "min":1 + }, + "Namespace":{ + "type":"string", + "max":255, + "min":1 + }, + "NoSuchChange":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchDelegationSet":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true + }, + "NoSuchGeoLocation":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchHealthCheck":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchHostedZone":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchTrafficPolicy":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchTrafficPolicyInstance":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "error":{"httpStatusCode":404}, + "exception":true + }, + "Nonce":{ + "type":"string", + "max":128, + "min":1 + }, + "PageMarker":{ + "type":"string", + "max":64 + }, + "PageMaxItems":{"type":"string"}, + "PageTruncated":{"type":"boolean"}, + "Period":{ + "type":"integer", + "min":60 + }, + "Port":{ + "type":"integer", + "max":65535, + "min":1 + }, + "PriorRequestNotComplete":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "PublicZoneVPCAssociation":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "RData":{ + "type":"string", + "max":4000 + }, + "RRType":{ + "type":"string", + "enum":[ + "SOA", + "A", + "TXT", + "NS", + "CNAME", + "MX", + "PTR", + "SRV", + "SPF", + "AAAA" + ] + }, + "RequestInterval":{ + "type":"integer", + "max":30, + "min":10 + }, + "ResourceDescription":{ + "type":"string", + "max":256 + }, + "ResourceId":{ + "type":"string", + "max":32 + }, + "ResourcePath":{ + "type":"string", + "max":255 + }, + "ResourceRecord":{ + "type":"structure", + "required":["Value"], + "members":{ + "Value":{"shape":"RData"} + } + }, + "ResourceRecordSet":{ + "type":"structure", + "required":[ + "Name", + "Type" + ], + "members":{ + "Name":{"shape":"DNSName"}, + "Type":{"shape":"RRType"}, + "SetIdentifier":{"shape":"ResourceRecordSetIdentifier"}, + "Weight":{"shape":"ResourceRecordSetWeight"}, + "Region":{"shape":"ResourceRecordSetRegion"}, + "GeoLocation":{"shape":"GeoLocation"}, + "Failover":{"shape":"ResourceRecordSetFailover"}, + "TTL":{"shape":"TTL"}, + "ResourceRecords":{"shape":"ResourceRecords"}, + "AliasTarget":{"shape":"AliasTarget"}, + "HealthCheckId":{"shape":"HealthCheckId"}, + "TrafficPolicyInstanceId":{"shape":"TrafficPolicyInstanceId"} + } + }, + "ResourceRecordSetFailover":{ + "type":"string", + "enum":[ + "PRIMARY", + "SECONDARY" + ] + }, + "ResourceRecordSetIdentifier":{ + "type":"string", + "max":128, + "min":1 + }, + "ResourceRecordSetRegion":{ + "type":"string", + "enum":[ + "us-east-1", + "us-west-1", + "us-west-2", + "eu-west-1", + "eu-central-1", + "ap-southeast-1", + "ap-southeast-2", + "ap-northeast-1", + "ap-northeast-2", + "sa-east-1", + "cn-north-1", + "ap-south-1" + ], + "max":64, + "min":1 + }, + "ResourceRecordSetWeight":{ + "type":"long", + "max":255, + "min":0 + }, + "ResourceRecordSets":{ + "type":"list", + "member":{ + "shape":"ResourceRecordSet", + "locationName":"ResourceRecordSet" + } + }, + "ResourceRecords":{ + "type":"list", + "member":{ + "shape":"ResourceRecord", + "locationName":"ResourceRecord" + }, + "min":1 + }, + "ResourceTagSet":{ + "type":"structure", + "members":{ + "ResourceType":{"shape":"TagResourceType"}, + "ResourceId":{"shape":"TagResourceId"}, + "Tags":{"shape":"TagList"} + } + }, + "ResourceTagSetList":{ + "type":"list", + "member":{ + "shape":"ResourceTagSet", + "locationName":"ResourceTagSet" + } + }, + "ResourceURI":{ + "type":"string", + "max":1024 + }, + "SearchString":{ + "type":"string", + "max":255 + }, + "Statistic":{ + "type":"string", + "enum":[ + "Average", + "Sum", + "SampleCount", + "Maximum", + "Minimum" + ] + }, + "Status":{"type":"string"}, + "StatusReport":{ + "type":"structure", + "members":{ + "Status":{"shape":"Status"}, + "CheckedTime":{"shape":"TimeStamp"} + } + }, + "TTL":{ + "type":"long", + "max":2147483647, + "min":0 + }, + "Tag":{ + "type":"structure", + "members":{ + "Key":{"shape":"TagKey"}, + "Value":{"shape":"TagValue"} + } + }, + "TagKey":{ + "type":"string", + "max":128 + }, + "TagKeyList":{ + "type":"list", + "member":{ + "shape":"TagKey", + "locationName":"Key" + }, + "max":10, + "min":1 + }, + "TagList":{ + "type":"list", + "member":{ + "shape":"Tag", + "locationName":"Tag" + }, + "max":10, + "min":1 + }, + "TagResourceId":{ + "type":"string", + "max":64 + }, + "TagResourceIdList":{ + "type":"list", + "member":{ + "shape":"TagResourceId", + "locationName":"ResourceId" + }, + "max":10, + "min":1 + }, + "TagResourceType":{ + "type":"string", + "enum":[ + "healthcheck", + "hostedzone" + ] + }, + "TagValue":{ + "type":"string", + "max":256 + }, + "Threshold":{"type":"double"}, + "ThrottlingException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "TimeStamp":{"type":"timestamp"}, + "TooManyHealthChecks":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true + }, + "TooManyHostedZones":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyTrafficPolicies":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyTrafficPolicyInstances":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "TrafficPolicies":{ + "type":"list", + "member":{ + "shape":"TrafficPolicy", + "locationName":"TrafficPolicy" + } + }, + "TrafficPolicy":{ + "type":"structure", + "required":[ + "Id", + "Version", + "Name", + "Type", + "Document" + ], + "members":{ + "Id":{"shape":"TrafficPolicyId"}, + "Version":{"shape":"TrafficPolicyVersion"}, + "Name":{"shape":"TrafficPolicyName"}, + "Type":{"shape":"RRType"}, + "Document":{"shape":"TrafficPolicyDocument"}, + "Comment":{"shape":"TrafficPolicyComment"} + } + }, + "TrafficPolicyAlreadyExists":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "TrafficPolicyComment":{ + "type":"string", + "max":1024 + }, + "TrafficPolicyDocument":{ + "type":"string", + "max":102400 + }, + "TrafficPolicyId":{ + "type":"string", + "max":36 + }, + "TrafficPolicyInUse":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "TrafficPolicyInstance":{ + "type":"structure", + "required":[ + "Id", + "HostedZoneId", + "Name", + "TTL", + "State", + "Message", + "TrafficPolicyId", + "TrafficPolicyVersion", + "TrafficPolicyType" + ], + "members":{ + "Id":{"shape":"TrafficPolicyInstanceId"}, + "HostedZoneId":{"shape":"ResourceId"}, + "Name":{"shape":"DNSName"}, + "TTL":{"shape":"TTL"}, + "State":{"shape":"TrafficPolicyInstanceState"}, + "Message":{"shape":"Message"}, + "TrafficPolicyId":{"shape":"TrafficPolicyId"}, + "TrafficPolicyVersion":{"shape":"TrafficPolicyVersion"}, + "TrafficPolicyType":{"shape":"RRType"} + } + }, + "TrafficPolicyInstanceAlreadyExists":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "TrafficPolicyInstanceCount":{"type":"integer"}, + "TrafficPolicyInstanceId":{ + "type":"string", + "max":36 + }, + "TrafficPolicyInstanceState":{"type":"string"}, + "TrafficPolicyInstances":{ + "type":"list", + "member":{ + "shape":"TrafficPolicyInstance", + "locationName":"TrafficPolicyInstance" + } + }, + "TrafficPolicyName":{ + "type":"string", + "max":512 + }, + "TrafficPolicySummaries":{ + "type":"list", + "member":{ + "shape":"TrafficPolicySummary", + "locationName":"TrafficPolicySummary" + } + }, + "TrafficPolicySummary":{ + "type":"structure", + "required":[ + "Id", + "Name", + "Type", + "LatestVersion", + "TrafficPolicyCount" + ], + "members":{ + "Id":{"shape":"TrafficPolicyId"}, + "Name":{"shape":"TrafficPolicyName"}, + "Type":{"shape":"RRType"}, + "LatestVersion":{"shape":"TrafficPolicyVersion"}, + "TrafficPolicyCount":{"shape":"TrafficPolicyVersion"} + } + }, + "TrafficPolicyVersion":{ + "type":"integer", + "max":1000, + "min":1 + }, + "TrafficPolicyVersionMarker":{ + "type":"string", + "max":4 + }, + "UpdateHealthCheckRequest":{ + "type":"structure", + "required":["HealthCheckId"], + "members":{ + "HealthCheckId":{ + "shape":"HealthCheckId", + "location":"uri", + "locationName":"HealthCheckId" + }, + "HealthCheckVersion":{"shape":"HealthCheckVersion"}, + "IPAddress":{"shape":"IPAddress"}, + "Port":{"shape":"Port"}, + "ResourcePath":{"shape":"ResourcePath"}, + "FullyQualifiedDomainName":{"shape":"FullyQualifiedDomainName"}, + "SearchString":{"shape":"SearchString"}, + "FailureThreshold":{"shape":"FailureThreshold"}, + "Inverted":{"shape":"Inverted"}, + "HealthThreshold":{"shape":"HealthThreshold"}, + "ChildHealthChecks":{"shape":"ChildHealthCheckList"}, + "EnableSNI":{"shape":"EnableSNI"}, + "Regions":{"shape":"HealthCheckRegionList"}, + "AlarmIdentifier":{"shape":"AlarmIdentifier"}, + "InsufficientDataHealthStatus":{"shape":"InsufficientDataHealthStatus"} + } + }, + "UpdateHealthCheckResponse":{ + "type":"structure", + "required":["HealthCheck"], + "members":{ + "HealthCheck":{"shape":"HealthCheck"} + } + }, + "UpdateHostedZoneCommentRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"ResourceId", + "location":"uri", + "locationName":"Id" + }, + "Comment":{"shape":"ResourceDescription"} + } + }, + "UpdateHostedZoneCommentResponse":{ + "type":"structure", + "required":["HostedZone"], + "members":{ + "HostedZone":{"shape":"HostedZone"} + } + }, + "UpdateTrafficPolicyCommentRequest":{ + "type":"structure", + "required":[ + "Id", + "Version", + "Comment" + ], + "members":{ + "Id":{ + "shape":"TrafficPolicyId", + "location":"uri", + "locationName":"Id" + }, + "Version":{ + "shape":"TrafficPolicyVersion", + "location":"uri", + "locationName":"Version" + }, + "Comment":{"shape":"TrafficPolicyComment"} + } + }, + "UpdateTrafficPolicyCommentResponse":{ + "type":"structure", + "required":["TrafficPolicy"], + "members":{ + "TrafficPolicy":{"shape":"TrafficPolicy"} + } + }, + "UpdateTrafficPolicyInstanceRequest":{ + "type":"structure", + "required":[ + "Id", + "TTL", + "TrafficPolicyId", + "TrafficPolicyVersion" + ], + "members":{ + "Id":{ + "shape":"TrafficPolicyInstanceId", + "location":"uri", + "locationName":"Id" + }, + "TTL":{"shape":"TTL"}, + "TrafficPolicyId":{"shape":"TrafficPolicyId"}, + "TrafficPolicyVersion":{"shape":"TrafficPolicyVersion"} + } + }, + "UpdateTrafficPolicyInstanceResponse":{ + "type":"structure", + "required":["TrafficPolicyInstance"], + "members":{ + "TrafficPolicyInstance":{"shape":"TrafficPolicyInstance"} + } + }, + "VPC":{ + "type":"structure", + "members":{ + "VPCRegion":{"shape":"VPCRegion"}, + "VPCId":{"shape":"VPCId"} + } + }, + "VPCAssociationNotFound":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "error":{"httpStatusCode":404}, + "exception":true + }, + "VPCId":{ + "type":"string", + "max":1024 + }, + "VPCRegion":{ + "type":"string", + "enum":[ + "us-east-1", + "us-west-1", + "us-west-2", + "eu-west-1", + "eu-central-1", + "ap-southeast-1", + "ap-southeast-2", + "ap-south-1", + "ap-northeast-1", + "ap-northeast-2", + "sa-east-1", + "cn-north-1" + ], + "max":64, + "min":1 + }, + "VPCs":{ + "type":"list", + "member":{ + "shape":"VPC", + "locationName":"VPC" + }, + "min":1 + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/route53/2013-04-01/docs-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/route53/2013-04-01/docs-2.json new file mode 100644 index 000000000..536f1b1b9 --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/route53/2013-04-01/docs-2.json @@ -0,0 +1,1794 @@ +{ + "version": "2.0", + "service": null, + "operations": { + "AssociateVPCWithHostedZone": "This action associates a VPC with an hosted zone.
To associate a VPC with an hosted zone, send a POST request to the /Route 53 API version/hostedzone/hosted zone ID/associatevpc resource. The request body must include a document with a AssociateVPCWithHostedZoneRequest element. The response returns the AssociateVPCWithHostedZoneResponse element that contains ChangeInfo for you to track the progress of the AssociateVPCWithHostedZoneRequest you made. See GetChange operation for how to track the progress of your change.
Use this action to create or change your authoritative DNS information. To use this action, send a POST request to the /Route 53 API version/hostedzone/hosted Zone ID/rrset resource. The request body must include a document with a ChangeResourceRecordSetsRequest element.
Changes are a list of change items and are considered transactional. For more information on transactional changes, also known as change batches, see POST ChangeResourceRecordSets in the Amazon Route 53 API Reference.
InvalidChangeBatch error.In response to a ChangeResourceRecordSets request, your DNS data is changed on all Amazon Route 53 DNS servers. Initially, the status of a change is PENDING. This means the change has not yet propagated to all the authoritative Amazon Route 53 DNS servers. When the change is propagated to all hosts, the change returns a status of INSYNC.
Note the following limitations on a ChangeResourceRecordSets request:
Value elements in a request cannot exceed 32,000 characters.This action creates a new health check.
To create a new health check, send a POST request to the /Route 53 API version/healthcheck resource. The request body must include a document with a CreateHealthCheckRequest element. The response returns the CreateHealthCheckResponse element that contains metadata about the health check.
This action creates a new hosted zone.
To create a new hosted zone, send a POST request to the /Route 53 API version/hostedzone resource. The request body must include a document with a CreateHostedZoneRequest element. The response returns the CreateHostedZoneResponse element that contains metadata about the hosted zone.
Amazon Route 53 automatically creates a default SOA record and four NS records for the zone. The NS records in the hosted zone are the name servers you give your registrar to delegate your domain to. For more information about SOA and NS records, see NS and SOA Records that Amazon Route 53 Creates for a Hosted Zone in the Amazon Route 53 Developer Guide.
When you create a zone, its initial status is PENDING. This means that it is not yet available on all DNS servers. The status of the zone changes to INSYNC when the NS and SOA records are available on all Amazon Route 53 DNS servers.
When trying to create a hosted zone using a reusable delegation set, you could specify an optional DelegationSetId, and Route53 would assign those 4 NS records for the zone, instead of alloting a new one.
", + "CreateReusableDelegationSet": "This action creates a reusable delegationSet.
To create a new reusable delegationSet, send a POST request to the /Route 53 API version/delegationset resource. The request body must include a document with a CreateReusableDelegationSetRequest element. The response returns the CreateReusableDelegationSetResponse element that contains metadata about the delegationSet.
If the optional parameter HostedZoneId is specified, it marks the delegationSet associated with that particular hosted zone as reusable.
", + "CreateTrafficPolicy": "Creates a traffic policy, which you use to create multiple DNS resource record sets for one domain name (such as example.com) or one subdomain name (such as www.example.com).
To create a traffic policy, send a POST request to the /Route 53 API version/trafficpolicy resource. The request body must include a document with a CreateTrafficPolicyRequest element. The response includes the CreateTrafficPolicyResponse element, which contains information about the new traffic policy.
Creates resource record sets in a specified hosted zone based on the settings in a specified traffic policy version. In addition, CreateTrafficPolicyInstance associates the resource record sets with a specified domain name (such as example.com) or subdomain name (such as www.example.com). Amazon Route 53 responds to DNS queries for the domain or subdomain name by using the resource record sets that CreateTrafficPolicyInstance created.
To create a traffic policy instance, send a POST request to the /Route 53 API version/trafficpolicyinstance resource. The request body must include a document with a CreateTrafficPolicyRequest element. The response returns the CreateTrafficPolicyInstanceResponse element, which contains information about the traffic policy instance.
Creates a new version of an existing traffic policy. When you create a new version of a traffic policy, you specify the ID of the traffic policy that you want to update and a JSON-formatted document that describes the new version.
You use traffic policies to create multiple DNS resource record sets for one domain name (such as example.com) or one subdomain name (such as www.example.com).
To create a new version, send a POST request to the /Route 53 API version/trafficpolicy/ resource. The request body includes a document with a CreateTrafficPolicyVersionRequest element. The response returns the CreateTrafficPolicyVersionResponse element, which contains information about the new version of the traffic policy.
This action deletes a health check. To delete a health check, send a DELETE request to the /Route 53 API version/healthcheck/health check ID resource.
HealthCheckInUse error. For information about disassociating the records from your health check, see ChangeResourceRecordSets.This action deletes a hosted zone. To delete a hosted zone, send a DELETE request to the /Route 53 API version/hostedzone/hosted zone ID resource.
HostedZoneNotEmpty error. For information about deleting records from your hosted zone, see ChangeResourceRecordSets.This action deletes a reusable delegation set. To delete a reusable delegation set, send a DELETE request to the /Route 53 API version/delegationset/delegation set ID resource.
DelegationSetInUse error.Deletes a traffic policy. To delete a traffic policy, send a DELETE request to the /Route 53 API version/trafficpolicy resource.
Deletes a traffic policy instance and all of the resource record sets that Amazon Route 53 created when you created the instance.
To delete a traffic policy instance, send a DELETE request to the /Route 53 API version/trafficpolicy/traffic policy instance ID resource.
This action disassociates a VPC from an hosted zone.
To disassociate a VPC to a hosted zone, send a POST request to the /Route 53 API version/hostedzone/hosted zone ID/disassociatevpc resource. The request body must include a document with a DisassociateVPCFromHostedZoneRequest element. The response returns the DisassociateVPCFromHostedZoneResponse element that contains ChangeInfo for you to track the progress of the DisassociateVPCFromHostedZoneRequest you made. See GetChange operation for how to track the progress of your change.
This action returns the current status of a change batch request. The status is one of the following values:
- PENDING indicates that the changes in this request have not replicated to all Amazon Route 53 DNS servers. This is the initial status of all change batch requests.
- INSYNC indicates that the changes have replicated to all Amazon Route 53 DNS servers.
This action returns the status and changes of a change batch request.
", + "GetCheckerIpRanges": "To retrieve a list of the IP ranges used by Amazon Route 53 health checkers to check the health of your resources, send a GET request to the /Route 53 API version/checkeripranges resource. You can use these IP addresses to configure router and firewall rules to allow health checkers to check the health of your resources.
To retrieve a single geo location, send a GET request to the /Route 53 API version/geolocation resource with one of these options: continentcode | countrycode | countrycode and subdivisioncode.
To retrieve the health check, send a GET request to the /Route 53 API version/healthcheck/health check ID resource.
To retrieve a count of all your health checks, send a GET request to the /Route 53 API version/healthcheckcount resource.
If you want to learn why a health check is currently failing or why it failed most recently (if at all), you can get the failure reason for the most recent failure. Send a GET request to the /Route 53 API version/healthcheck/health check ID/lastfailurereason resource.
To retrieve the health check status, send a GET request to the /Route 53 API version/healthcheck/health check ID/status resource. You can use this call to get a health check's current status.
To retrieve the delegation set for a hosted zone, send a GET request to the /Route 53 API version/hostedzone/hosted zone ID resource. The delegation set is the four Amazon Route 53 name servers that were assigned to the hosted zone when you created it.
To retrieve a count of all your hosted zones, send a GET request to the /Route 53 API version/hostedzonecount resource.
To retrieve the reusable delegation set, send a GET request to the /Route 53 API version/delegationset/delegation set ID resource.
Gets information about a specific traffic policy version. To get the information, send a GET request to the /Route 53 API version/trafficpolicy resource.
Gets information about a specified traffic policy instance.
To get information about the traffic policy instance, send a GET request to the /Route 53 API version/trafficpolicyinstance resource.
CreateTrafficPolicyInstance or an UpdateTrafficPolicyInstance request, there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. For more information, see the State response element.Gets the number of traffic policy instances that are associated with the current AWS account.
To get the number of traffic policy instances, send a GET request to the /Route 53 API version/trafficpolicyinstancecount resource.
This action gets the list of ChangeBatches in a given time period for a given hosted zone.
", + "ListChangeBatchesByRRSet": "This action gets the list of ChangeBatches in a given time period for a given hosted zone and RRSet.
", + "ListGeoLocations": "To retrieve a list of supported geo locations, send a GET request to the /Route 53 API version/geolocations resource. The response to this request includes a GeoLocationDetailsList element with zero, one, or multiple GeoLocationDetails child elements. The list is sorted by country code, and then subdivision code, followed by continents at the end of the list.
By default, the list of geo locations is displayed on a single page. You can control the length of the page that is displayed by using the MaxItems parameter. If the list is truncated, IsTruncated will be set to true and a combination of NextContinentCode, NextCountryCode, NextSubdivisionCode will be populated. You can pass these as parameters to StartContinentCode, StartCountryCode, StartSubdivisionCode to control the geo location that the list begins with.
To retrieve a list of your health checks, send a GET request to the /Route 53 API version/healthcheck resource. The response to this request includes a HealthChecks element with zero, one, or multiple HealthCheck child elements. By default, the list of health checks is displayed on a single page. You can control the length of the page that is displayed by using the MaxItems parameter. You can use the Marker parameter to control the health check that the list begins with.
To retrieve a list of your hosted zones, send a GET request to the /Route 53 API version/hostedzone resource. The response to this request includes a HostedZones element with zero, one, or multiple HostedZone child elements. By default, the list of hosted zones is displayed on a single page. You can control the length of the page that is displayed by using the MaxItems parameter. You can use the Marker parameter to control the hosted zone that the list begins with.
To retrieve a list of your hosted zones in lexicographic order, send a GET request to the /Route 53 API version/hostedzonesbyname resource. The response to this request includes a HostedZones element with zero or more HostedZone child elements lexicographically ordered by DNS name. By default, the list of hosted zones is displayed on a single page. You can control the length of the page that is displayed by using the MaxItems parameter. You can use the DNSName and HostedZoneId parameters to control the hosted zone that the list begins with.
List the resource record sets in a specified hosted zone. Send a GET request to the 2013-04-01/hostedzone/hosted zone ID/rrset resource.
ListResourceRecordSets returns up to 100 resource record sets at a time in ASCII order, beginning at a position specified by the name and type elements. The action sorts results first by DNS name with the labels reversed, for example:
com.example.www.
Note the trailing dot, which can change the sort order in some circumstances. When multiple records have the same DNS name, the action sorts results by the record type.
You can use the name and type elements to adjust the beginning position of the list of resource record sets returned:
Name or Type: The results begin with the first resource record set that the hosted zone contains.Name but not Type: The results begin with the first resource record set in the list whose name is greater than or equal to Name.Type but not Name: Amazon Route 53 returns the InvalidInput error.Name and Type: The results begin with the first resource record set in the list whose name is greater than or equal to Name, and whose type is greater than or equal to Type.This action returns the most current version of the records. This includes records that are PENDING, and that are not yet available on all Amazon Route 53 DNS servers.
To ensure that you get an accurate listing of the resource record sets for a hosted zone at a point in time, do not submit a ChangeResourceRecordSets request while you are paging through the results of a ListResourceRecordSets request. If you do, some pages may display results without the latest changes while other pages display results with the latest changes.
To retrieve a list of your reusable delegation sets, send a GET request to the /Route 53 API version/delegationset resource. The response to this request includes a DelegationSets element with zero, one, or multiple DelegationSet child elements. By default, the list of delegation sets is displayed on a single page. You can control the length of the page that is displayed by using the MaxItems parameter. You can use the Marker parameter to control the delegation set that the list begins with.
Gets information about the latest version for every traffic policy that is associated with the current AWS account. To get the information, send a GET request to the /Route 53 API version/trafficpolicy resource.
Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policies, you can use the maxitems parameter to list them in groups of up to 100.
The response includes three values that help you navigate from one group of maxitems traffic policies to the next:
If the value of IsTruncated in the response is true, there are more traffic policies associated with the current AWS account.
If IsTruncated is false, this response includes the last traffic policy that is associated with the current account.
If IsTruncated is true, TrafficPolicyIdMarker is the ID of the first traffic policy in the next group of MaxItems traffic policies. If you want to list more traffic policies, make another call to ListTrafficPolicies, and specify the value of the TrafficPolicyIdMarker element from the response in the TrafficPolicyIdMarker request parameter.
If IsTruncated is false, the TrafficPolicyIdMarker element is omitted from the response.
The value that you specified for the MaxItems parameter in the request that produced the current response.
Gets information about the traffic policy instances that you created by using the current AWS account.
UpdateTrafficPolicyInstance request, there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. For more information, see the State response element.To get information about the traffic policy instances that are associated with the current AWS account, send a GET request to the /Route 53 API version/trafficpolicyinstance resource.
Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances, you can use the MaxItems parameter to list them in groups of up to 100.
The response includes five values that help you navigate from one group of MaxItems traffic policy instances to the next:
If the value of IsTruncated in the response is true, there are more traffic policy instances associated with the current AWS account.
If IsTruncated is false, this response includes the last traffic policy instance that is associated with the current account.
The value that you specified for the MaxItems parameter in the request that produced the current response.
If IsTruncated is true, these three values in the response represent the first traffic policy instance in the next group of MaxItems traffic policy instances. To list more traffic policy instances, make another call to ListTrafficPolicyInstances, and specify these values in the corresponding request parameters.
If IsTruncated is false, all three elements are omitted from the response.
Gets information about the traffic policy instances that you created in a specified hosted zone.
UpdateTrafficPolicyInstance request, there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. For more information, see the State response element.To get information about the traffic policy instances that you created in a specified hosted zone, send a GET request to the /Route 53 API version/trafficpolicyinstance resource and include the ID of the hosted zone.
Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances, you can use the MaxItems parameter to list them in groups of up to 100.
The response includes four values that help you navigate from one group of MaxItems traffic policy instances to the next:
If the value of IsTruncated in the response is true, there are more traffic policy instances associated with the current AWS account.
If IsTruncated is false, this response includes the last traffic policy instance that is associated with the current account.
The value that you specified for the MaxItems parameter in the request that produced the current response.
If IsTruncated is true, these two values in the response represent the first traffic policy instance in the next group of MaxItems traffic policy instances. To list more traffic policy instances, make another call to ListTrafficPolicyInstancesByHostedZone, and specify these values in the corresponding request parameters.
If IsTruncated is false, all three elements are omitted from the response.
Gets information about the traffic policy instances that you created by using a specify traffic policy version.
CreateTrafficPolicyInstance or an UpdateTrafficPolicyInstance request, there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. For more information, see the State response element.To get information about the traffic policy instances that you created by using a specify traffic policy version, send a GET request to the /Route 53 API version/trafficpolicyinstance resource and include the ID and version of the traffic policy.
Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances, you can use the MaxItems parameter to list them in groups of up to 100.
The response includes five values that help you navigate from one group of MaxItems traffic policy instances to the next:
If the value of IsTruncated in the response is true, there are more traffic policy instances associated with the specified traffic policy.
If IsTruncated is false, this response includes the last traffic policy instance that is associated with the specified traffic policy.
The value that you specified for the MaxItems parameter in the request that produced the current response.
If IsTruncated is true, these values in the response represent the first traffic policy instance in the next group of MaxItems traffic policy instances. To list more traffic policy instances, make another call to ListTrafficPolicyInstancesByPolicy, and specify these values in the corresponding request parameters.
If IsTruncated is false, all three elements are omitted from the response.
Gets information about all of the versions for a specified traffic policy. ListTrafficPolicyVersions lists only versions that have not been deleted.
Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policies, you can use the maxitems parameter to list them in groups of up to 100.
The response includes three values that help you navigate from one group of maxitemsmaxitems traffic policies to the next:
If the value of IsTruncated in the response is true, there are more traffic policy versions associated with the specified traffic policy.
If IsTruncated is false, this response includes the last traffic policy version that is associated with the specified traffic policy.
The ID of the next traffic policy version that is associated with the current AWS account. If you want to list more traffic policies, make another call to ListTrafficPolicyVersions, and specify the value of the TrafficPolicyVersionMarker element in the TrafficPolicyVersionMarker request parameter.
If IsTruncated is false, Amazon Route 53 omits the TrafficPolicyVersionMarker element from the response.
The value that you specified for the MaxItems parameter in the request that produced the current response.
This action updates an existing health check.
To update a health check, send a POST request to the /Route 53 API version/healthcheck/health check ID resource. The request body must include a document with an UpdateHealthCheckRequest element. The response returns an UpdateHealthCheckResponse element, which contains metadata about the health check.
To update the hosted zone comment, send a POST request to the /Route 53 API version/hostedzone/hosted zone ID resource. The request body must include a document with a UpdateHostedZoneCommentRequest element. The response to this request includes the modified HostedZone element.
Updates the comment for a specified traffic policy version.
To update the comment, send a POST request to the /Route 53 API version/trafficpolicy/ resource.
The request body must include a document with an UpdateTrafficPolicyCommentRequest element.
Updates the resource record sets in a specified hosted zone that were created based on the settings in a specified traffic policy version.
When you update a traffic policy instance, Amazon Route 53 continues to respond to DNS queries for the root resource record set name (such as example.com) while it replaces one group of resource record sets with another. Amazon Route 53 performs the following operations:
To update a traffic policy instance, send a POST request to the /Route 53 API version/trafficpolicyinstance/traffic policy ID resource. The request body must include a document with an UpdateTrafficPolicyInstanceRequest element.
The AWS account ID attached to the changes.
" + } + }, + "AlarmIdentifier": { + "base": "A complex type that contains information to uniquely identify the CloudWatch alarm that you're associating with a Route 53 health check.
", + "refs": { + "HealthCheckConfig$AlarmIdentifier": "A complex type that contains information to uniquely identify the CloudWatch alarm that you're associating with a Route 53 health check.
", + "UpdateHealthCheckRequest$AlarmIdentifier": null + } + }, + "AlarmName": { + "base": null, + "refs": { + "AlarmIdentifier$Name": "The name of the CloudWatch alarm.
" + } + }, + "AliasHealthEnabled": { + "base": null, + "refs": { + "AliasTarget$EvaluateTargetHealth": "Alias resource record sets only: If you set the value of EvaluateTargetHealth to true for the resource record set or sets in an alias, weighted alias, latency alias, or failover alias resource record set, and if you specify a value for HealthCheckId for every resource record set that is referenced by these alias resource record sets, the alias resource record sets inherit the health of the referenced resource record sets.
In this configuration, when Amazon Route 53 receives a DNS query for an alias resource record set:
Note the following:
EvaluateTargetHealth to true when the alias target is a CloudFront distribution.AliasTarget is a resource record set or a group of resource record sets (for example, a group of weighted resource record sets), but it is not another alias resource record set, we recommend that you associate a health check with all of the resource record sets in the alias target.AliasTarget, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. If no Amazon EC2 instances are healthy or if the load balancer itself is unhealthy, and if EvaluateTargetHealth is true for the corresponding alias resource record set, Amazon Route 53 routes queries to other resources.We recommend that you set EvaluateTargetHealth to true only when you have enough idle capacity to handle the failure of one or more endpoints.
For more information and examples, see Amazon Route 53 Health Checks and DNS Failover in the Amazon Route 53 Developer Guide.
" + } + }, + "AliasTarget": { + "base": "Alias resource record sets only: Information about the CloudFront distribution, ELB load balancer, Amazon S3 bucket, or Amazon Route 53 resource record set to which you are routing traffic.
If you're creating resource record sets for a private hosted zone, note the following:
Alias resource record sets only: Information about the AWS resource to which you are redirecting traffic.
" + } + }, + "AssociateVPCComment": { + "base": null, + "refs": { + "AssociateVPCWithHostedZoneRequest$Comment": "Optional: Any comments you want to include about a AssociateVPCWithHostedZoneRequest.
A complex type that contains information about the request to associate a VPC with an hosted zone.
", + "refs": { + } + }, + "AssociateVPCWithHostedZoneResponse": { + "base": "A complex type containing the response information for the request.
", + "refs": { + } + }, + "Change": { + "base": "A complex type that contains the information for each change in a change batch request.
", + "refs": { + "Changes$member": null + } + }, + "ChangeAction": { + "base": null, + "refs": { + "Change$Action": "The action to perform:
CREATE: Creates a resource record set that has the specified values.DELETE: Deletes a existing resource record set that has the specified values for Name, Type, SetIdentifier (for latency, weighted, geolocation, and failover resource record sets), and TTL (except alias resource record sets, for which the TTL is determined by the AWS resource that you're routing DNS queries to).UPSERT: If a resource record set does not already exist, Amazon Route 53 creates it. If a resource record set does exist, Amazon Route 53 updates it with the values in the request. Amazon Route 53 can update an existing resource record set only when all of the following values match: Name, Type, and SetIdentifier (for weighted, latency, geolocation, and failover resource record sets).A complex type that contains an optional comment and the changes that you want to make with a change batch request.
", + "refs": { + "ChangeResourceRecordSetsRequest$ChangeBatch": "A complex type that contains an optional comment and the Changes element.
A complex type that lists the changes and information for a ChangeBatch.
", + "refs": { + "ChangeBatchRecords$member": null, + "GetChangeDetailsResponse$ChangeBatchRecord": "A complex type that contains information about the specified change batch, including the change batch ID, the status of the change, and the contained changes.
" + } + }, + "ChangeBatchRecords": { + "base": null, + "refs": { + "ListChangeBatchesByHostedZoneResponse$ChangeBatchRecords": "The change batches within the given hosted zone and time period.
", + "ListChangeBatchesByRRSetResponse$ChangeBatchRecords": "The change batches within the given hosted zone and time period.
" + } + }, + "ChangeInfo": { + "base": "A complex type that describes change information about changes made to your hosted zone.
This element contains an ID that you use when performing a GetChange action to get detailed information about the change.
A complex type that contains the ID, the status, and the date and time of your AssociateVPCWithHostedZoneRequest.
A complex type that contains information about changes made to your hosted zone.
This element contains an ID that you use when performing a GetChange action to get detailed information about the change.
A complex type that contains information about the request to create a hosted zone. This includes an ID that you use when you call the GetChange action to get the current status of the change request.
A complex type that contains the ID, the status, and the date and time of your delete request.
", + "DisassociateVPCFromHostedZoneResponse$ChangeInfo": "A complex type that contains the ID, the status, and the date and time of your DisassociateVPCFromHostedZoneRequest.
A complex type that contains information about the specified change batch, including the change batch ID, the status of the change, and the date and time of the request.
" + } + }, + "ChangeResourceRecordSetsRequest": { + "base": "A complex type that contains a change batch.
", + "refs": { + } + }, + "ChangeResourceRecordSetsResponse": { + "base": "A complex type containing the response for the request.
", + "refs": { + } + }, + "ChangeStatus": { + "base": null, + "refs": { + "ChangeBatchRecord$Status": "The current state of the request. PENDING indicates that this request has not yet been applied to all Amazon Route 53 DNS servers.
Valid Values: PENDING | INSYNC
The current state of the request. PENDING indicates that this request has not yet been applied to all Amazon Route 53 DNS servers.
Valid Values: PENDING | INSYNC
A complex type containing information about a request to add, change, or delete the tags that are associated with a resource.
", + "refs": { + } + }, + "ChangeTagsForResourceResponse": { + "base": "Empty response for the request.
", + "refs": { + } + }, + "Changes": { + "base": null, + "refs": { + "ChangeBatch$Changes": "A complex type that contains one Change element for each resource record set that you want to create or delete.
A list of changes made in the ChangeBatch.
" + } + }, + "CheckerIpRanges": { + "base": null, + "refs": { + "GetCheckerIpRangesResponse$CheckerIpRanges": "A complex type that contains sorted list of IP ranges in CIDR format for Amazon Route 53 health checkers.
" + } + }, + "ChildHealthCheckList": { + "base": null, + "refs": { + "HealthCheckConfig$ChildHealthChecks": "For a specified parent health check, a list of HealthCheckId values for the associated child health checks.
For a specified parent health check, a list of HealthCheckId values for the associated child health checks.
Specify this value only if you want to change it.
" + } + }, + "CloudWatchAlarmConfiguration": { + "base": "For CLOUDWATCH_METRIC health checks, a complex type that contains information about the CloudWatch alarm that you're associating with the health check.
", + "refs": { + "HealthCheck$CloudWatchAlarmConfiguration": "For CLOUDWATCH_METRIC health checks, a complex type that contains information about the CloudWatch alarm that you're associating with the health check.
" + } + }, + "CloudWatchRegion": { + "base": null, + "refs": { + "AlarmIdentifier$Region": "The CloudWatchRegion that the CloudWatch alarm was created in.
The arithmetic operation to use when comparing the specified Statistic and Threshold.
Valid Values are GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold and LessThanOrEqualToThreshold
Another user submitted a request to update the object at the same time that you did. Retry the request.
", + "refs": { + } + }, + "ConflictingDomainExists": { + "base": null, + "refs": { + } + }, + "ConflictingTypes": { + "base": "You tried to update a traffic policy instance by using a traffic policy version that has a different DNS type than the current type for the instance. You specified the type in the JSON document in the CreateTrafficPolicy or CreateTrafficPolicyVersionrequest.
>A complex type that contains information about the request to create a health check.
", + "refs": { + } + }, + "CreateHealthCheckResponse": { + "base": "A complex type containing the response information for the new health check.
", + "refs": { + } + }, + "CreateHostedZoneRequest": { + "base": "A complex type that contains information about the request to create a hosted zone.
", + "refs": { + } + }, + "CreateHostedZoneResponse": { + "base": "A complex type containing the response information for the new hosted zone.
", + "refs": { + } + }, + "CreateReusableDelegationSetRequest": { + "base": null, + "refs": { + } + }, + "CreateReusableDelegationSetResponse": { + "base": null, + "refs": { + } + }, + "CreateTrafficPolicyInstanceRequest": { + "base": "A complex type that contains information about the resource record sets that you want to create based on a specified traffic policy.
", + "refs": { + } + }, + "CreateTrafficPolicyInstanceResponse": { + "base": "A complex type that contains the response information for the CreateTrafficPolicyInstance request.
A complex type that contains information about the traffic policy that you want to create.
", + "refs": { + } + }, + "CreateTrafficPolicyResponse": { + "base": "A complex type that contains the response information for the CreateTrafficPolicy request.
A complex type that contains information about the traffic policy for which you want to create a new version.
", + "refs": { + } + }, + "CreateTrafficPolicyVersionResponse": { + "base": "A complex type that contains the response information for the CreateTrafficPolicyVersion request.
Alias resource record sets only: The external DNS name associated with the AWS Resource. The value that you specify depends on where you want to route queries:
acme.example.com, your CloudFront distribution must include acme.example.com as one of the alternate domain names. For more information, see Using Alternate Domain Names (CNAMEs) in the Amazon CloudFront Developer Guide.HostedZoneId and DNSName. If you get one value from the console and the other value from the API or the CLI, creating the resource record set will fail.s3-website-us-east-1.amazonaws.com. For more information about valid values, see the table Amazon Simple Storage Service (S3) Website Endpoints in the Amazon Web Services General Reference. For more information about using Amazon S3 buckets for websites, see Hosting a Static Website on Amazon S3 in the Amazon Simple Storage Service Developer Guide.Name element for a resource record set in the current hosted zone.The name of the domain. This must be a fully-specified domain, for example, www.example.com. The trailing dot is optional; Amazon Route 53 assumes that the domain name is fully qualified. This means that Amazon Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical.
This is the name you have registered with your DNS registrar. You should ask your registrar to change the authoritative name servers for your domain to the set of NameServers elements returned in DelegationSet.
The domain name (such as example.com) or subdomain name (such as www.example.com) for which Amazon Route 53 responds to DNS queries by using the resource record sets that Amazon Route 53 creates for this traffic policy instance.
", + "DelegationSetNameServers$member": null, + "HostedZone$Name": "The name of the domain. This must be a fully-specified domain, for example, www.example.com. The trailing dot is optional; Amazon Route 53 assumes that the domain name is fully qualified. This means that Amazon Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical.
This is the name you have registered with your DNS registrar. You should ask your registrar to change the authoritative name servers for your domain to the set of NameServers elements returned in DelegationSet.
The name of the RRSet that you want to see changes for.
", + "ListHostedZonesByNameRequest$DNSName": "The first name in the lexicographic ordering of domain names that you want the ListHostedZonesByNameRequest request to list.
If the request returned more than one page of results, submit another request and specify the value of NextDNSName and NextHostedZoneId from the last response in the DNSName and HostedZoneId parameters to get the next page of results.
The DNSName value sent in the request.
If the value of IsTruncated in the ListHostedZonesByNameResponse is true, there are more hosted zones associated with the current AWS account. To get the next page of results, make another request to ListHostedZonesByName. Specify the value of NextDNSName in the DNSName parameter. Specify NextHostedZoneId in the HostedZoneId parameter.
The first name in the lexicographic ordering of domain names that you want the ListResourceRecordSets request to list.
If the results were truncated, the name of the next record in the list. This element is present only if IsTruncated is true.
For the first request to ListTrafficPolicyInstancesByHostedZone, omit this value.
If the value of IsTruncated in the previous response was true, TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance in the next group of MaxItems traffic policy instances.
If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get for this hosted zone.
If the value of IsTruncated in the previous response was false, omit this value.
If IsTruncated is true, TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance in the next group of MaxItems traffic policy instances.
For the first request to ListTrafficPolicyInstancesByPolicy, omit this value.
If the value of IsTruncated in the previous response was true, TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance in the next group of MaxItems traffic policy instances.
If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get for this hosted zone.
If the value of IsTruncated in the previous response was false, omit this value.
If IsTruncated is true, TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance in the next group of MaxItems traffic policy instances.
For the first request to ListTrafficPolicyInstances, omit this value.
If the value of IsTruncated in the previous response was true, TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance in the next group of MaxItems traffic policy instances.
If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.
If IsTruncated is true, TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance in the next group of MaxItems traffic policy instances.
The name of the domain you want to perform the action on.
Enter a fully qualified domain name, for example, www.example.com. You can optionally include a trailing dot. If you omit the trailing dot, Amazon Route 53 still assumes that the domain name that you specify is fully qualified. This means that Amazon Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical.
For information about how to specify characters other than a-z, 0-9, and - (hyphen) and how to specify internationalized domain names, see DNS Domain Name Format in the Amazon Route 53 Developer Guide.
You can use an asterisk (*) character in the name. DNS treats the * character either as a wildcard or as the * character (ASCII 42), depending on where it appears in the name. For more information, see Using an Asterisk (*) in the Names of Hosted Zones and Resource Record Sets in the Amazon Route 53 Developer Guide
The start of the time period you want to see changes for.
", + "ListChangeBatchesByHostedZoneRequest$EndDate": "The end of the time period you want to see changes for.
", + "ListChangeBatchesByRRSetRequest$StartDate": "The start of the time period you want to see changes for.
", + "ListChangeBatchesByRRSetRequest$EndDate": "The end of the time period you want to see changes for.
" + } + }, + "DelegationSet": { + "base": "A complex type that contains name server information.
", + "refs": { + "CreateHostedZoneResponse$DelegationSet": "A complex type that contains name server information.
", + "CreateReusableDelegationSetResponse$DelegationSet": "A complex type that contains name server information.
", + "DelegationSets$member": null, + "GetHostedZoneResponse$DelegationSet": "A complex type that contains information about the name servers for the specified hosted zone.
", + "GetReusableDelegationSetResponse$DelegationSet": "A complex type that contains the information about the nameservers for the specified delegation set ID.
" + } + }, + "DelegationSetAlreadyCreated": { + "base": "A delegation set with the same owner and caller reference combination has already been created.
", + "refs": { + } + }, + "DelegationSetAlreadyReusable": { + "base": "The specified delegation set has already been marked as reusable.
", + "refs": { + } + }, + "DelegationSetInUse": { + "base": "The specified delegation contains associated hosted zones which must be deleted before the reusable delegation set can be deleted.
", + "refs": { + } + }, + "DelegationSetNameServers": { + "base": null, + "refs": { + "DelegationSet$NameServers": "A complex type that contains the authoritative name servers for the hosted zone. Use the method provided by your domain registrar to add an NS record to your domain for each NameServer that is assigned to your hosted zone.
Amazon Route 53 allows some duplicate domain names, but there is a maximum number of duplicate names. This error indicates that you have reached that maximum. If you want to create another hosted zone with the same name and Amazon Route 53 generates this error, you can request an increase to the limit on the Contact Us page.
", + "refs": { + } + }, + "DelegationSetNotReusable": { + "base": "The specified delegation set has not been marked as reusable.
", + "refs": { + } + }, + "DelegationSets": { + "base": null, + "refs": { + "ListReusableDelegationSetsResponse$DelegationSets": "A complex type that contains information about the reusable delegation sets associated with the current AWS account.
" + } + }, + "DeleteHealthCheckRequest": { + "base": "A complex type containing the request information for delete health check.
", + "refs": { + } + }, + "DeleteHealthCheckResponse": { + "base": "Empty response for the request.
", + "refs": { + } + }, + "DeleteHostedZoneRequest": { + "base": "A complex type that contains information about the hosted zone that you want to delete.
", + "refs": { + } + }, + "DeleteHostedZoneResponse": { + "base": "A complex type containing the response information for the request.
", + "refs": { + } + }, + "DeleteReusableDelegationSetRequest": { + "base": "A complex type containing the information for the delete request.
", + "refs": { + } + }, + "DeleteReusableDelegationSetResponse": { + "base": "Empty response for the request.
", + "refs": { + } + }, + "DeleteTrafficPolicyInstanceRequest": { + "base": "A complex type that contains information about the traffic policy instance that you want to delete.
", + "refs": { + } + }, + "DeleteTrafficPolicyInstanceResponse": { + "base": "An empty element.
", + "refs": { + } + }, + "DeleteTrafficPolicyRequest": { + "base": "A request to delete a specified traffic policy version.
", + "refs": { + } + }, + "DeleteTrafficPolicyResponse": { + "base": "An empty element.
", + "refs": { + } + }, + "Dimension": { + "base": "The name and value of a dimension for a CloudWatch metric.
", + "refs": { + "DimensionList$member": null + } + }, + "DimensionField": { + "base": null, + "refs": { + "Dimension$Name": "The name of the dimension.
", + "Dimension$Value": "The value of the dimension.
" + } + }, + "DimensionList": { + "base": null, + "refs": { + "CloudWatchAlarmConfiguration$Dimensions": "A list of Dimension elements for the CloudWatch metric that is associated with the CloudWatch alarm. For information about the metrics and dimensions that CloudWatch supports, see Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference.
Optional: Any comments you want to include about a DisassociateVPCFromHostedZoneRequest.
A complex type that contains information about the request to disassociate a VPC from an hosted zone.
", + "refs": { + } + }, + "DisassociateVPCFromHostedZoneResponse": { + "base": "A complex type containing the response information for the request.
", + "refs": { + } + }, + "EnableSNI": { + "base": null, + "refs": { + "HealthCheckConfig$EnableSNI": "Specify whether you want Amazon Route 53 to send the value of FullyQualifiedDomainName to the endpoint in the client_hello message during TLS negotiation. If you don't specify a value for EnableSNI, Amazon Route 53 defaults to true when Type is HTTPS or HTTPS_STR_MATCH and defaults to false when Type is any other value.
Specify whether you want Amazon Route 53 to send the value of FullyQualifiedDomainName to the endpoint in the client_hello message during TLS negotiation. If you don't specify a value for EnableSNI, Amazon Route 53 defaults to true when Type is HTTPS or HTTPS_STR_MATCH and defaults to false when Type is any other value.
Specify this value only if you want to change it.
" + } + }, + "ErrorMessage": { + "base": null, + "refs": { + "ConcurrentModification$message": "Descriptive message for the error response.
", + "ConflictingDomainExists$message": null, + "ConflictingTypes$message": "Descriptive message for the error response.
", + "DelegationSetAlreadyCreated$message": "Descriptive message for the error response.
", + "DelegationSetAlreadyReusable$message": "Descriptive message for the error response.
", + "DelegationSetInUse$message": "Descriptive message for the error response.
", + "DelegationSetNotAvailable$message": "Descriptive message for the error response.
", + "DelegationSetNotReusable$message": "Descriptive message for the error response.
", + "ErrorMessages$member": null, + "HealthCheckAlreadyExists$message": "Descriptive message for the error response.
", + "HealthCheckInUse$message": "Descriptive message for the error response.
", + "HealthCheckVersionMismatch$message": null, + "HostedZoneAlreadyExists$message": "Descriptive message for the error response.
", + "HostedZoneNotEmpty$message": "Descriptive message for the error response.
", + "HostedZoneNotFound$message": "Descriptive message for the error response.
", + "IncompatibleVersion$message": null, + "InvalidArgument$message": "Descriptive message for the error response.
", + "InvalidDomainName$message": "Descriptive message for the error response.
", + "InvalidInput$message": "Descriptive message for the error response.
", + "InvalidTrafficPolicyDocument$message": "Descriptive message for the error response.
", + "InvalidVPCId$message": "Descriptive message for the error response.
", + "LastVPCAssociation$message": "Descriptive message for the error response.
", + "LimitsExceeded$message": "Descriptive message for the error response.
", + "NoSuchChange$message": null, + "NoSuchDelegationSet$message": "Descriptive message for the error response.
", + "NoSuchGeoLocation$message": "Descriptive message for the error response.
", + "NoSuchHealthCheck$message": "Descriptive message for the error response.
", + "NoSuchHostedZone$message": null, + "NoSuchTrafficPolicy$message": "Descriptive message for the error response.
", + "NoSuchTrafficPolicyInstance$message": "Descriptive message for the error response.
", + "PriorRequestNotComplete$message": null, + "PublicZoneVPCAssociation$message": "Descriptive message for the error response.
", + "ThrottlingException$message": null, + "TooManyHealthChecks$message": null, + "TooManyHostedZones$message": "Descriptive message for the error response.
", + "TooManyTrafficPolicies$message": "Descriptive message for the error response.
", + "TooManyTrafficPolicyInstances$message": "Descriptive message for the error response.
", + "TrafficPolicyAlreadyExists$message": "Descriptive message for the error response.
", + "TrafficPolicyInUse$message": "Descriptive message for the error response.
", + "TrafficPolicyInstanceAlreadyExists$message": "Descriptive message for the error response.
", + "VPCAssociationNotFound$message": "Descriptive message for the error response.
" + } + }, + "ErrorMessages": { + "base": null, + "refs": { + "InvalidChangeBatch$messages": "Descriptive message for the error response.
" + } + }, + "EvaluationPeriods": { + "base": null, + "refs": { + "CloudWatchAlarmConfiguration$EvaluationPeriods": "The number of periods over which data is compared to the specified threshold.
" + } + }, + "FailureThreshold": { + "base": null, + "refs": { + "HealthCheckConfig$FailureThreshold": "The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa.
Valid values are integers between 1 and 10. For more information, see \"How Amazon Route 53 Determines Whether an Endpoint Is Healthy\" in the Amazon Route 53 Developer Guide.
", + "UpdateHealthCheckRequest$FailureThreshold": "The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa.
Valid values are integers between 1 and 10. For more information, see \"How Amazon Route 53 Determines Whether an Endpoint Is Healthy\" in the Amazon Route 53 Developer Guide.
Specify this value only if you want to change it.
" + } + }, + "FullyQualifiedDomainName": { + "base": null, + "refs": { + "HealthCheckConfig$FullyQualifiedDomainName": "Fully qualified domain name of the instance to be health checked.
", + "UpdateHealthCheckRequest$FullyQualifiedDomainName": "Fully qualified domain name of the instance to be health checked.
Specify this value only if you want to change it.
" + } + }, + "GeoLocation": { + "base": "A complex type that contains information about a geo location.
", + "refs": { + "ResourceRecordSet$GeoLocation": "Geo location resource record sets only: A complex type that lets you control how Amazon Route 53 responds to DNS queries based on the geographic origin of the query. For example, if you want all queries from Africa to be routed to a web server with an IP address of 192.0.2.111, create a resource record set with a Type of A and a ContinentCode of AF.
If you create separate resource record sets for overlapping geographic regions (for example, one resource record set for a continent and one for a country on the same continent), priority goes to the smallest geographic region. This allows you to route most queries for a continent to one resource and to route queries for a country on that continent to a different resource.
You cannot create two geolocation resource record sets that specify the same geographic location.
The value * in the CountryCode element matches all geographic locations that aren't specified in other geolocation resource record sets that have the same values for the Name and Type elements.
CountryCode is *, which handles both queries that come from locations for which you haven't created geolocation resource record sets and queries from IP addresses that aren't mapped to a location. If you don't create a * resource record set, Amazon Route 53 returns a \"no answer\" response for queries from those locations.You cannot create non-geolocation resource record sets that have the same values for the Name and Type elements as geolocation resource record sets.
The code for a continent geo location. Note: only continent locations have a continent code.
Valid values: AF | AN | AS | EU | OC | NA | SA
Constraint: Specifying ContinentCode with either CountryCode or SubdivisionCode returns an InvalidInput error.
The code for a continent geo location. Note: only continent locations have a continent code.
", + "GetGeoLocationRequest$ContinentCode": "The code for a continent geo location. Note: only continent locations have a continent code.
Valid values: AF | AN | AS | EU | OC | NA | SA
Constraint: Specifying ContinentCode with either CountryCode or SubdivisionCode returns an InvalidInput error.
The first continent code in the lexicographic ordering of geo locations that you want the ListGeoLocations request to list. For non-continent geo locations, this should be null.
Valid values: AF | AN | AS | EU | OC | NA | SA
Constraint: Specifying ContinentCode with either CountryCode or SubdivisionCode returns an InvalidInput error.
If the results were truncated, the continent code of the next geo location in the list. This element is present only if IsTruncated is true and the next geo location to list is a continent location.
The name of the continent. This element is only present if ContinentCode is also present.
The code for a country geo location. The default location uses '*' for the country code and will match all locations that are not matched by a geo location.
The default geo location uses a * for the country code. All other country codes follow the ISO 3166 two-character code.
The code for a country geo location. The default location uses '*' for the country code and will match all locations that are not matched by a geo location.
The default geo location uses a * for the country code. All other country codes follow the ISO 3166 two-character code.
The code for a country geo location. The default location uses '*' for the country code and will match all locations that are not matched by a geo location.
The default geo location uses a * for the country code. All other country codes follow the ISO 3166 two-character code.
The first country code in the lexicographic ordering of geo locations that you want the ListGeoLocations request to list.
The default geo location uses a * for the country code. All other country codes follow the ISO 3166 two-character code.
If the results were truncated, the country code of the next geo location in the list. This element is present only if IsTruncated is true and the next geo location to list is not a continent location.
The name of the country. This element is only present if CountryCode is also present.
A complex type that contains information about a GeoLocation.
A complex type that contains the information about the specified geo location.
" + } + }, + "GeoLocationDetailsList": { + "base": null, + "refs": { + "ListGeoLocationsResponse$GeoLocationDetailsList": "A complex type that contains information about the geo locations that are returned by the request.
" + } + }, + "GeoLocationSubdivisionCode": { + "base": null, + "refs": { + "GeoLocation$SubdivisionCode": "The code for a country's subdivision (e.g., a province of Canada). A subdivision code is only valid with the appropriate country code.
Constraint: Specifying SubdivisionCode without CountryCode returns an InvalidInput error.
The code for a country's subdivision (e.g., a province of Canada). A subdivision code is only valid with the appropriate country code.
", + "GetGeoLocationRequest$SubdivisionCode": "The code for a country's subdivision (e.g., a province of Canada). A subdivision code is only valid with the appropriate country code.
Constraint: Specifying SubdivisionCode without CountryCode returns an InvalidInput error.
The first subdivision code in the lexicographic ordering of geo locations that you want the ListGeoLocations request to list.
Constraint: Specifying SubdivisionCode without CountryCode returns an InvalidInput error.
If the results were truncated, the subdivision code of the next geo location in the list. This element is present only if IsTruncated is true and the next geo location has a subdivision.
The name of the subdivision. This element is only present if SubdivisionCode is also present.
The input for a GetChangeDetails request.
", + "refs": { + } + }, + "GetChangeDetailsResponse": { + "base": "A complex type that contains the ChangeBatchRecord element.
The input for a GetChange request.
", + "refs": { + } + }, + "GetChangeResponse": { + "base": "A complex type that contains the ChangeInfo element.
Empty request.
", + "refs": { + } + }, + "GetCheckerIpRangesResponse": { + "base": "A complex type that contains the CheckerIpRanges element.
A complex type that contains information about the request to get a geo location.
", + "refs": { + } + }, + "GetGeoLocationResponse": { + "base": "A complex type containing information about the specified geo location.
", + "refs": { + } + }, + "GetHealthCheckCountRequest": { + "base": "To retrieve a count of all your health checks, send a GET request to the /Route 53 API version/healthcheckcount resource.
A complex type that contains the count of health checks associated with the current AWS account.
", + "refs": { + } + }, + "GetHealthCheckLastFailureReasonRequest": { + "base": "A complex type that contains information about the request to get the most recent failure reason for a health check.
", + "refs": { + } + }, + "GetHealthCheckLastFailureReasonResponse": { + "base": "A complex type that contains information about the most recent failure for the specified health check.
", + "refs": { + } + }, + "GetHealthCheckRequest": { + "base": "A complex type that contains information about the request to get a health check.
", + "refs": { + } + }, + "GetHealthCheckResponse": { + "base": "A complex type containing information about the specified health check.
", + "refs": { + } + }, + "GetHealthCheckStatusRequest": { + "base": "A complex type that contains information about the request to get health check status for a health check.
", + "refs": { + } + }, + "GetHealthCheckStatusResponse": { + "base": "A complex type that contains information about the status of the specified health check.
", + "refs": { + } + }, + "GetHostedZoneCountRequest": { + "base": "To retrieve a count of all your hosted zones, send a GET request to the /Route 53 API version/hostedzonecount resource.
A complex type that contains the count of hosted zones associated with the current AWS account.
", + "refs": { + } + }, + "GetHostedZoneRequest": { + "base": "The input for a GetHostedZone request.
", + "refs": { + } + }, + "GetHostedZoneResponse": { + "base": "A complex type containing information about the specified hosted zone.
", + "refs": { + } + }, + "GetReusableDelegationSetRequest": { + "base": "The input for a GetReusableDelegationSet request.
A complex type containing information about the specified reusable delegation set.
", + "refs": { + } + }, + "GetTrafficPolicyInstanceCountRequest": { + "base": "To retrieve a count of all your traffic policy instances, send a GET request to the /Route 53 API version/trafficpolicyinstancecount resource.
A complex type that contains information about the number of traffic policy instances that are associated with the current AWS account.
", + "refs": { + } + }, + "GetTrafficPolicyInstanceRequest": { + "base": "Gets information about a specified traffic policy instance.
To get information about a traffic policy instance, send a GET request to the /Route 53 API version/trafficpolicyinstance/Id resource.
A complex type that contains information about the resource record sets that Amazon Route 53 created based on a specified traffic policy.
", + "refs": { + } + }, + "GetTrafficPolicyRequest": { + "base": "Gets information about a specific traffic policy version. To get the information, send a GET request to the /Route 53 API version/trafficpolicy resource, and specify the ID and the version of the traffic policy.
", + "refs": { + } + }, + "GetTrafficPolicyResponse": { + "base": "A complex type that contains the response information for the request.
", + "refs": { + } + }, + "HealthCheck": { + "base": "A complex type that contains identifying information about the health check.
", + "refs": { + "CreateHealthCheckResponse$HealthCheck": "A complex type that contains identifying information about the health check.
", + "GetHealthCheckResponse$HealthCheck": "A complex type that contains the information about the specified health check.
", + "HealthChecks$member": null, + "UpdateHealthCheckResponse$HealthCheck": null + } + }, + "HealthCheckAlreadyExists": { + "base": "The health check you are trying to create already exists. Amazon Route 53 returns this error when a health check has already been created with the specified CallerReference.
A complex type that contains the health check configuration.
", + "refs": { + "CreateHealthCheckRequest$HealthCheckConfig": "A complex type that contains health check configuration.
", + "HealthCheck$HealthCheckConfig": "A complex type that contains the health check configuration.
" + } + }, + "HealthCheckCount": { + "base": null, + "refs": { + "GetHealthCheckCountResponse$HealthCheckCount": "The number of health checks associated with the current AWS account.
" + } + }, + "HealthCheckId": { + "base": null, + "refs": { + "ChildHealthCheckList$member": null, + "DeleteHealthCheckRequest$HealthCheckId": "The ID of the health check to delete.
", + "GetHealthCheckLastFailureReasonRequest$HealthCheckId": "The ID of the health check for which you want to retrieve the reason for the most recent failure.
", + "GetHealthCheckRequest$HealthCheckId": "The ID of the health check to retrieve.
", + "GetHealthCheckStatusRequest$HealthCheckId": "If you want Amazon Route 53 to return this resource record set in response to a DNS query only when a health check is passing, include the HealthCheckId element and specify the ID of the applicable health check.
Amazon Route 53 determines whether a resource record set is healthy by periodically sending a request to the endpoint that is specified in the health check. If that endpoint returns an HTTP status code of 2xx or 3xx, the endpoint is healthy. If the endpoint returns an HTTP status code of 400 or greater, or if the endpoint doesn't respond for a certain amount of time, Amazon Route 53 considers the endpoint unhealthy and also considers the resource record set unhealthy.
The HealthCheckId element is only useful when Amazon Route 53 is choosing between two or more resource record sets to respond to a DNS query, and you want Amazon Route 53 to base the choice in part on the status of a health check. Configuring health checks only makes sense in the following configurations:
You set EvaluateTargetHealth to true for the resource record sets in an alias, weighted alias, latency alias, geolocation alias, or failover alias resource record set, and you specify health check IDs for all of the resource record sets that are referenced by the alias resource record sets. For more information about this configuration, see EvaluateTargetHealth.
Amazon Route 53 doesn't check the health of the endpoint specified in the resource record set, for example, the endpoint specified by the IP address in the Value element. When you add a HealthCheckId element to a resource record set, Amazon Route 53 checks the health of the endpoint that you specified in the health check.
For geolocation resource record sets, if an endpoint is unhealthy, Amazon Route 53 looks for a resource record set for the larger, associated geographic region. For example, suppose you have resource record sets for a state in the United States, for the United States, for North America, and for all locations. If the endpoint for the state resource record set is unhealthy, Amazon Route 53 checks the resource record sets for the United States, for North America, and for all locations (a resource record set for which the value of CountryCode is *), in that order, until it finds a resource record set for which the endpoint is healthy.
If your health checks specify the endpoint only by domain name, we recommend that you create a separate health check for each endpoint. For example, create a health check for each HTTP server that is serving content for www.example.com. For the value of FullyQualifiedDomainName, specify the domain name of the server (such as us-east-1-www.example.com), not the name of the resource record sets (example.com).
FullyQualifiedDomainName matches the name of the resource record sets and then associate the health check with those resource record sets, health check results will be unpredictable.The ID of the specified health check.
", + "ResourceRecordSet$HealthCheckId": "Health Check resource record sets only, not required for alias resource record sets: An identifier that is used to identify health check associated with the resource record set.
", + "UpdateHealthCheckRequest$HealthCheckId": "The ID of the health check to update.
" + } + }, + "HealthCheckInUse": { + "base": "There are resource records associated with this health check. Before you can delete the health check, you must disassociate it from the resource record sets.
", + "refs": { + } + }, + "HealthCheckNonce": { + "base": null, + "refs": { + "CreateHealthCheckRequest$CallerReference": "A unique string that identifies the request and that allows failed CreateHealthCheck requests to be retried without the risk of executing the operation twice. You must use a unique CallerReference string every time you create a health check. CallerReference can be any unique string; you might choose to use a string that identifies your project.
Valid characters are any Unicode code points that are legal in an XML 1.0 document. The UTF-8 encoding of the value must be less than 128 bytes.
", + "HealthCheck$CallerReference": "A unique string that identifies the request to create the health check.
" + } + }, + "HealthCheckObservation": { + "base": "A complex type that contains the IP address of a Amazon Route 53 health checker and the reason for the health check status.
", + "refs": { + "HealthCheckObservations$member": null + } + }, + "HealthCheckObservations": { + "base": null, + "refs": { + "GetHealthCheckLastFailureReasonResponse$HealthCheckObservations": "A list that contains one HealthCheckObservation element for each Amazon Route 53 health checker.
A list that contains one HealthCheckObservation element for each Amazon Route 53 health checker.
An Amazon EC2 region that you want Amazon Route 53 to use to perform health checks.
", + "refs": { + "HealthCheckObservation$Region": "The HealthCheckRegion of the Amazon Route 53 health checker that performed this health check.
A list of HealthCheckRegion values that you want Amazon Route 53 to use to perform health checks for the specified endpoint. You must specify at least three regions.
A list of HealthCheckRegion values that specify the Amazon EC2 regions that you want Amazon Route 53 to use to perform health checks. You must specify at least three regions.
Specify this value only if you want to change it.
" + } + }, + "HealthCheckType": { + "base": null, + "refs": { + "HealthCheckConfig$Type": "The type of health check to be performed. Currently supported types are TCP, HTTP, HTTPS, HTTP_STR_MATCH, HTTPS_STR_MATCH, CALCULATED and CLOUDWATCH_METRIC.
" + } + }, + "HealthCheckVersion": { + "base": null, + "refs": { + "HealthCheck$HealthCheckVersion": "The version of the health check. You can optionally pass this value in a call to UpdateHealthCheck to prevent overwriting another change to the health check.
Optional. When you specify a health check version, Amazon Route 53 compares this value with the current value in the health check, which prevents you from updating the health check when the versions don't match. Using HealthCheckVersion lets you prevent overwriting another change to the health check.
A complex type that contains information about the health checks associated with the current AWS account.
" + } + }, + "HealthThreshold": { + "base": null, + "refs": { + "HealthCheckConfig$HealthThreshold": "The minimum number of child health checks that must be healthy for Amazon Route 53 to consider the parent health check to be healthy. Valid values are integers between 0 and 256, inclusive.
", + "UpdateHealthCheckRequest$HealthThreshold": "The minimum number of child health checks that must be healthy for Amazon Route 53 to consider the parent health check to be healthy. Valid values are integers between 0 and 256, inclusive.
Specify this value only if you want to change it.
" + } + }, + "HostedZone": { + "base": "A complex type that contain information about the specified hosted zone.
", + "refs": { + "CreateHostedZoneResponse$HostedZone": "A complex type that contains identifying information about the hosted zone.
", + "GetHostedZoneResponse$HostedZone": "A complex type that contains the information about the specified hosted zone.
", + "HostedZones$member": null, + "UpdateHostedZoneCommentResponse$HostedZone": null + } + }, + "HostedZoneAlreadyExists": { + "base": "The hosted zone you are trying to create already exists. Amazon Route 53 returns this error when a hosted zone has already been created with the specified CallerReference.
A complex type that contains an optional comment about your hosted zone. If you don't want to specify a comment, you can omit the HostedZoneConfig and Comment elements from the XML document.
A complex type that contains an optional comment about your hosted zone.
", + "HostedZone$Config": "A complex type that contains the Comment element.
The number of hosted zones associated with the current AWS account.
" + } + }, + "HostedZoneNotEmpty": { + "base": "The hosted zone contains resource record sets in addition to the default NS and SOA resource record sets. Before you can delete the hosted zone, you must delete the additional resource record sets.
", + "refs": { + } + }, + "HostedZoneNotFound": { + "base": "The specified HostedZone cannot be found.
", + "refs": { + } + }, + "HostedZoneRRSetCount": { + "base": null, + "refs": { + "HostedZone$ResourceRecordSetCount": "Total number of resource record sets in the hosted zone.
" + } + }, + "HostedZones": { + "base": null, + "refs": { + "ListHostedZonesByNameResponse$HostedZones": "A complex type that contains information about the hosted zones associated with the current AWS account.
", + "ListHostedZonesResponse$HostedZones": "A complex type that contains information about the hosted zones associated with the current AWS account.
" + } + }, + "IPAddress": { + "base": null, + "refs": { + "HealthCheckConfig$IPAddress": "IP Address of the instance being checked.
", + "HealthCheckObservation$IPAddress": "The IP address of the Amazon Route 53 health checker that performed this health check.
", + "UpdateHealthCheckRequest$IPAddress": "The IP address of the resource that you want to check.
Specify this value only if you want to change it.
" + } + }, + "IPAddressCidr": { + "base": null, + "refs": { + "CheckerIpRanges$member": null + } + }, + "IncompatibleVersion": { + "base": "The resource you are trying to access is unsupported on this Amazon Route 53 endpoint. Please consider using a newer endpoint or a tool that does so.
", + "refs": { + } + }, + "InsufficientDataHealthStatus": { + "base": null, + "refs": { + "HealthCheckConfig$InsufficientDataHealthStatus": "The status of the health check when CloudWatch has insufficient data about the state of associated alarm. Valid values are Healthy, Unhealthy and LastKnownStatus.
At least one of the specified arguments is invalid.
", + "refs": { + } + }, + "InvalidChangeBatch": { + "base": "This error contains a list of one or more error messages. Each error message indicates one error in the change batch.
", + "refs": { + } + }, + "InvalidDomainName": { + "base": "This error indicates that the specified domain name is not valid.
", + "refs": { + } + }, + "InvalidInput": { + "base": "Some value specified in the request is invalid or the XML document is malformed.
", + "refs": { + } + }, + "InvalidTrafficPolicyDocument": { + "base": "The format of the traffic policy document that you specified in the Document element is invalid.
The hosted zone you are trying to create for your VPC_ID does not belong to you. Amazon Route 53 returns this error when the VPC specified by VPCId does not belong to you.
A boolean value that indicates whether the status of health check should be inverted. For example, if a health check is healthy but Inverted is True, then Amazon Route 53 considers the health check to be unhealthy.
A boolean value that indicates whether the status of health check should be inverted. For example, if a health check is healthy but Inverted is True, then Amazon Route 53 considers the health check to be unhealthy.
Specify this value only if you want to change it.
" + } + }, + "IsPrivateZone": { + "base": null, + "refs": { + "HostedZoneConfig$PrivateZone": "GetHostedZone and ListHostedZone responses: A Boolean value that indicates whether a hosted zone is private.
CreateHostedZone requests: When you're creating a private hosted zone (when you specify values for VPCId and VPCRegion), you can optionally specify true for PrivateZone.
The VPC you are trying to disassociate from the hosted zone is the last the VPC that is associated with the hosted zone. Amazon Route 53 currently doesn't support disassociate the last VPC from the hosted zone.
", + "refs": { + } + }, + "LimitsExceeded": { + "base": "The limits specified for a resource have been exceeded.
", + "refs": { + } + }, + "ListChangeBatchesByHostedZoneRequest": { + "base": "The input for a ListChangeBatchesByHostedZone request.
", + "refs": { + } + }, + "ListChangeBatchesByHostedZoneResponse": { + "base": "The input for a ListChangeBatchesByHostedZone request.
", + "refs": { + } + }, + "ListChangeBatchesByRRSetRequest": { + "base": "The input for a ListChangeBatchesByRRSet request.
", + "refs": { + } + }, + "ListChangeBatchesByRRSetResponse": { + "base": "The input for a ListChangeBatchesByRRSet request.
", + "refs": { + } + }, + "ListGeoLocationsRequest": { + "base": "The input for a ListGeoLocations request.
A complex type that contains information about the geo locations that are returned by the request and information about the response.
", + "refs": { + } + }, + "ListHealthChecksRequest": { + "base": "To retrieve a list of your health checks, send a GET request to the /Route 53 API version/healthcheck resource. The response to this request includes a HealthChecks element with zero or more HealthCheck child elements. By default, the list of health checks is displayed on a single page. You can control the length of the page that is displayed by using the MaxItems parameter. You can use the Marker parameter to control the health check that the list begins with.
MaxItems to a value greater than 100, Amazon Route 53 returns only the first 100.A complex type that contains the response for the request.
", + "refs": { + } + }, + "ListHostedZonesByNameRequest": { + "base": "To retrieve a list of your hosted zones in lexicographic order, send a GET request to the /Route 53 API version/hostedzonesbyname resource. The response to this request includes a HostedZones element with zero or more HostedZone child elements lexicographically ordered by DNS name. By default, the list of hosted zones is displayed on a single page. You can control the length of the page that is displayed by using the MaxItems parameter. You can use the DNSName and HostedZoneId parameters to control the hosted zone that the list begins with.
A complex type that contains the response for the request.
", + "refs": { + } + }, + "ListHostedZonesRequest": { + "base": "To retrieve a list of your hosted zones, send a GET request to the /Route 53 API version/hostedzone resource. The response to this request includes a HostedZones element with zero or more HostedZone child elements. By default, the list of hosted zones is displayed on a single page. You can control the length of the page that is displayed by using the MaxItems parameter. You can use the Marker parameter to control the hosted zone that the list begins with.
MaxItems to a value greater than 100, Amazon Route 53 returns only the first 100.A complex type that contains the response for the request.
", + "refs": { + } + }, + "ListResourceRecordSetsRequest": { + "base": "The input for a ListResourceRecordSets request.
", + "refs": { + } + }, + "ListResourceRecordSetsResponse": { + "base": "A complex type that contains information about the resource record sets that are returned by the request and information about the response.
", + "refs": { + } + }, + "ListReusableDelegationSetsRequest": { + "base": "To retrieve a list of your reusable delegation sets, send a GET request to the /Route 53 API version/delegationset resource. The response to this request includes a DelegationSets element with zero or more DelegationSet child elements. By default, the list of reusable delegation sets is displayed on a single page. You can control the length of the page that is displayed by using the MaxItems parameter. You can use the Marker parameter to control the delegation set that the list begins with.
MaxItems to a value greater than 100, Amazon Route 53 returns only the first 100.A complex type that contains the response for the request.
", + "refs": { + } + }, + "ListTagsForResourceRequest": { + "base": "A complex type containing information about a request for a list of the tags that are associated with an individual resource.
", + "refs": { + } + }, + "ListTagsForResourceResponse": { + "base": "A complex type containing tags for the specified resource.
", + "refs": { + } + }, + "ListTagsForResourcesRequest": { + "base": "A complex type containing information about a request for a list of the tags that are associated with up to 10 specified resources.
", + "refs": { + } + }, + "ListTagsForResourcesResponse": { + "base": "A complex type containing tags for the specified resources.
", + "refs": { + } + }, + "ListTrafficPoliciesRequest": { + "base": "A complex type that contains the information about the request to list the traffic policies that are associated with the current AWS account.
", + "refs": { + } + }, + "ListTrafficPoliciesResponse": { + "base": "A complex type that contains the response information for the request.
", + "refs": { + } + }, + "ListTrafficPolicyInstancesByHostedZoneRequest": { + "base": "A request for the traffic policy instances that you created in a specified hosted zone.
", + "refs": { + } + }, + "ListTrafficPolicyInstancesByHostedZoneResponse": { + "base": "A complex type that contains the response information for the request.
", + "refs": { + } + }, + "ListTrafficPolicyInstancesByPolicyRequest": { + "base": "A complex type that contains the information about the request to list your traffic policy instances.
", + "refs": { + } + }, + "ListTrafficPolicyInstancesByPolicyResponse": { + "base": "A complex type that contains the response information for the request.
", + "refs": { + } + }, + "ListTrafficPolicyInstancesRequest": { + "base": "A complex type that contains the information about the request to list your traffic policy instances.
", + "refs": { + } + }, + "ListTrafficPolicyInstancesResponse": { + "base": "A complex type that contains the response information for the request.
", + "refs": { + } + }, + "ListTrafficPolicyVersionsRequest": { + "base": "A complex type that contains the information about the request to list your traffic policies.
", + "refs": { + } + }, + "ListTrafficPolicyVersionsResponse": { + "base": "A complex type that contains the response information for the request.
", + "refs": { + } + }, + "MeasureLatency": { + "base": null, + "refs": { + "HealthCheckConfig$MeasureLatency": "A Boolean value that indicates whether you want Amazon Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint and to display CloudWatch latency graphs in the Amazon Route 53 console.
" + } + }, + "Message": { + "base": null, + "refs": { + "TrafficPolicyInstance$Message": null + } + }, + "MetricName": { + "base": null, + "refs": { + "CloudWatchAlarmConfiguration$MetricName": "The name of the CloudWatch metric that is associated with the CloudWatch alarm.
" + } + }, + "Namespace": { + "base": null, + "refs": { + "CloudWatchAlarmConfiguration$Namespace": "The namespace of the CloudWatch metric that is associated with the CloudWatch alarm.
" + } + }, + "NoSuchChange": { + "base": null, + "refs": { + } + }, + "NoSuchDelegationSet": { + "base": "The specified delegation set does not exist.
", + "refs": { + } + }, + "NoSuchGeoLocation": { + "base": "The geo location you are trying to get does not exist.
", + "refs": { + } + }, + "NoSuchHealthCheck": { + "base": "The health check you are trying to get or delete does not exist.
", + "refs": { + } + }, + "NoSuchHostedZone": { + "base": null, + "refs": { + } + }, + "NoSuchTrafficPolicy": { + "base": "No traffic policy exists with the specified ID.
", + "refs": { + } + }, + "NoSuchTrafficPolicyInstance": { + "base": "No traffic policy instance exists with the specified ID.
", + "refs": { + } + }, + "Nonce": { + "base": null, + "refs": { + "CreateHostedZoneRequest$CallerReference": "A unique string that identifies the request and that allows failed CreateHostedZone requests to be retried without the risk of executing the operation twice. You must use a unique CallerReference string every time you create a hosted zone. CallerReference can be any unique string; you might choose to use a string that identifies your project, such as DNSMigration_01.
Valid characters are any Unicode code points that are legal in an XML 1.0 document. The UTF-8 encoding of the value must be less than 128 bytes.
", + "CreateReusableDelegationSetRequest$CallerReference": "A unique string that identifies the request and that allows failed CreateReusableDelegationSet requests to be retried without the risk of executing the operation twice. You must use a unique CallerReference string every time you create a reusable delegation set. CallerReference can be any unique string; you might choose to use a string that identifies your project, such as DNSMigration_01.
Valid characters are any Unicode code points that are legal in an XML 1.0 document. The UTF-8 encoding of the value must be less than 128 bytes.
", + "DelegationSet$CallerReference": null, + "HostedZone$CallerReference": "A unique string that identifies the request to create the hosted zone.
" + } + }, + "PageMarker": { + "base": null, + "refs": { + "ListChangeBatchesByHostedZoneRequest$Marker": "The page marker.
", + "ListChangeBatchesByHostedZoneResponse$Marker": "The page marker.
", + "ListChangeBatchesByHostedZoneResponse$NextMarker": "The next page marker.
", + "ListChangeBatchesByRRSetRequest$Marker": "The page marker.
", + "ListChangeBatchesByRRSetResponse$Marker": "The page marker.
", + "ListChangeBatchesByRRSetResponse$NextMarker": "The next page marker.
", + "ListHealthChecksRequest$Marker": "If the request returned more than one page of results, submit another request and specify the value of NextMarker from the last response in the marker parameter to get the next page of results.
If the request returned more than one page of results, submit another request and specify the value of NextMarker from the last response in the marker parameter to get the next page of results.
Indicates where to continue listing health checks. If IsTruncated is true, make another request to ListHealthChecks and include the value of the NextMarker element in the Marker element to get the next page of results.
If the request returned more than one page of results, submit another request and specify the value of NextMarker from the last response in the marker parameter to get the next page of results.
If the request returned more than one page of results, submit another request and specify the value of NextMarker from the last response in the marker parameter to get the next page of results.
Indicates where to continue listing hosted zones. If IsTruncated is true, make another request to ListHostedZones and include the value of the NextMarker element in the Marker element to get the next page of results.
If the request returned more than one page of results, submit another request and specify the value of NextMarker from the last response in the marker parameter to get the next page of results.
If the request returned more than one page of results, submit another request and specify the value of NextMarker from the last response in the marker parameter to get the next page of results.
Indicates where to continue listing reusable delegation sets. If IsTruncated is true, make another request to ListReusableDelegationSets and include the value of the NextMarker element in the Marker element of the previous response to get the next page of results.
The maximum number of items on a page.
", + "ListChangeBatchesByHostedZoneResponse$MaxItems": "The maximum number of items on a page.
", + "ListChangeBatchesByRRSetRequest$MaxItems": "The maximum number of items on a page.
", + "ListChangeBatchesByRRSetResponse$MaxItems": "The maximum number of items on a page.
", + "ListGeoLocationsRequest$MaxItems": "The maximum number of geo locations you want in the response body.
", + "ListGeoLocationsResponse$MaxItems": "The maximum number of records you requested. The maximum value of MaxItems is 100.
Specify the maximum number of health checks to return per page of results.
", + "ListHealthChecksResponse$MaxItems": "The maximum number of health checks to be included in the response body. If the number of health checks associated with this AWS account exceeds MaxItems, the value of IsTruncated in the response is true. Call ListHealthChecks again and specify the value of NextMarker from the last response in the Marker element of the next request to get the next page of results.
Specify the maximum number of hosted zones to return per page of results.
", + "ListHostedZonesByNameResponse$MaxItems": "The maximum number of hosted zones to be included in the response body. If the number of hosted zones associated with this AWS account exceeds MaxItems, the value of IsTruncated in the ListHostedZonesByNameResponse is true. Call ListHostedZonesByName again and specify the value of NextDNSName and NextHostedZoneId elements from the previous response to get the next page of results.
Specify the maximum number of hosted zones to return per page of results.
", + "ListHostedZonesResponse$MaxItems": "The maximum number of hosted zones to be included in the response body. If the number of hosted zones associated with this AWS account exceeds MaxItems, the value of IsTruncated in the response is true. Call ListHostedZones again and specify the value of NextMarker in the Marker parameter to get the next page of results.
The maximum number of records you want in the response body.
", + "ListResourceRecordSetsResponse$MaxItems": "The maximum number of records you requested. The maximum value of MaxItems is 100.
Specify the maximum number of reusable delegation sets to return per page of results.
", + "ListReusableDelegationSetsResponse$MaxItems": "The maximum number of reusable delegation sets to be included in the response body. If the number of reusable delegation sets associated with this AWS account exceeds MaxItems, the value of IsTruncated in the response is true. To get the next page of results, call ListReusableDelegationSets again and specify the value of NextMarker from the previous response in the Marker element of the request.
The maximum number of traffic policies to be included in the response body for this request. If you have more than MaxItems traffic policies, the value of the IsTruncated element in the response is true, and the value of the TrafficPolicyIdMarker element is the ID of the first traffic policy in the next group of MaxItems traffic policies.
The value that you specified for the MaxItems parameter in the call to ListTrafficPolicies that produced the current response.
The maximum number of traffic policy instances to be included in the response body for this request. If you have more than MaxItems traffic policy instances, the value of the IsTruncated element in the response is true, and the values of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker represent the first traffic policy instance in the next group of MaxItems traffic policy instances.
The value that you specified for the MaxItems parameter in the call to ListTrafficPolicyInstancesByHostedZone that produced the current response.
The maximum number of traffic policy instances to be included in the response body for this request. If you have more than MaxItems traffic policy instances, the value of the IsTruncated element in the response is true, and the values of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker represent the first traffic policy instance in the next group of MaxItems traffic policy instances.
The value that you specified for the MaxItems parameter in the call to ListTrafficPolicyInstancesByPolicy that produced the current response.
The maximum number of traffic policy instances to be included in the response body for this request. If you have more than MaxItems traffic policy instances, the value of the IsTruncated element in the response is true, and the values of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker represent the first traffic policy instance in the next group of MaxItems traffic policy instances.
The value that you specified for the MaxItems parameter in the call to ListTrafficPolicyInstances that produced the current response.
The maximum number of traffic policy versions that you want Amazon Route 53 to include in the response body for this request. If the specified traffic policy has more than MaxItems versions, the value of the IsTruncated element in the response is true, and the value of the TrafficPolicyVersionMarker element is the ID of the first version in the next group of MaxItems traffic policy versions.
The value that you specified for the maxitems parameter in the call to ListTrafficPolicyVersions that produced the current response.
A flag that indicates if there are more change batches to list.
", + "ListChangeBatchesByRRSetResponse$IsTruncated": "A flag that indicates if there are more change batches to list.
", + "ListGeoLocationsResponse$IsTruncated": "A flag that indicates whether there are more geo locations to be listed. If your results were truncated, you can make a follow-up request for the next page of results by using the values included in the NextContinentCode, NextCountryCode, and NextSubdivisionCode elements.
Valid Values: true | false
A flag indicating whether there are more health checks to be listed. If your results were truncated, you can make a follow-up request for the next page of results by using the Marker element.
Valid Values: true | false
A flag indicating whether there are more hosted zones to be listed. If your results were truncated, you can make a follow-up request for the next page of results by using the NextDNSName and NextHostedZoneId elements.
Valid Values: true | false
A flag indicating whether there are more hosted zones to be listed. If your results were truncated, you can make a follow-up request for the next page of results by using the Marker element.
Valid Values: true | false
A flag that indicates whether there are more resource record sets to be listed. If your results were truncated, you can make a follow-up request for the next page of results by using the NextRecordName element.
Valid Values: true | false
A flag indicating whether there are more reusable delegation sets to be listed. If your results were truncated, you can make a follow-up request for the next page of results by using the Marker element.
Valid Values: true | false
A flag that indicates whether there are more traffic policies to be listed. If the response was truncated, you can get the next group of MaxItems traffic policies by calling ListTrafficPolicies again and specifying the value of the TrafficPolicyIdMarker element in the TrafficPolicyIdMarker request parameter.
Valid Values: true | false
A flag that indicates whether there are more traffic policy instances to be listed. If the response was truncated, you can get the next group of MaxItems traffic policy instances by calling ListTrafficPolicyInstancesByHostedZone again and specifying the values of the HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker elements in the corresponding request parameters.
Valid Values: true | false
A flag that indicates whether there are more traffic policy instances to be listed. If the response was truncated, you can get the next group of MaxItems traffic policy instances by calling ListTrafficPolicyInstancesByPolicy again and specifying the values of the HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker elements in the corresponding request parameters.
Valid Values: true | false
A flag that indicates whether there are more traffic policy instances to be listed. If the response was truncated, you can get the next group of MaxItems traffic policy instances by calling ListTrafficPolicyInstances again and specifying the values of the HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker elements in the corresponding request parameters.
Valid Values: true | false
A flag that indicates whether there are more traffic policies to be listed. If the response was truncated, you can get the next group of maxitems traffic policies by calling ListTrafficPolicyVersions again and specifying the value of the NextMarker element in the marker parameter.
Valid Values: true | false
An integer that represents the period in seconds over which the statistic is applied.
" + } + }, + "Port": { + "base": null, + "refs": { + "HealthCheckConfig$Port": "Port on which connection will be opened to the instance to health check. For HTTP and HTTP_STR_MATCH this defaults to 80 if the port is not specified. For HTTPS and HTTPS_STR_MATCH this defaults to 443 if the port is not specified.
", + "UpdateHealthCheckRequest$Port": "The port on which you want Amazon Route 53 to open a connection to perform health checks.
Specify this value only if you want to change it.
" + } + }, + "PriorRequestNotComplete": { + "base": "The request was rejected because Amazon Route 53 was still processing a prior request.
", + "refs": { + } + }, + "PublicZoneVPCAssociation": { + "base": "The hosted zone you are trying to associate VPC with doesn't have any VPC association. Amazon Route 53 currently doesn't support associate a VPC with a public hosted zone.
", + "refs": { + } + }, + "RData": { + "base": null, + "refs": { + "ResourceRecord$Value": "The current or new DNS record value, not to exceed 4,000 characters. In the case of a DELETE action, if the current value does not match the actual value, an error is returned. For descriptions about how to format Value for different record types, see Supported DNS Resource Record Types in the Amazon Route 53 Developer Guide.
You can specify more than one value for all record types except CNAME and SOA.
The type of the RRSet that you want to see changes for.
", + "ListResourceRecordSetsRequest$StartRecordType": "The DNS type at which to begin the listing of resource record sets.
Valid values: A | AAAA | CNAME | MX | NS | PTR | SOA | SPF | SRV | TXT
Values for Weighted Resource Record Sets: A | AAAA | CNAME | TXT
Values for Regional Resource Record Sets: A | AAAA | CNAME | TXT
Values for Alias Resource Record Sets: A | AAAA
Constraint: Specifying type without specifying name returns an InvalidInput error.
If the results were truncated, the type of the next record in the list. This element is present only if IsTruncated is true.
For the first request to ListTrafficPolicyInstancesByHostedZone, omit this value.
If the value of IsTruncated in the previous response was true, TrafficPolicyInstanceTypeMarker is the DNS type of the first traffic policy instance in the next group of MaxItems traffic policy instances.
If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get for this hosted zone.
If IsTruncated is true, TrafficPolicyInstanceTypeMarker is the DNS type of the resource record sets that are associated with the first traffic policy instance in the next group of MaxItems traffic policy instances.
For the first request to ListTrafficPolicyInstancesByPolicy, omit this value.
If the value of IsTruncated in the previous response was true, TrafficPolicyInstanceTypeMarker is the DNS type of the first traffic policy instance in the next group of MaxItems traffic policy instances.
If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get for this hosted zone.
If IsTruncated is true, TrafficPolicyInstanceTypeMarker is the DNS type of the resource record sets that are associated with the first traffic policy instance in the next group of MaxItems traffic policy instances.
For the first request to ListTrafficPolicyInstances, omit this value.
If the value of IsTruncated in the previous response was true, TrafficPolicyInstanceTypeMarker is the DNS type of the first traffic policy instance in the next group of MaxItems traffic policy instances.
If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.
If IsTruncated is true, TrafficPolicyInstanceTypeMarker is the DNS type of the resource record sets that are associated with the first traffic policy instance in the next group of MaxItems traffic policy instances.
The DNS record type. For information about different record types and how data is encoded for them, see Supported DNS Resource Record Types in the Amazon Route 53 Developer Guide.
Valid values for basic resource record sets: A | AAAA | CNAME | MX | NS | PTR | SOA | SPF | SRV | TXT
Values for weighted, latency, geolocation, and failover resource record sets: A | AAAA | CNAME | MX | PTR | SPF | SRV | TXT. When creating a group of weighted, latency, geolocation, or failover resource record sets, specify the same value for all of the resource record sets in the group.
Type is SPF. RFC 7208, Sender Policy Framework (SPF) for Authorizing Use of Domains in Email, Version 1, has been updated to say, \"...[I]ts existence and mechanism defined in [RFC4408] have led to some interoperability issues. Accordingly, its use is no longer appropriate for SPF version 1; implementations are not to use it.\" In RFC 7208, see section 14.1, The SPF DNS Record Type.Values for alias resource record sets:
AA | AAAANS or SOA.The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next health-check request.
Each Amazon Route 53 health checker makes requests at this interval. Valid values are 10 and 30. The default value is 30.
" + } + }, + "ResourceDescription": { + "base": null, + "refs": { + "ChangeBatch$Comment": "Optional: Any comments you want to include about a change batch request.
", + "ChangeBatchRecord$Comment": "A complex type that describes change information about changes made to your hosted zone.
This element contains an ID that you use when performing a GetChange action to get detailed information about the change.
A complex type that describes change information about changes made to your hosted zone.
This element contains an ID that you use when performing a GetChange action to get detailed information about the change.
An optional comment about your hosted zone. If you don't want to specify a comment, you can omit the HostedZoneConfig and Comment elements from the XML document.
A comment about your hosted zone.
" + } + }, + "ResourceId": { + "base": null, + "refs": { + "AliasTarget$HostedZoneId": "Alias resource record sets only: The value you use depends on where you want to route queries:
Z2FDTNDATAQYW2.HostedZoneId and DNSName. If you get one value from the console and the other value from the API or the CLI, creating the resource record set will fail.The ID of the hosted zone you want to associate your VPC with.
Note that you cannot associate a VPC with a hosted zone that doesn't have an existing VPC association.
", + "ChangeBatchRecord$Id": "The ID of the request. Use this ID to track when the change has completed across all Amazon Route 53 DNS servers.
", + "ChangeInfo$Id": "The ID of the request. Use this ID to track when the change has completed across all Amazon Route 53 DNS servers.
", + "ChangeResourceRecordSetsRequest$HostedZoneId": "The ID of the hosted zone that contains the resource record sets that you want to change.
", + "CreateHostedZoneRequest$DelegationSetId": "The delegation set id of the reusable delgation set whose NS records you want to assign to the new hosted zone.
", + "CreateReusableDelegationSetRequest$HostedZoneId": "The ID of the hosted zone whose delegation set you want to mark as reusable. It is an optional parameter.
", + "CreateTrafficPolicyInstanceRequest$HostedZoneId": "The ID of the hosted zone in which you want Amazon Route 53 to create resource record sets by using the configuration in a traffic policy.
", + "DelegationSet$Id": null, + "DeleteHostedZoneRequest$Id": "The ID of the hosted zone you want to delete.
", + "DeleteReusableDelegationSetRequest$Id": "The ID of the reusable delegation set you want to delete.
", + "DisassociateVPCFromHostedZoneRequest$HostedZoneId": "The ID of the hosted zone you want to disassociate your VPC from.
Note that you cannot disassociate the last VPC from a hosted zone.
", + "GetChangeDetailsRequest$Id": "The ID of the change batch request. The value that you specify here is the value that ChangeResourceRecordSets returned in the Id element when you submitted the request.
The ID of the change batch request. The value that you specify here is the value that ChangeResourceRecordSets returned in the Id element when you submitted the request.
The ID of the hosted zone for which you want to get a list of the name servers in the delegation set.
", + "GetReusableDelegationSetRequest$Id": "The ID of the reusable delegation set for which you want to get a list of the name server.
", + "HostedZone$Id": "The ID of the specified hosted zone.
", + "ListChangeBatchesByHostedZoneRequest$HostedZoneId": "The ID of the hosted zone that you want to see changes for.
", + "ListChangeBatchesByRRSetRequest$HostedZoneId": "The ID of the hosted zone that you want to see changes for.
", + "ListHostedZonesByNameRequest$HostedZoneId": "If the request returned more than one page of results, submit another request and specify the value of NextDNSName and NextHostedZoneId from the last response in the DNSName and HostedZoneId parameters to get the next page of results.
The HostedZoneId value sent in the request.
If the value of IsTruncated in the ListHostedZonesByNameResponse is true, there are more hosted zones associated with the current AWS account. To get the next page of results, make another request to ListHostedZonesByName. Specify the value of NextDNSName in the DNSName parameter. Specify NextHostedZoneId in the HostedZoneId parameter.
The ID of the hosted zone that contains the resource record sets that you want to get.
", + "ListTrafficPolicyInstancesByHostedZoneRequest$HostedZoneId": "The ID of the hosted zone for which you want to list traffic policy instances.
", + "ListTrafficPolicyInstancesByPolicyRequest$HostedZoneIdMarker": "For the first request to ListTrafficPolicyInstancesByPolicy, omit this value.
If the value of IsTruncated in the previous response was true, HostedZoneIdMarker is the ID of the hosted zone for the first traffic policy instance in the next group of MaxItems traffic policy instances.
If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get for this hosted zone.
If the value of IsTruncated in the previous response was false, omit this value.
If IsTruncated is true, HostedZoneIdMarker is the ID of the hosted zone of the first traffic policy instance in the next group of MaxItems traffic policy instances.
For the first request to ListTrafficPolicyInstances, omit this value.
If the value of IsTruncated in the previous response was true, you have more traffic policy instances. To get the next group of MaxItems traffic policy instances, submit another ListTrafficPolicyInstances request. For the value of HostedZoneIdMarker, specify the value of HostedZoneIdMarker from the previous response, which is the hosted zone ID of the first traffic policy instance in the next group of MaxItems traffic policy instances.
If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.
If IsTruncated is true, HostedZoneIdMarker is the ID of the hosted zone of the first traffic policy instance in the next group of MaxItems traffic policy instances.
The ID of the hosted zone you want to update.
" + } + }, + "ResourcePath": { + "base": null, + "refs": { + "HealthCheckConfig$ResourcePath": "Path to ping on the instance to check the health. Required for HTTP, HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH health checks. The HTTP request is issued to the instance on the given port and path.
", + "UpdateHealthCheckRequest$ResourcePath": "The path that you want Amazon Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example the file /docs/route53-health-check.html.
Specify this value only if you want to change it.
" + } + }, + "ResourceRecord": { + "base": "A complex type that contains the value of the Value element for the current resource record set.
A complex type that contains information about the current resource record set.
", + "refs": { + "Change$ResourceRecordSet": "Information about the resource record set to create or delete.
", + "ResourceRecordSets$member": null + } + }, + "ResourceRecordSetFailover": { + "base": null, + "refs": { + "ResourceRecordSet$Failover": "Failover resource record sets only: To configure failover, you add the Failover element to two resource record sets. For one resource record set, you specify PRIMARY as the value for Failover; for the other resource record set, you specify SECONDARY. In addition, you include the HealthCheckId element and specify the health check that you want Amazon Route 53 to perform for each resource record set.
Except where noted, the following failover behaviors assume that you have included the HealthCheckId element in both resource record sets:
HealthCheckId element for the secondary resource record set, and if the primary resource record set is unhealthy, Amazon Route 53 always responds to DNS queries with the applicable value from the secondary resource record set. This is true regardless of the health of the associated endpoint.You cannot create non-failover resource record sets that have the same values for the Name and Type elements as failover resource record sets.
For failover alias resource record sets, you must also include the EvaluateTargetHealth element and set the value to true.
For more information about configuring failover for Amazon Route 53, see Amazon Route 53 Health Checks and DNS Failover in the Amazon Route 53 Developer Guide.
Valid values: PRIMARY | SECONDARY
The identifier of the RRSet that you want to see changes for.
", + "ListResourceRecordSetsRequest$StartRecordIdentifier": "Weighted resource record sets only: If results were truncated for a given DNS name and type, specify the value of NextRecordIdentifier from the previous response to get the next resource record set that has the current DNS name and type.
Weighted resource record sets only: If results were truncated for a given DNS name and type, the value of SetIdentifier for the next resource record set that has the current DNS name and type.
Weighted, Latency, Geo, and Failover resource record sets only: An identifier that differentiates among multiple resource record sets that have the same combination of DNS name and type. The value of SetIdentifier must be unique for each resource record set that has the same combination of DNS name and type.
Latency-based resource record sets only: The Amazon EC2 region where the resource that is specified in this resource record set resides. The resource typically is an AWS resource, such as an Amazon EC2 instance or an ELB load balancer, and is referred to by an IP address or a DNS domain name, depending on the record type.
When Amazon Route 53 receives a DNS query for a domain name and type for which you have created latency resource record sets, Amazon Route 53 selects the latency resource record set that has the lowest latency between the end user and the associated Amazon EC2 region. Amazon Route 53 then returns the value that is associated with the selected resource record set.
Note the following:
ResourceRecord per latency resource record set.Name and Type elements as latency resource record sets.Weighted resource record sets only: Among resource record sets that have the same combination of DNS name and type, a value that determines the proportion of DNS queries that Amazon Route 53 responds to using the current resource record set. Amazon Route 53 calculates the sum of the weights for the resource record sets that have the same combination of DNS name and type. Amazon Route 53 then responds to queries based on the ratio of a resource's weight to the total. Note the following:
Weight element for every weighted resource record set.ResourceRecord per weighted resource record set.Name and Type elements as weighted resource record sets.Name and Type elements.For weighted (but not weighted alias) resource record sets, if you set Weight to 0 for a resource record set, Amazon Route 53 never responds to queries with the applicable value for that resource record set. However, if you set Weight to 0 for all resource record sets that have the same combination of DNS name and type, traffic is routed to all resources with equal probability.
The effect of setting Weight to 0 is different when you associate health checks with weighted resource record sets. For more information, see Options for Configuring Amazon Route 53 Active-Active and Active-Passive Failover in the Amazon Route 53 Developer Guide.
A complex type that contains information about the resource record sets that are returned by the request.
" + } + }, + "ResourceRecords": { + "base": null, + "refs": { + "ResourceRecordSet$ResourceRecords": "A complex type that contains the resource records for the current resource record set.
" + } + }, + "ResourceTagSet": { + "base": "A complex type containing a resource and its associated tags.
", + "refs": { + "ListTagsForResourceResponse$ResourceTagSet": "A ResourceTagSet containing tags associated with the specified resource.
A list of ResourceTagSets containing tags associated with the specified resources.
The unique URL representing the new health check.
", + "CreateHostedZoneResponse$Location": "The unique URL representing the new hosted zone.
", + "CreateReusableDelegationSetResponse$Location": "The unique URL representing the new reusbale delegation set.
", + "CreateTrafficPolicyInstanceResponse$Location": "A unique URL that represents a new traffic policy instance.
", + "CreateTrafficPolicyResponse$Location": null, + "CreateTrafficPolicyVersionResponse$Location": null + } + }, + "SearchString": { + "base": null, + "refs": { + "HealthCheckConfig$SearchString": "A string to search for in the body of a health check response. Required for HTTP_STR_MATCH and HTTPS_STR_MATCH health checks. Amazon Route 53 considers case when searching for SearchString in the response body.
If the value of Type is HTTP_STR_MATCH or HTTP_STR_MATCH, the string that you want Amazon Route 53 to search for in the response body from the specified resource. If the string appears in the response body, Amazon Route 53 considers the resource healthy. Amazon Route 53 considers case when searching for SearchString in the response body.
Specify this value only if you want to change it.
" + } + }, + "Statistic": { + "base": null, + "refs": { + "CloudWatchAlarmConfiguration$Statistic": "The statistic to apply to the CloudWatch metric that is associated with the CloudWatch alarm.
Valid Values are SampleCount, Average, Sum, Minimum and Maximum
The observed health check status.
" + } + }, + "StatusReport": { + "base": "A complex type that contains information about the health check status for the current observation.
", + "refs": { + "HealthCheckObservation$StatusReport": "A complex type that contains information about the health check status for the current observation.
" + } + }, + "TTL": { + "base": null, + "refs": { + "CreateTrafficPolicyInstanceRequest$TTL": "The TTL that you want Amazon Route 53 to assign to all of the resource record sets that it creates in the specified hosted zone.
", + "ResourceRecordSet$TTL": "The cache time to live for the current resource record set. Note the following:
TTL is required. TTL. Amazon Route 53 uses the value of TTL for the alias target. HealthCheckId element), we recommend that you specify a TTL of 60 seconds or less so clients respond quickly to changes in health status.TTL.TTL of 60 seconds for all of the non-alias weighted resource record sets that have the same name and type. Values other than 60 seconds (the TTL for load balancers) will change the effect of the values that you specify for Weight.The TTL that you want Amazon Route 53 to assign to all of the updated resource record sets.
" + } + }, + "Tag": { + "base": "A single tag containing a key and value.
", + "refs": { + "TagList$member": null + } + }, + "TagKey": { + "base": null, + "refs": { + "Tag$Key": "The key for a Tag.
A list of Tag keys that you want to remove from the specified resource.
A complex type that contains a list of Tag elements. Each Tag element identifies a tag that you want to add or update for the specified resource.
The tags associated with the specified resource.
" + } + }, + "TagResourceId": { + "base": null, + "refs": { + "ChangeTagsForResourceRequest$ResourceId": "The ID of the resource for which you want to add, change, or delete tags.
", + "ListTagsForResourceRequest$ResourceId": "The ID of the resource for which you want to retrieve tags.
", + "ResourceTagSet$ResourceId": "The ID for the specified resource.
", + "TagResourceIdList$member": null + } + }, + "TagResourceIdList": { + "base": null, + "refs": { + "ListTagsForResourcesRequest$ResourceIds": "A complex type that contains the ResourceId element for each resource for which you want to get a list of tags.
" + } + }, + "TagResourceType": { + "base": null, + "refs": { + "ChangeTagsForResourceRequest$ResourceType": "The type of the resource.
- The resource type for health checks is healthcheck.
- The resource type for hosted zones is hostedzone.
The type of the resource.
- The resource type for health checks is healthcheck.
- The resource type for hosted zones is hostedzone.
The type of the resources.
- The resource type for health checks is healthcheck.
- The resource type for hosted zones is hostedzone.
The type of the resource.
- The resource type for health checks is healthcheck.
- The resource type for hosted zones is hostedzone.
The value for a Tag.
The value that the metric is compared with to determine the state of the alarm. For example, if you want the health check to fail if the average TCP connection time is greater than 500 milliseconds for more than 60 seconds, the threshold is 500.
" + } + }, + "ThrottlingException": { + "base": null, + "refs": { + } + }, + "TimeStamp": { + "base": null, + "refs": { + "ChangeBatchRecord$SubmittedAt": "The date and time the change was submitted, in the format YYYY-MM-DDThh:mm:ssZ, as specified in the ISO 8601 standard (for example, 2009-11-19T19:37:58Z). The Z after the time indicates that the time is listed in Coordinated Universal Time (UTC).
The date and time the change was submitted, in the format YYYY-MM-DDThh:mm:ssZ, as specified in the ISO 8601 standard (for example, 2009-11-19T19:37:58Z). The Z after the time indicates that the time is listed in Coordinated Universal Time (UTC).
The date and time the health check status was observed, in the format YYYY-MM-DDThh:mm:ssZ, as specified in the ISO 8601 standard (for example, 2009-11-19T19:37:58Z). The Z after the time indicates that the time is listed in Coordinated Universal Time (UTC).
This error indicates that you've reached the maximum number of hosted zones that can be created for the current AWS account. You can request an increase to the limit on the Contact Us page.
", + "refs": { + } + }, + "TooManyTrafficPolicies": { + "base": "You've created the maximum number of traffic policies that can be created for the current AWS account. You can request an increase to the limit on the Contact Us page.
", + "refs": { + } + }, + "TooManyTrafficPolicyInstances": { + "base": "You've created the maximum number of traffic policy instances that can be created for the current AWS account. You can request an increase to the limit on the Contact Us page.
", + "refs": { + } + }, + "TrafficPolicies": { + "base": null, + "refs": { + "ListTrafficPolicyVersionsResponse$TrafficPolicies": "A list that contains one TrafficPolicy element for each traffic policy version that is associated with the specified traffic policy.
A complex type that contains settings for the new traffic policy.
", + "CreateTrafficPolicyVersionResponse$TrafficPolicy": "A complex type that contains settings for the new version of the traffic policy.
", + "GetTrafficPolicyResponse$TrafficPolicy": "A complex type that contains settings for the specified traffic policy.
", + "TrafficPolicies$member": null, + "UpdateTrafficPolicyCommentResponse$TrafficPolicy": "A complex type that contains settings for the specified traffic policy.
" + } + }, + "TrafficPolicyAlreadyExists": { + "base": "A traffic policy that has the same value for Name already exists.
Any comments that you want to include about the traffic policy.
", + "CreateTrafficPolicyVersionRequest$Comment": "Any comments that you want to include about the new traffic policy version.
", + "TrafficPolicy$Comment": null, + "UpdateTrafficPolicyCommentRequest$Comment": "The new comment for the specified traffic policy and version.
" + } + }, + "TrafficPolicyDocument": { + "base": null, + "refs": { + "CreateTrafficPolicyRequest$Document": "The definition of this traffic policy in JSON format. For more information, see Traffic Policy Document Format in the Amazon Route 53 API Reference.
", + "CreateTrafficPolicyVersionRequest$Document": "The definition of a new traffic policy version, in JSON format. You must specify the full definition of the new traffic policy. You cannot specify just the differences between the new version and a previous version. For more information, see Traffic Policy Document Format in the Amazon Route 53 API Reference.
", + "TrafficPolicy$Document": null + } + }, + "TrafficPolicyId": { + "base": null, + "refs": { + "CreateTrafficPolicyInstanceRequest$TrafficPolicyId": "The ID of the traffic policy that you want to use to create resource record sets in the specified hosted zone.
", + "CreateTrafficPolicyVersionRequest$Id": "The ID of the traffic policy for which you want to create a new version.
", + "DeleteTrafficPolicyRequest$Id": "The ID of the traffic policy that you want to delete.
", + "GetTrafficPolicyRequest$Id": "The ID of the traffic policy that you want to get information about.
", + "ListTrafficPoliciesRequest$TrafficPolicyIdMarker": "For your first request to ListTrafficPolicies, do not include the TrafficPolicyIdMarker parameter.
If you have more traffic policies than the value of MaxItems, ListTrafficPolicies returns only the first MaxItems traffic policies. To get the next group of MaxItems policies, submit another request to ListTrafficPolicies. For the value of TrafficPolicyIdMarker, specify the value of the TrafficPolicyIdMarker element that was returned in the previous response.
Policies are listed in the order in which they were created.
", + "ListTrafficPoliciesResponse$TrafficPolicyIdMarker": "If the value of IsTruncated is true, TrafficPolicyIdMarker is the ID of the first traffic policy in the next group of MaxItems traffic policies.
The ID of the traffic policy for which you want to list traffic policy instances.
", + "ListTrafficPolicyVersionsRequest$Id": "Specify the value of Id of the traffic policy for which you want to list all versions.
The value of Id for the traffic policy for which you want to update the comment.
The ID of the traffic policy that you want Amazon Route 53 to use to update resource record sets for the specified traffic policy instance.
" + } + }, + "TrafficPolicyInUse": { + "base": "One or more traffic policy instances were created by using the specified traffic policy.
", + "refs": { + } + }, + "TrafficPolicyInstance": { + "base": null, + "refs": { + "CreateTrafficPolicyInstanceResponse$TrafficPolicyInstance": "A complex type that contains settings for the new traffic policy instance.
", + "GetTrafficPolicyInstanceResponse$TrafficPolicyInstance": "A complex type that contains settings for the traffic policy instance.
", + "TrafficPolicyInstances$member": null, + "UpdateTrafficPolicyInstanceResponse$TrafficPolicyInstance": "A complex type that contains settings for the updated traffic policy instance.
" + } + }, + "TrafficPolicyInstanceAlreadyExists": { + "base": "Traffic policy instance with given Id already exists.
", + "refs": { + } + }, + "TrafficPolicyInstanceCount": { + "base": null, + "refs": { + "GetTrafficPolicyInstanceCountResponse$TrafficPolicyInstanceCount": "The number of traffic policy instances that are associated with the current AWS account.
" + } + }, + "TrafficPolicyInstanceId": { + "base": null, + "refs": { + "DeleteTrafficPolicyInstanceRequest$Id": "The ID of the traffic policy instance that you want to delete.
The ID of the traffic policy instance that you want to get information about.
", + "ResourceRecordSet$TrafficPolicyInstanceId": null, + "TrafficPolicyInstance$Id": null, + "UpdateTrafficPolicyInstanceRequest$Id": "The ID of the traffic policy instance that you want to update.
" + } + }, + "TrafficPolicyInstanceState": { + "base": null, + "refs": { + "TrafficPolicyInstance$State": null + } + }, + "TrafficPolicyInstances": { + "base": null, + "refs": { + "ListTrafficPolicyInstancesByHostedZoneResponse$TrafficPolicyInstances": "A list that contains one TrafficPolicyInstance element for each traffic policy instance that matches the elements in the request.
A list that contains one TrafficPolicyInstance element for each traffic policy instance that matches the elements in the request.
A list that contains one TrafficPolicyInstance element for each traffic policy instance that matches the elements in the request.
The name of the traffic policy.
", + "TrafficPolicy$Name": null, + "TrafficPolicySummary$Name": null + } + }, + "TrafficPolicySummaries": { + "base": null, + "refs": { + "ListTrafficPoliciesResponse$TrafficPolicySummaries": "A list that contains one TrafficPolicySummary element for each traffic policy that was created by the current AWS account.
The version of the traffic policy that you want to use to create resource record sets in the specified hosted zone.
", + "DeleteTrafficPolicyRequest$Version": "The version number of the traffic policy that you want to delete.
", + "GetTrafficPolicyRequest$Version": "The version number of the traffic policy that you want to get information about.
", + "ListTrafficPolicyInstancesByPolicyRequest$TrafficPolicyVersion": "The version of the traffic policy for which you want to list traffic policy instances. The version must be associated with the traffic policy that is specified by TrafficPolicyId.
The value of Version for the traffic policy for which you want to update the comment.
The version of the traffic policy that you want Amazon Route 53 to use to update resource record sets for the specified traffic policy instance.
" + } + }, + "TrafficPolicyVersionMarker": { + "base": null, + "refs": { + "ListTrafficPolicyVersionsRequest$TrafficPolicyVersionMarker": "For your first request to ListTrafficPolicyVersions, do not include the TrafficPolicyVersionMarker parameter.
If you have more traffic policy versions than the value of MaxItems, ListTrafficPolicyVersions returns only the first group of MaxItems versions. To get the next group of MaxItems traffic policy versions, submit another request to ListTrafficPolicyVersions. For the value of TrafficPolicyVersionMarker, specify the value of the TrafficPolicyVersionMarker element that was returned in the previous response.
Traffic policy versions are listed in sequential order.
", + "ListTrafficPolicyVersionsResponse$TrafficPolicyVersionMarker": "If IsTruncated is true, the value of TrafficPolicyVersionMarker identifies the first traffic policy in the next group of MaxItems traffic policies. Call ListTrafficPolicyVersions again and specify the value of TrafficPolicyVersionMarker in the TrafficPolicyVersionMarker request parameter.
This element is present only if IsTruncated is true.
>A complex type that contains information about the request to update a health check.
", + "refs": { + } + }, + "UpdateHealthCheckResponse": { + "base": null, + "refs": { + } + }, + "UpdateHostedZoneCommentRequest": { + "base": "A complex type that contains information about the request to update a hosted zone comment.
", + "refs": { + } + }, + "UpdateHostedZoneCommentResponse": { + "base": "A complex type containing information about the specified hosted zone after the update.
", + "refs": { + } + }, + "UpdateTrafficPolicyCommentRequest": { + "base": "A complex type that contains information about the traffic policy for which you want to update the comment.
", + "refs": { + } + }, + "UpdateTrafficPolicyCommentResponse": { + "base": "A complex type that contains the response information for the traffic policy.
", + "refs": { + } + }, + "UpdateTrafficPolicyInstanceRequest": { + "base": "A complex type that contains information about the resource record sets that you want to update based on a specified traffic policy instance.
", + "refs": { + } + }, + "UpdateTrafficPolicyInstanceResponse": { + "base": "A complex type that contains information about the resource record sets that Amazon Route 53 created based on a specified traffic policy.
", + "refs": { + } + }, + "VPC": { + "base": null, + "refs": { + "AssociateVPCWithHostedZoneRequest$VPC": "The VPC that you want your hosted zone to be associated with.
", + "CreateHostedZoneRequest$VPC": "The VPC that you want your hosted zone to be associated with. By providing this parameter, your newly created hosted cannot be resolved anywhere other than the given VPC.
", + "CreateHostedZoneResponse$VPC": null, + "DisassociateVPCFromHostedZoneRequest$VPC": "The VPC that you want your hosted zone to be disassociated from.
", + "VPCs$member": null + } + }, + "VPCAssociationNotFound": { + "base": "The VPC you specified is not currently associated with the hosted zone.
", + "refs": { + } + }, + "VPCId": { + "base": "A VPC ID
", + "refs": { + "VPC$VPCId": null + } + }, + "VPCRegion": { + "base": null, + "refs": { + "VPC$VPCRegion": null + } + }, + "VPCs": { + "base": "A list of VPCs
", + "refs": { + "GetHostedZoneResponse$VPCs": "A complex type that contains information about VPCs associated with the specified hosted zone.
" + } + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/route53/2013-04-01/examples-1.json b/vendor/github.com/aws/aws-sdk-go/models/apis/route53/2013-04-01/examples-1.json new file mode 100644 index 000000000..0ea7e3b0b --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/route53/2013-04-01/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/route53/2013-04-01/paginators-1.json b/vendor/github.com/aws/aws-sdk-go/models/apis/route53/2013-04-01/paginators-1.json new file mode 100644 index 000000000..d472f47a2 --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/route53/2013-04-01/paginators-1.json @@ -0,0 +1,33 @@ +{ + "pagination": { + "ListHealthChecks": { + "input_token": "Marker", + "output_token": "NextMarker", + "more_results": "IsTruncated", + "limit_key": "MaxItems", + "result_key": "HealthChecks" + }, + "ListHostedZones": { + "input_token": "Marker", + "output_token": "NextMarker", + "more_results": "IsTruncated", + "limit_key": "MaxItems", + "result_key": "HostedZones" + }, + "ListResourceRecordSets": { + "more_results": "IsTruncated", + "limit_key": "MaxItems", + "result_key": "ResourceRecordSets", + "input_token": [ + "StartRecordName", + "StartRecordType", + "StartRecordIdentifier" + ], + "output_token": [ + "NextRecordName", + "NextRecordType", + "NextRecordIdentifier" + ] + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/route53/2013-04-01/waiters-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/route53/2013-04-01/waiters-2.json new file mode 100644 index 000000000..94aad399e --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/route53/2013-04-01/waiters-2.json @@ -0,0 +1,18 @@ +{ + "version": 2, + "waiters": { + "ResourceRecordSetsChanged": { + "delay": 30, + "maxAttempts": 60, + "operation": "GetChange", + "acceptors": [ + { + "matcher": "path", + "expected": "INSYNC", + "argument": "ChangeInfo.Status", + "state": "success" + } + ] + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/route53domains/2014-05-15/api-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/route53domains/2014-05-15/api-2.json new file mode 100644 index 000000000..dc41413ee --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/route53domains/2014-05-15/api-2.json @@ -0,0 +1,1197 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2014-05-15", + "endpointPrefix":"route53domains", + "jsonVersion":"1.1", + "protocol":"json", + "serviceFullName":"Amazon Route 53 Domains", + "signatureVersion":"v4", + "targetPrefix":"Route53Domains_v20140515" + }, + "operations":{ + "CheckDomainAvailability":{ + "name":"CheckDomainAvailability", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CheckDomainAvailabilityRequest"}, + "output":{"shape":"CheckDomainAvailabilityResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"UnsupportedTLD"} + ] + }, + "DeleteTagsForDomain":{ + "name":"DeleteTagsForDomain", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteTagsForDomainRequest"}, + "output":{"shape":"DeleteTagsForDomainResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"OperationLimitExceeded"}, + {"shape":"UnsupportedTLD"} + ] + }, + "DisableDomainAutoRenew":{ + "name":"DisableDomainAutoRenew", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisableDomainAutoRenewRequest"}, + "output":{"shape":"DisableDomainAutoRenewResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"UnsupportedTLD"} + ] + }, + "DisableDomainTransferLock":{ + "name":"DisableDomainTransferLock", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisableDomainTransferLockRequest"}, + "output":{"shape":"DisableDomainTransferLockResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"DuplicateRequest"}, + {"shape":"TLDRulesViolation"}, + {"shape":"OperationLimitExceeded"}, + {"shape":"UnsupportedTLD"} + ] + }, + "EnableDomainAutoRenew":{ + "name":"EnableDomainAutoRenew", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"EnableDomainAutoRenewRequest"}, + "output":{"shape":"EnableDomainAutoRenewResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"UnsupportedTLD"}, + {"shape":"TLDRulesViolation"} + ] + }, + "EnableDomainTransferLock":{ + "name":"EnableDomainTransferLock", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"EnableDomainTransferLockRequest"}, + "output":{"shape":"EnableDomainTransferLockResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"DuplicateRequest"}, + {"shape":"TLDRulesViolation"}, + {"shape":"OperationLimitExceeded"}, + {"shape":"UnsupportedTLD"} + ] + }, + "GetContactReachabilityStatus":{ + "name":"GetContactReachabilityStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetContactReachabilityStatusRequest"}, + "output":{"shape":"GetContactReachabilityStatusResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"OperationLimitExceeded"}, + {"shape":"UnsupportedTLD"} + ] + }, + "GetDomainDetail":{ + "name":"GetDomainDetail", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetDomainDetailRequest"}, + "output":{"shape":"GetDomainDetailResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"UnsupportedTLD"} + ] + }, + "GetOperationDetail":{ + "name":"GetOperationDetail", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetOperationDetailRequest"}, + "output":{"shape":"GetOperationDetailResponse"}, + "errors":[ + {"shape":"InvalidInput"} + ] + }, + "ListDomains":{ + "name":"ListDomains", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListDomainsRequest"}, + "output":{"shape":"ListDomainsResponse"}, + "errors":[ + {"shape":"InvalidInput"} + ] + }, + "ListOperations":{ + "name":"ListOperations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListOperationsRequest"}, + "output":{"shape":"ListOperationsResponse"}, + "errors":[ + {"shape":"InvalidInput"} + ] + }, + "ListTagsForDomain":{ + "name":"ListTagsForDomain", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForDomainRequest"}, + "output":{"shape":"ListTagsForDomainResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"OperationLimitExceeded"}, + {"shape":"UnsupportedTLD"} + ] + }, + "RegisterDomain":{ + "name":"RegisterDomain", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RegisterDomainRequest"}, + "output":{"shape":"RegisterDomainResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"UnsupportedTLD"}, + {"shape":"DuplicateRequest"}, + {"shape":"TLDRulesViolation"}, + {"shape":"DomainLimitExceeded"}, + {"shape":"OperationLimitExceeded"} + ] + }, + "ResendContactReachabilityEmail":{ + "name":"ResendContactReachabilityEmail", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResendContactReachabilityEmailRequest"}, + "output":{"shape":"ResendContactReachabilityEmailResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"OperationLimitExceeded"}, + {"shape":"UnsupportedTLD"} + ] + }, + "RetrieveDomainAuthCode":{ + "name":"RetrieveDomainAuthCode", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RetrieveDomainAuthCodeRequest"}, + "output":{"shape":"RetrieveDomainAuthCodeResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"UnsupportedTLD"} + ] + }, + "TransferDomain":{ + "name":"TransferDomain", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TransferDomainRequest"}, + "output":{"shape":"TransferDomainResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"UnsupportedTLD"}, + {"shape":"DuplicateRequest"}, + {"shape":"TLDRulesViolation"}, + {"shape":"DomainLimitExceeded"}, + {"shape":"OperationLimitExceeded"} + ] + }, + "UpdateDomainContact":{ + "name":"UpdateDomainContact", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateDomainContactRequest"}, + "output":{"shape":"UpdateDomainContactResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"DuplicateRequest"}, + {"shape":"TLDRulesViolation"}, + {"shape":"OperationLimitExceeded"}, + {"shape":"UnsupportedTLD"} + ] + }, + "UpdateDomainContactPrivacy":{ + "name":"UpdateDomainContactPrivacy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateDomainContactPrivacyRequest"}, + "output":{"shape":"UpdateDomainContactPrivacyResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"DuplicateRequest"}, + {"shape":"TLDRulesViolation"}, + {"shape":"OperationLimitExceeded"}, + {"shape":"UnsupportedTLD"} + ] + }, + "UpdateDomainNameservers":{ + "name":"UpdateDomainNameservers", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateDomainNameserversRequest"}, + "output":{"shape":"UpdateDomainNameserversResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"DuplicateRequest"}, + {"shape":"TLDRulesViolation"}, + {"shape":"OperationLimitExceeded"}, + {"shape":"UnsupportedTLD"} + ] + }, + "UpdateTagsForDomain":{ + "name":"UpdateTagsForDomain", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateTagsForDomainRequest"}, + "output":{"shape":"UpdateTagsForDomainResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"OperationLimitExceeded"}, + {"shape":"UnsupportedTLD"} + ] + } + }, + "shapes":{ + "AddressLine":{ + "type":"string", + "max":255 + }, + "Boolean":{"type":"boolean"}, + "CheckDomainAvailabilityRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{"shape":"DomainName"}, + "IdnLangCode":{"shape":"LangCode"} + } + }, + "CheckDomainAvailabilityResponse":{ + "type":"structure", + "required":["Availability"], + "members":{ + "Availability":{"shape":"DomainAvailability"} + } + }, + "City":{ + "type":"string", + "max":255 + }, + "ContactDetail":{ + "type":"structure", + "members":{ + "FirstName":{"shape":"ContactName"}, + "LastName":{"shape":"ContactName"}, + "ContactType":{"shape":"ContactType"}, + "OrganizationName":{"shape":"ContactName"}, + "AddressLine1":{"shape":"AddressLine"}, + "AddressLine2":{"shape":"AddressLine"}, + "City":{"shape":"City"}, + "State":{"shape":"State"}, + "CountryCode":{"shape":"CountryCode"}, + "ZipCode":{"shape":"ZipCode"}, + "PhoneNumber":{"shape":"ContactNumber"}, + "Email":{"shape":"Email"}, + "Fax":{"shape":"ContactNumber"}, + "ExtraParams":{"shape":"ExtraParamList"} + }, + "sensitive":true + }, + "ContactName":{ + "type":"string", + "max":255 + }, + "ContactNumber":{ + "type":"string", + "max":30 + }, + "ContactType":{ + "type":"string", + "enum":[ + "PERSON", + "COMPANY", + "ASSOCIATION", + "PUBLIC_BODY", + "RESELLER" + ] + }, + "CountryCode":{ + "type":"string", + "enum":[ + "AD", + "AE", + "AF", + "AG", + "AI", + "AL", + "AM", + "AN", + "AO", + "AQ", + "AR", + "AS", + "AT", + "AU", + "AW", + "AZ", + "BA", + "BB", + "BD", + "BE", + "BF", + "BG", + "BH", + "BI", + "BJ", + "BL", + "BM", + "BN", + "BO", + "BR", + "BS", + "BT", + "BW", + "BY", + "BZ", + "CA", + "CC", + "CD", + "CF", + "CG", + "CH", + "CI", + "CK", + "CL", + "CM", + "CN", + "CO", + "CR", + "CU", + "CV", + "CX", + "CY", + "CZ", + "DE", + "DJ", + "DK", + "DM", + "DO", + "DZ", + "EC", + "EE", + "EG", + "ER", + "ES", + "ET", + "FI", + "FJ", + "FK", + "FM", + "FO", + "FR", + "GA", + "GB", + "GD", + "GE", + "GH", + "GI", + "GL", + "GM", + "GN", + "GQ", + "GR", + "GT", + "GU", + "GW", + "GY", + "HK", + "HN", + "HR", + "HT", + "HU", + "ID", + "IE", + "IL", + "IM", + "IN", + "IQ", + "IR", + "IS", + "IT", + "JM", + "JO", + "JP", + "KE", + "KG", + "KH", + "KI", + "KM", + "KN", + "KP", + "KR", + "KW", + "KY", + "KZ", + "LA", + "LB", + "LC", + "LI", + "LK", + "LR", + "LS", + "LT", + "LU", + "LV", + "LY", + "MA", + "MC", + "MD", + "ME", + "MF", + "MG", + "MH", + "MK", + "ML", + "MM", + "MN", + "MO", + "MP", + "MR", + "MS", + "MT", + "MU", + "MV", + "MW", + "MX", + "MY", + "MZ", + "NA", + "NC", + "NE", + "NG", + "NI", + "NL", + "NO", + "NP", + "NR", + "NU", + "NZ", + "OM", + "PA", + "PE", + "PF", + "PG", + "PH", + "PK", + "PL", + "PM", + "PN", + "PR", + "PT", + "PW", + "PY", + "QA", + "RO", + "RS", + "RU", + "RW", + "SA", + "SB", + "SC", + "SD", + "SE", + "SG", + "SH", + "SI", + "SK", + "SL", + "SM", + "SN", + "SO", + "SR", + "ST", + "SV", + "SY", + "SZ", + "TC", + "TD", + "TG", + "TH", + "TJ", + "TK", + "TL", + "TM", + "TN", + "TO", + "TR", + "TT", + "TV", + "TW", + "TZ", + "UA", + "UG", + "US", + "UY", + "UZ", + "VA", + "VC", + "VE", + "VG", + "VI", + "VN", + "VU", + "WF", + "WS", + "YE", + "YT", + "ZA", + "ZM", + "ZW" + ] + }, + "DNSSec":{"type":"string"}, + "DeleteTagsForDomainRequest":{ + "type":"structure", + "required":[ + "DomainName", + "TagsToDelete" + ], + "members":{ + "DomainName":{"shape":"DomainName"}, + "TagsToDelete":{"shape":"TagKeyList"} + } + }, + "DeleteTagsForDomainResponse":{ + "type":"structure", + "members":{ + } + }, + "DisableDomainAutoRenewRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{"shape":"DomainName"} + } + }, + "DisableDomainAutoRenewResponse":{ + "type":"structure", + "members":{ + } + }, + "DisableDomainTransferLockRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{"shape":"DomainName"} + } + }, + "DisableDomainTransferLockResponse":{ + "type":"structure", + "required":["OperationId"], + "members":{ + "OperationId":{"shape":"OperationId"} + } + }, + "DomainAuthCode":{ + "type":"string", + "max":1024, + "sensitive":true + }, + "DomainAvailability":{ + "type":"string", + "enum":[ + "AVAILABLE", + "AVAILABLE_RESERVED", + "AVAILABLE_PREORDER", + "UNAVAILABLE", + "UNAVAILABLE_PREMIUM", + "UNAVAILABLE_RESTRICTED", + "RESERVED", + "DONT_KNOW" + ] + }, + "DomainLimitExceeded":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true + }, + "DomainName":{ + "type":"string", + "max":255, + "pattern":"[a-zA-Z0-9_\\-.]*" + }, + "DomainStatus":{"type":"string"}, + "DomainStatusList":{ + "type":"list", + "member":{"shape":"DomainStatus"} + }, + "DomainSummary":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{"shape":"DomainName"}, + "AutoRenew":{"shape":"Boolean"}, + "TransferLock":{"shape":"Boolean"}, + "Expiry":{"shape":"Timestamp"} + } + }, + "DomainSummaryList":{ + "type":"list", + "member":{"shape":"DomainSummary"} + }, + "DuplicateRequest":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true + }, + "DurationInYears":{ + "type":"integer", + "max":10, + "min":1 + }, + "Email":{ + "type":"string", + "max":254 + }, + "EnableDomainAutoRenewRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{"shape":"DomainName"} + } + }, + "EnableDomainAutoRenewResponse":{ + "type":"structure", + "members":{ + } + }, + "EnableDomainTransferLockRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{"shape":"DomainName"} + } + }, + "EnableDomainTransferLockResponse":{ + "type":"structure", + "required":["OperationId"], + "members":{ + "OperationId":{"shape":"OperationId"} + } + }, + "ErrorMessage":{"type":"string"}, + "ExtraParam":{ + "type":"structure", + "required":[ + "Name", + "Value" + ], + "members":{ + "Name":{"shape":"ExtraParamName"}, + "Value":{"shape":"ExtraParamValue"} + } + }, + "ExtraParamList":{ + "type":"list", + "member":{"shape":"ExtraParam"} + }, + "ExtraParamName":{ + "type":"string", + "enum":[ + "DUNS_NUMBER", + "BRAND_NUMBER", + "BIRTH_DEPARTMENT", + "BIRTH_DATE_IN_YYYY_MM_DD", + "BIRTH_COUNTRY", + "BIRTH_CITY", + "DOCUMENT_NUMBER", + "AU_ID_NUMBER", + "AU_ID_TYPE", + "CA_LEGAL_TYPE", + "CA_BUSINESS_ENTITY_TYPE", + "ES_IDENTIFICATION", + "ES_IDENTIFICATION_TYPE", + "ES_LEGAL_FORM", + "FI_BUSINESS_NUMBER", + "FI_ID_NUMBER", + "IT_PIN", + "RU_PASSPORT_DATA", + "SE_ID_NUMBER", + "SG_ID_NUMBER", + "VAT_NUMBER" + ] + }, + "ExtraParamValue":{ + "type":"string", + "max":2048 + }, + "FIAuthKey":{"type":"string"}, + "GetContactReachabilityStatusRequest":{ + "type":"structure", + "members":{ + "domainName":{"shape":"DomainName"} + } + }, + "GetContactReachabilityStatusResponse":{ + "type":"structure", + "members":{ + "domainName":{"shape":"DomainName"}, + "status":{"shape":"ReachabilityStatus"} + } + }, + "GetDomainDetailRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{"shape":"DomainName"} + } + }, + "GetDomainDetailResponse":{ + "type":"structure", + "required":[ + "DomainName", + "Nameservers", + "AdminContact", + "RegistrantContact", + "TechContact" + ], + "members":{ + "DomainName":{"shape":"DomainName"}, + "Nameservers":{"shape":"NameserverList"}, + "AutoRenew":{"shape":"Boolean"}, + "AdminContact":{"shape":"ContactDetail"}, + "RegistrantContact":{"shape":"ContactDetail"}, + "TechContact":{"shape":"ContactDetail"}, + "AdminPrivacy":{"shape":"Boolean"}, + "RegistrantPrivacy":{"shape":"Boolean"}, + "TechPrivacy":{"shape":"Boolean"}, + "RegistrarName":{"shape":"RegistrarName"}, + "WhoIsServer":{"shape":"RegistrarWhoIsServer"}, + "RegistrarUrl":{"shape":"RegistrarUrl"}, + "AbuseContactEmail":{"shape":"Email"}, + "AbuseContactPhone":{"shape":"ContactNumber"}, + "RegistryDomainId":{"shape":"RegistryDomainId"}, + "CreationDate":{"shape":"Timestamp"}, + "UpdatedDate":{"shape":"Timestamp"}, + "ExpirationDate":{"shape":"Timestamp"}, + "Reseller":{"shape":"Reseller"}, + "DnsSec":{"shape":"DNSSec"}, + "StatusList":{"shape":"DomainStatusList"} + } + }, + "GetOperationDetailRequest":{ + "type":"structure", + "required":["OperationId"], + "members":{ + "OperationId":{"shape":"OperationId"} + } + }, + "GetOperationDetailResponse":{ + "type":"structure", + "members":{ + "OperationId":{"shape":"OperationId"}, + "Status":{"shape":"OperationStatus"}, + "Message":{"shape":"ErrorMessage"}, + "DomainName":{"shape":"DomainName"}, + "Type":{"shape":"OperationType"}, + "SubmittedDate":{"shape":"Timestamp"} + } + }, + "GlueIp":{ + "type":"string", + "max":45 + }, + "GlueIpList":{ + "type":"list", + "member":{"shape":"GlueIp"} + }, + "HostName":{ + "type":"string", + "max":255, + "pattern":"[a-zA-Z0-9_\\-.]*" + }, + "InvalidInput":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true + }, + "LangCode":{ + "type":"string", + "max":3 + }, + "ListDomainsRequest":{ + "type":"structure", + "members":{ + "Marker":{"shape":"PageMarker"}, + "MaxItems":{"shape":"PageMaxItems"} + } + }, + "ListDomainsResponse":{ + "type":"structure", + "required":["Domains"], + "members":{ + "Domains":{"shape":"DomainSummaryList"}, + "NextPageMarker":{"shape":"PageMarker"} + } + }, + "ListOperationsRequest":{ + "type":"structure", + "members":{ + "Marker":{"shape":"PageMarker"}, + "MaxItems":{"shape":"PageMaxItems"} + } + }, + "ListOperationsResponse":{ + "type":"structure", + "required":["Operations"], + "members":{ + "Operations":{"shape":"OperationSummaryList"}, + "NextPageMarker":{"shape":"PageMarker"} + } + }, + "ListTagsForDomainRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{"shape":"DomainName"} + } + }, + "ListTagsForDomainResponse":{ + "type":"structure", + "required":["TagList"], + "members":{ + "TagList":{"shape":"TagList"} + } + }, + "Nameserver":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{"shape":"HostName"}, + "GlueIps":{"shape":"GlueIpList"} + } + }, + "NameserverList":{ + "type":"list", + "member":{"shape":"Nameserver"} + }, + "OperationId":{ + "type":"string", + "max":255 + }, + "OperationLimitExceeded":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true + }, + "OperationStatus":{ + "type":"string", + "enum":[ + "SUBMITTED", + "IN_PROGRESS", + "ERROR", + "SUCCESSFUL", + "FAILED" + ] + }, + "OperationSummary":{ + "type":"structure", + "required":[ + "OperationId", + "Status", + "Type", + "SubmittedDate" + ], + "members":{ + "OperationId":{"shape":"OperationId"}, + "Status":{"shape":"OperationStatus"}, + "Type":{"shape":"OperationType"}, + "SubmittedDate":{"shape":"Timestamp"} + } + }, + "OperationSummaryList":{ + "type":"list", + "member":{"shape":"OperationSummary"} + }, + "OperationType":{ + "type":"string", + "enum":[ + "REGISTER_DOMAIN", + "DELETE_DOMAIN", + "TRANSFER_IN_DOMAIN", + "UPDATE_DOMAIN_CONTACT", + "UPDATE_NAMESERVER", + "CHANGE_PRIVACY_PROTECTION", + "DOMAIN_LOCK" + ] + }, + "PageMarker":{ + "type":"string", + "max":4096 + }, + "PageMaxItems":{ + "type":"integer", + "max":100 + }, + "ReachabilityStatus":{ + "type":"string", + "enum":[ + "PENDING", + "DONE", + "EXPIRED" + ] + }, + "RegisterDomainRequest":{ + "type":"structure", + "required":[ + "DomainName", + "DurationInYears", + "AdminContact", + "RegistrantContact", + "TechContact" + ], + "members":{ + "DomainName":{"shape":"DomainName"}, + "IdnLangCode":{"shape":"LangCode"}, + "DurationInYears":{"shape":"DurationInYears"}, + "AutoRenew":{"shape":"Boolean"}, + "AdminContact":{"shape":"ContactDetail"}, + "RegistrantContact":{"shape":"ContactDetail"}, + "TechContact":{"shape":"ContactDetail"}, + "PrivacyProtectAdminContact":{"shape":"Boolean"}, + "PrivacyProtectRegistrantContact":{"shape":"Boolean"}, + "PrivacyProtectTechContact":{"shape":"Boolean"} + } + }, + "RegisterDomainResponse":{ + "type":"structure", + "required":["OperationId"], + "members":{ + "OperationId":{"shape":"OperationId"} + } + }, + "RegistrarName":{"type":"string"}, + "RegistrarUrl":{"type":"string"}, + "RegistrarWhoIsServer":{"type":"string"}, + "RegistryDomainId":{"type":"string"}, + "Reseller":{"type":"string"}, + "ResendContactReachabilityEmailRequest":{ + "type":"structure", + "members":{ + "domainName":{"shape":"DomainName"} + } + }, + "ResendContactReachabilityEmailResponse":{ + "type":"structure", + "members":{ + "domainName":{"shape":"DomainName"}, + "emailAddress":{"shape":"Email"}, + "isAlreadyVerified":{"shape":"Boolean"} + } + }, + "RetrieveDomainAuthCodeRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{"shape":"DomainName"} + } + }, + "RetrieveDomainAuthCodeResponse":{ + "type":"structure", + "required":["AuthCode"], + "members":{ + "AuthCode":{"shape":"DomainAuthCode"} + } + }, + "State":{ + "type":"string", + "max":255 + }, + "TLDRulesViolation":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true + }, + "Tag":{ + "type":"structure", + "members":{ + "Key":{"shape":"TagKey"}, + "Value":{"shape":"TagValue"} + } + }, + "TagKey":{"type":"string"}, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"} + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"} + }, + "TagValue":{"type":"string"}, + "Timestamp":{"type":"timestamp"}, + "TransferDomainRequest":{ + "type":"structure", + "required":[ + "DomainName", + "DurationInYears", + "AdminContact", + "RegistrantContact", + "TechContact" + ], + "members":{ + "DomainName":{"shape":"DomainName"}, + "IdnLangCode":{"shape":"LangCode"}, + "DurationInYears":{"shape":"DurationInYears"}, + "Nameservers":{"shape":"NameserverList"}, + "AuthCode":{"shape":"DomainAuthCode"}, + "AutoRenew":{"shape":"Boolean"}, + "AdminContact":{"shape":"ContactDetail"}, + "RegistrantContact":{"shape":"ContactDetail"}, + "TechContact":{"shape":"ContactDetail"}, + "PrivacyProtectAdminContact":{"shape":"Boolean"}, + "PrivacyProtectRegistrantContact":{"shape":"Boolean"}, + "PrivacyProtectTechContact":{"shape":"Boolean"} + } + }, + "TransferDomainResponse":{ + "type":"structure", + "required":["OperationId"], + "members":{ + "OperationId":{"shape":"OperationId"} + } + }, + "UnsupportedTLD":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true + }, + "UpdateDomainContactPrivacyRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{"shape":"DomainName"}, + "AdminPrivacy":{"shape":"Boolean"}, + "RegistrantPrivacy":{"shape":"Boolean"}, + "TechPrivacy":{"shape":"Boolean"} + } + }, + "UpdateDomainContactPrivacyResponse":{ + "type":"structure", + "required":["OperationId"], + "members":{ + "OperationId":{"shape":"OperationId"} + } + }, + "UpdateDomainContactRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{"shape":"DomainName"}, + "AdminContact":{"shape":"ContactDetail"}, + "RegistrantContact":{"shape":"ContactDetail"}, + "TechContact":{"shape":"ContactDetail"} + } + }, + "UpdateDomainContactResponse":{ + "type":"structure", + "required":["OperationId"], + "members":{ + "OperationId":{"shape":"OperationId"} + } + }, + "UpdateDomainNameserversRequest":{ + "type":"structure", + "required":[ + "DomainName", + "Nameservers" + ], + "members":{ + "DomainName":{"shape":"DomainName"}, + "FIAuthKey":{"shape":"FIAuthKey"}, + "Nameservers":{"shape":"NameserverList"} + } + }, + "UpdateDomainNameserversResponse":{ + "type":"structure", + "required":["OperationId"], + "members":{ + "OperationId":{"shape":"OperationId"} + } + }, + "UpdateTagsForDomainRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{"shape":"DomainName"}, + "TagsToUpdate":{"shape":"TagList"} + } + }, + "UpdateTagsForDomainResponse":{ + "type":"structure", + "members":{ + } + }, + "ZipCode":{ + "type":"string", + "max":255 + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/route53domains/2014-05-15/docs-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/route53domains/2014-05-15/docs-2.json new file mode 100644 index 000000000..2d5206b2e --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/route53domains/2014-05-15/docs-2.json @@ -0,0 +1,654 @@ +{ + "version": "2.0", + "service": null, + "operations": { + "CheckDomainAvailability": "This operation checks the availability of one domain name. Note that if the availability status of a domain is pending, you must submit another request to determine the availability of the domain name.
", + "DeleteTagsForDomain": "This operation deletes the specified tags for a domain.
All tag operations are eventually consistent; subsequent operations may not immediately represent all issued operations.
", + "DisableDomainAutoRenew": "This operation disables automatic renewal of domain registration for the specified domain.
This operation removes the transfer lock on the domain (specifically the clientTransferProhibited status) to allow domain transfers. We recommend you refrain from performing this action unless you intend to transfer the domain to a different registrar. Successful submission returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email.
This operation configures Amazon Route 53 to automatically renew the specified domain before the domain registration expires. The cost of renewing your domain registration is billed to your AWS account.
The period during which you can renew a domain name varies by TLD. For a list of TLDs and their renewal policies, see \"Renewal, restoration, and deletion times\" on the website for our registrar partner, Gandi. Route 53 requires that you renew before the end of the renewal period that is listed on the Gandi website so we can complete processing before the deadline.
", + "EnableDomainTransferLock": "This operation sets the transfer lock on the domain (specifically the clientTransferProhibited status) to prevent domain transfers. Successful submission returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email.
For operations that require confirmation that the email address for the registrant contact is valid, such as registering a new domain, this operation returns information about whether the registrant contact has responded.
If you want us to resend the email, use the ResendContactReachabilityEmail operation.
This operation returns detailed information about the domain. The domain's contact information is also returned as part of the output.
", + "GetOperationDetail": "This operation returns the current status of an operation that is not completed.
", + "ListDomains": "This operation returns all the domain names registered with Amazon Route 53 for the current AWS account.
", + "ListOperations": "This operation returns the operation IDs of operations that are not yet complete.
", + "ListTagsForDomain": "This operation returns all of the tags that are associated with the specified domain.
All tag operations are eventually consistent; subsequent operations may not immediately represent all issued operations.
", + "RegisterDomain": "This operation registers a domain. Domains are registered by the AWS registrar partner, Gandi. For some top-level domains (TLDs), this operation requires extra parameters.
When you register a domain, Amazon Route 53 does the following:
For operations that require confirmation that the email address for the registrant contact is valid, such as registering a new domain, this operation resends the confirmation email to the current email address for the registrant contact.
", + "RetrieveDomainAuthCode": "This operation returns the AuthCode for the domain. To transfer a domain to another registrar, you provide this value to the new registrar.
", + "TransferDomain": "This operation transfers a domain from another registrar to Amazon Route 53. When the transfer is complete, the domain is registered with the AWS registrar partner, Gandi.
For transfer requirements, a detailed procedure, and information about viewing the status of a domain transfer, see Transferring Registration for a Domain to Amazon Route 53 in the Amazon Route 53 Developer Guide.
If the registrar for your domain is also the DNS service provider for the domain, we highly recommend that you consider transferring your DNS service to Amazon Route 53 or to another DNS service provider before you transfer your registration. Some registrars provide free DNS service when you purchase a domain registration. When you transfer the registration, the previous registrar will not renew your domain registration and could end your DNS service at any time.
If the transfer is successful, this method returns an operation ID that you can use to track the progress and completion of the action. If the transfer doesn't complete successfully, the domain registrant will be notified by email.
", + "UpdateDomainContact": "This operation updates the contact information for a particular domain. Information for at least one contact (registrant, administrator, or technical) must be supplied for update.
If the update is successful, this method returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email.
", + "UpdateDomainContactPrivacy": "This operation updates the specified domain contact's privacy setting. When the privacy option is enabled, personal information such as postal or email address is hidden from the results of a public WHOIS query. The privacy services are provided by the AWS registrar, Gandi. For more information, see the Gandi privacy features.
This operation only affects the privacy of the specified contact type (registrant, administrator, or tech). Successful acceptance returns an operation ID that you can use with GetOperationDetail to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email.
", + "UpdateDomainNameservers": "This operation replaces the current set of name servers for the domain with the specified set of name servers. If you use Amazon Route 53 as your DNS service, specify the four name servers in the delegation set for the hosted zone for the domain.
If successful, this operation returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email.
", + "UpdateTagsForDomain": "This operation adds or updates tags for a specified domain.
All tag operations are eventually consistent; subsequent operations may not immediately represent all issued operations.
" + }, + "shapes": { + "AddressLine": { + "base": null, + "refs": { + "ContactDetail$AddressLine1": "First line of the contact's address.
Type: String
Default: None
Constraints: Maximum 255 characters.
Parents: RegistrantContact, AdminContact, TechContact
Required: Yes
", + "ContactDetail$AddressLine2": "Second line of contact's address, if any.
Type: String
Default: None
Constraints: Maximum 255 characters.
Parents: RegistrantContact, AdminContact, TechContact
Required: No
" + } + }, + "Boolean": { + "base": null, + "refs": { + "DomainSummary$AutoRenew": "Indicates whether the domain is automatically renewed upon expiration.
Type: Boolean
Valid values: True | False
Indicates whether a domain is locked from unauthorized transfer to another party.
Type: Boolean
Valid values: True | False
Specifies whether the domain registration is set to renew automatically.
Type: Boolean
", + "GetDomainDetailResponse$AdminPrivacy": "Specifies whether contact information for the admin contact is concealed from WHOIS queries. If the value is true, WHOIS (\"who is\") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.
Type: Boolean
", + "GetDomainDetailResponse$RegistrantPrivacy": "Specifies whether contact information for the registrant contact is concealed from WHOIS queries. If the value is true, WHOIS (\"who is\") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.
Type: Boolean
", + "GetDomainDetailResponse$TechPrivacy": "Specifies whether contact information for the tech contact is concealed from WHOIS queries. If the value is true, WHOIS (\"who is\") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.
Type: Boolean
", + "RegisterDomainRequest$AutoRenew": "Indicates whether the domain will be automatically renewed (true) or not (false). Autorenewal only takes effect after the account is charged.
Type: Boolean
Valid values: true | false
Default: true
Required: No
", + "RegisterDomainRequest$PrivacyProtectAdminContact": "Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (\"who is\") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.
Type: Boolean
Default: true
Valid values: true | false
Required: No
", + "RegisterDomainRequest$PrivacyProtectRegistrantContact": "Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (\"who is\") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.
Type: Boolean
Default: true
Valid values: true | false
Required: No
", + "RegisterDomainRequest$PrivacyProtectTechContact": "Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (\"who is\") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.
Type: Boolean
Default: true
Valid values: true | false
Required: No
", + "ResendContactReachabilityEmailResponse$isAlreadyVerified": "True if the email address for the registrant contact has already been verified, and false otherwise. If the email address has already been verified, we don't send another confirmation email.
", + "TransferDomainRequest$AutoRenew": "Indicates whether the domain will be automatically renewed (true) or not (false). Autorenewal only takes effect after the account is charged.
Type: Boolean
Valid values: true | false
Default: true
Required: No
", + "TransferDomainRequest$PrivacyProtectAdminContact": "Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (\"who is\") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.
Type: Boolean
Default: true
Valid values: true | false
Required: No
", + "TransferDomainRequest$PrivacyProtectRegistrantContact": "Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (\"who is\") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.
Type: Boolean
Default: true
Valid values: true | false
Required: No
", + "TransferDomainRequest$PrivacyProtectTechContact": "Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (\"who is\") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.
Type: Boolean
Default: true
Valid values: true | false
Required: No
", + "UpdateDomainContactPrivacyRequest$AdminPrivacy": "Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (\"who is\") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.
Type: Boolean
Default: None
Valid values: true | false
Required: No
", + "UpdateDomainContactPrivacyRequest$RegistrantPrivacy": "Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (\"who is\") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.
Type: Boolean
Default: None
Valid values: true | false
Required: No
", + "UpdateDomainContactPrivacyRequest$TechPrivacy": "Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (\"who is\") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.
Type: Boolean
Default: None
Valid values: true | false
Required: No
" + } + }, + "CheckDomainAvailabilityRequest": { + "base": "The CheckDomainAvailability request contains the following elements.
", + "refs": { + } + }, + "CheckDomainAvailabilityResponse": { + "base": "The CheckDomainAvailability response includes the following elements.
", + "refs": { + } + }, + "City": { + "base": null, + "refs": { + "ContactDetail$City": "The city of the contact's address.
Type: String
Default: None
Constraints: Maximum 255 characters.
Parents: RegistrantContact, AdminContact, TechContact
Required: Yes
" + } + }, + "ContactDetail": { + "base": "ContactDetail includes the following elements.
", + "refs": { + "GetDomainDetailResponse$AdminContact": "Provides details about the domain administrative contact.
Type: Complex
Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams
Provides details about the domain registrant.
Type: Complex
Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams
Provides details about the domain technical contact.
Type: Complex
Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams
Provides detailed contact information.
Type: Complex
Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams
Required: Yes
", + "RegisterDomainRequest$RegistrantContact": "Provides detailed contact information.
Type: Complex
Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams
Required: Yes
", + "RegisterDomainRequest$TechContact": "Provides detailed contact information.
Type: Complex
Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams
Required: Yes
", + "TransferDomainRequest$AdminContact": "Provides detailed contact information.
Type: Complex
Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams
Required: Yes
", + "TransferDomainRequest$RegistrantContact": "Provides detailed contact information.
Type: Complex
Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams
Required: Yes
", + "TransferDomainRequest$TechContact": "Provides detailed contact information.
Type: Complex
Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams
Required: Yes
", + "UpdateDomainContactRequest$AdminContact": "Provides detailed contact information.
Type: Complex
Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams
Required: Yes
", + "UpdateDomainContactRequest$RegistrantContact": "Provides detailed contact information.
Type: Complex
Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams
Required: Yes
", + "UpdateDomainContactRequest$TechContact": "Provides detailed contact information.
Type: Complex
Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams
Required: Yes
" + } + }, + "ContactName": { + "base": null, + "refs": { + "ContactDetail$FirstName": "First name of contact.
Type: String
Default: None
Constraints: Maximum 255 characters.
Parents: RegistrantContact, AdminContact, TechContact
Required: Yes
", + "ContactDetail$LastName": "Last name of contact.
Type: String
Default: None
Constraints: Maximum 255 characters.
Parents: RegistrantContact, AdminContact, TechContact
Required: Yes
", + "ContactDetail$OrganizationName": "Name of the organization for contact types other than PERSON.
Type: String
Default: None
Constraints: Maximum 255 characters. Contact type must not be PERSON.
Parents: RegistrantContact, AdminContact, TechContact
Required: No
" + } + }, + "ContactNumber": { + "base": null, + "refs": { + "ContactDetail$PhoneNumber": "The phone number of the contact.
Type: String
Default: None
Constraints: Phone number must be specified in the format \"+[country dialing code].[number including any area code>]\". For example, a US phone number might appear as \"+1.1234567890\".
Parents: RegistrantContact, AdminContact, TechContact
Required: Yes
", + "ContactDetail$Fax": "Fax number of the contact.
Type: String
Default: None
Constraints: Phone number must be specified in the format \"+[country dialing code].[number including any area code]\". For example, a US phone number might appear as \"+1.1234567890\".
Parents: RegistrantContact, AdminContact, TechContact
Required: No
", + "GetDomainDetailResponse$AbuseContactPhone": "Phone number for reporting abuse.
Type: String
" + } + }, + "ContactType": { + "base": null, + "refs": { + "ContactDetail$ContactType": "Indicates whether the contact is a person, company, association, or public organization. If you choose an option other than PERSON, you must enter an organization name, and you can't enable privacy protection for the contact.
Type: String
Default: None
Constraints: Maximum 255 characters.
Valid values: PERSON | COMPANY | ASSOCIATION | PUBLIC_BODY
Parents: RegistrantContact, AdminContact, TechContact
Required: Yes
" + } + }, + "CountryCode": { + "base": null, + "refs": { + "ContactDetail$CountryCode": "Code for the country of the contact's address.
Type: String
Default: None
Constraints: Maximum 255 characters.
Parents: RegistrantContact, AdminContact, TechContact
Required: Yes
" + } + }, + "DNSSec": { + "base": null, + "refs": { + "GetDomainDetailResponse$DnsSec": "Reserved for future use.
" + } + }, + "DeleteTagsForDomainRequest": { + "base": "The DeleteTagsForDomainRequest includes the following elements.
", + "refs": { + } + }, + "DeleteTagsForDomainResponse": { + "base": null, + "refs": { + } + }, + "DisableDomainAutoRenewRequest": { + "base": null, + "refs": { + } + }, + "DisableDomainAutoRenewResponse": { + "base": null, + "refs": { + } + }, + "DisableDomainTransferLockRequest": { + "base": "The DisableDomainTransferLock request includes the following element.
", + "refs": { + } + }, + "DisableDomainTransferLockResponse": { + "base": "The DisableDomainTransferLock response includes the following element.
", + "refs": { + } + }, + "DomainAuthCode": { + "base": null, + "refs": { + "RetrieveDomainAuthCodeResponse$AuthCode": "The authorization code for the domain.
Type: String
", + "TransferDomainRequest$AuthCode": "The authorization code for the domain. You get this value from the current registrar.
Type: String
Required: Yes
" + } + }, + "DomainAvailability": { + "base": null, + "refs": { + "CheckDomainAvailabilityResponse$Availability": "Whether the domain name is available for registering.
You can only register domains designated as AVAILABLE.
Type: String
Valid values:
AVAILABLE – The domain name is available.AVAILABLE_RESERVED – The domain name is reserved under specific conditions.AVAILABLE_PREORDER – The domain name is available and can be preordered.UNAVAILABLE – The domain name is not available.UNAVAILABLE_PREMIUM – The domain name is not available.UNAVAILABLE_RESTRICTED – The domain name is forbidden.RESERVED – The domain name has been reserved for another person or organization.DONT_KNOW – The TLD registry didn't reply with a definitive answer about whether the domain name is available. Amazon Route 53 can return this response for a variety of reasons, for example, the registry is performing maintenance. Try again later.The number of domains has exceeded the allowed threshold for the account.
", + "refs": { + } + }, + "DomainName": { + "base": null, + "refs": { + "CheckDomainAvailabilityRequest$DomainName": "The name of a domain.
Type: String
Default: None
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
Required: Yes
", + "DeleteTagsForDomainRequest$DomainName": "The domain for which you want to delete one or more tags.
The name of a domain.
Type: String
Default: None
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Hyphens are allowed only when they're surrounded by letters, numbers, or other hyphens. You can't specify a hyphen at the beginning or end of a label. To specify an Internationalized Domain Name, you must convert the name to Punycode.
Required: Yes
", + "DisableDomainAutoRenewRequest$DomainName": null, + "DisableDomainTransferLockRequest$DomainName": "The name of a domain.
Type: String
Default: None
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
Required: Yes
", + "DomainSummary$DomainName": "The name of a domain.
Type: String
", + "EnableDomainAutoRenewRequest$DomainName": null, + "EnableDomainTransferLockRequest$DomainName": "The name of a domain.
Type: String
Default: None
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
Required: Yes
", + "GetContactReachabilityStatusRequest$domainName": "The name of the domain for which you want to know whether the registrant contact has confirmed that the email address is valid.
Type: String
Default: None
Required: Yes
", + "GetContactReachabilityStatusResponse$domainName": "The domain name for which you requested the reachability status.
", + "GetDomainDetailRequest$DomainName": "The name of a domain.
Type: String
Default: None
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
Required: Yes
", + "GetDomainDetailResponse$DomainName": "The name of a domain.
Type: String
", + "GetOperationDetailResponse$DomainName": "The name of a domain.
Type: String
", + "ListTagsForDomainRequest$DomainName": "The domain for which you want to get a list of tags.
", + "RegisterDomainRequest$DomainName": "The name of a domain.
Type: String
Default: None
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
Required: Yes
", + "ResendContactReachabilityEmailRequest$domainName": "The name of the domain for which you want Amazon Route 53 to resend a confirmation email to the registrant contact.
Type: String
Default: None
Required: Yes
", + "ResendContactReachabilityEmailResponse$domainName": "The domain name for which you requested a confirmation email.
", + "RetrieveDomainAuthCodeRequest$DomainName": "The name of a domain.
Type: String
Default: None
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
Required: Yes
", + "TransferDomainRequest$DomainName": "The name of a domain.
Type: String
Default: None
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
Required: Yes
", + "UpdateDomainContactPrivacyRequest$DomainName": "The name of a domain.
Type: String
Default: None
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
Required: Yes
", + "UpdateDomainContactRequest$DomainName": "The name of a domain.
Type: String
Default: None
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
Required: Yes
", + "UpdateDomainNameserversRequest$DomainName": "The name of a domain.
Type: String
Default: None
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
Required: Yes
", + "UpdateTagsForDomainRequest$DomainName": "The domain for which you want to add or update tags.
The name of a domain.
Type: String
Default: None
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Hyphens are allowed only when they're surrounded by letters, numbers, or other hyphens. You can't specify a hyphen at the beginning or end of a label. To specify an Internationalized Domain Name, you must convert the name to Punycode.
Required: Yes
" + } + }, + "DomainStatus": { + "base": null, + "refs": { + "DomainStatusList$member": null + } + }, + "DomainStatusList": { + "base": null, + "refs": { + "GetDomainDetailResponse$StatusList": "An array of domain name status codes, also known as Extensible Provisioning Protocol (EPP) status codes.
ICANN, the organization that maintains a central database of domain names, has developed a set of domain name status codes that tell you the status of a variety of operations on a domain name, for example, registering a domain name, transferring a domain name to another registrar, renewing the registration for a domain name, and so on. All registrars use this same set of status codes.
For a current list of domain name status codes and an explanation of what each code means, go to the ICANN website and search for epp status codes. (Search on the ICANN website; web searches sometimes return an old version of the document.)
Type: Array of String
" + } + }, + "DomainSummary": { + "base": null, + "refs": { + "DomainSummaryList$member": null + } + }, + "DomainSummaryList": { + "base": null, + "refs": { + "ListDomainsResponse$Domains": "A summary of domains.
Type: Complex type containing a list of domain summaries.
Children: AutoRenew, DomainName, Expiry, TransferLock
The request is already in progress for the domain.
", + "refs": { + } + }, + "DurationInYears": { + "base": null, + "refs": { + "RegisterDomainRequest$DurationInYears": "The number of years the domain will be registered. Domains are registered for a minimum of one year. The maximum period depends on the top-level domain.
Type: Integer
Default: 1
Valid values: Integer from 1 to 10
Required: Yes
", + "TransferDomainRequest$DurationInYears": "The number of years the domain will be registered. Domains are registered for a minimum of one year. The maximum period depends on the top-level domain.
Type: Integer
Default: 1
Valid values: Integer from 1 to 10
Required: Yes
" + } + }, + "Email": { + "base": null, + "refs": { + "ContactDetail$Email": "Email address of the contact.
Type: String
Default: None
Constraints: Maximum 254 characters.
Parents: RegistrantContact, AdminContact, TechContact
Required: Yes
", + "GetDomainDetailResponse$AbuseContactEmail": "Email address to contact to report incorrect contact information for a domain, to report that the domain is being used to send spam, to report that someone is cybersquatting on a domain name, or report some other type of abuse.
Type: String
", + "ResendContactReachabilityEmailResponse$emailAddress": "The email address for the registrant contact at the time that we sent the verification email.
" + } + }, + "EnableDomainAutoRenewRequest": { + "base": null, + "refs": { + } + }, + "EnableDomainAutoRenewResponse": { + "base": null, + "refs": { + } + }, + "EnableDomainTransferLockRequest": { + "base": "The EnableDomainTransferLock request includes the following element.
", + "refs": { + } + }, + "EnableDomainTransferLockResponse": { + "base": "The EnableDomainTransferLock response includes the following elements.
", + "refs": { + } + }, + "ErrorMessage": { + "base": null, + "refs": { + "DomainLimitExceeded$message": null, + "DuplicateRequest$message": null, + "GetOperationDetailResponse$Message": "Detailed information on the status including possible errors.
Type: String
", + "InvalidInput$message": null, + "OperationLimitExceeded$message": null, + "TLDRulesViolation$message": null, + "UnsupportedTLD$message": null + } + }, + "ExtraParam": { + "base": "ExtraParam includes the following elements.
", + "refs": { + "ExtraParamList$member": null + } + }, + "ExtraParamList": { + "base": null, + "refs": { + "ContactDetail$ExtraParams": "A list of name-value pairs for parameters required by certain top-level domains.
Type: Complex
Default: None
Parents: RegistrantContact, AdminContact, TechContact
Children: Name, Value
Required: No
" + } + }, + "ExtraParamName": { + "base": null, + "refs": { + "ExtraParam$Name": "Name of the additional parameter required by the top-level domain.
Type: String
Default: None
Valid values: DUNS_NUMBER | BRAND_NUMBER | BIRTH_DEPARTMENT | BIRTH_DATE_IN_YYYY_MM_DD | BIRTH_COUNTRY | BIRTH_CITY | DOCUMENT_NUMBER | AU_ID_NUMBER | AU_ID_TYPE | CA_LEGAL_TYPE | CA_BUSINESS_ENTITY_TYPE |ES_IDENTIFICATION | ES_IDENTIFICATION_TYPE | ES_LEGAL_FORM | FI_BUSINESS_NUMBER | FI_ID_NUMBER | IT_PIN | RU_PASSPORT_DATA | SE_ID_NUMBER | SG_ID_NUMBER | VAT_NUMBER
Parent: ExtraParams
Required: Yes
" + } + }, + "ExtraParamValue": { + "base": null, + "refs": { + "ExtraParam$Value": "Values corresponding to the additional parameter names required by some top-level domains.
Type: String
Default: None
Constraints: Maximum 2048 characters.
Parent: ExtraParams
Required: Yes
" + } + }, + "FIAuthKey": { + "base": null, + "refs": { + "UpdateDomainNameserversRequest$FIAuthKey": "The authorization key for .fi domains
" + } + }, + "GetContactReachabilityStatusRequest": { + "base": null, + "refs": { + } + }, + "GetContactReachabilityStatusResponse": { + "base": null, + "refs": { + } + }, + "GetDomainDetailRequest": { + "base": "The GetDomainDetail request includes the following element.
", + "refs": { + } + }, + "GetDomainDetailResponse": { + "base": "The GetDomainDetail response includes the following elements.
", + "refs": { + } + }, + "GetOperationDetailRequest": { + "base": "The GetOperationDetail request includes the following element.
", + "refs": { + } + }, + "GetOperationDetailResponse": { + "base": "The GetOperationDetail response includes the following elements.
", + "refs": { + } + }, + "GlueIp": { + "base": null, + "refs": { + "GlueIpList$member": null + } + }, + "GlueIpList": { + "base": null, + "refs": { + "Nameserver$GlueIps": "Glue IP address of a name server entry. Glue IP addresses are required only when the name of the name server is a subdomain of the domain. For example, if your domain is example.com and the name server for the domain is ns.example.com, you need to specify the IP address for ns.example.com.
Type: List of IP addresses.
Constraints: The list can contain only one IPv4 and one IPv6 address.
Parent: Nameservers
The fully qualified host name of the name server.
Type: String
Constraint: Maximum 255 characterss
Parent: Nameservers
The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account.
", + "refs": { + } + }, + "LangCode": { + "base": null, + "refs": { + "CheckDomainAvailabilityRequest$IdnLangCode": "Reserved for future use.
", + "RegisterDomainRequest$IdnLangCode": "Reserved for future use.
", + "TransferDomainRequest$IdnLangCode": "Reserved for future use.
" + } + }, + "ListDomainsRequest": { + "base": "The ListDomains request includes the following elements.
", + "refs": { + } + }, + "ListDomainsResponse": { + "base": "The ListDomains response includes the following elements.
", + "refs": { + } + }, + "ListOperationsRequest": { + "base": "The ListOperations request includes the following elements.
", + "refs": { + } + }, + "ListOperationsResponse": { + "base": "The ListOperations response includes the following elements.
", + "refs": { + } + }, + "ListTagsForDomainRequest": { + "base": "The ListTagsForDomainRequest includes the following elements.
", + "refs": { + } + }, + "ListTagsForDomainResponse": { + "base": "The ListTagsForDomain response includes the following elements.
", + "refs": { + } + }, + "Nameserver": { + "base": "Nameserver includes the following elements.
", + "refs": { + "NameserverList$member": null + } + }, + "NameserverList": { + "base": null, + "refs": { + "GetDomainDetailResponse$Nameservers": "The name of the domain.
Type: String
", + "TransferDomainRequest$Nameservers": "Contains details for the host and glue IP addresses.
Type: Complex
Children: GlueIps, Name
Required: No
", + "UpdateDomainNameserversRequest$Nameservers": "A list of new name servers for the domain.
Type: Complex
Children: Name, GlueIps
Required: Yes
" + } + }, + "OperationId": { + "base": null, + "refs": { + "DisableDomainTransferLockResponse$OperationId": "Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.
Type: String
Default: None
Constraints: Maximum 255 characters.
", + "EnableDomainTransferLockResponse$OperationId": "Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.
Type: String
Default: None
Constraints: Maximum 255 characters.
", + "GetOperationDetailRequest$OperationId": "The identifier for the operation for which you want to get the status. Amazon Route 53 returned the identifier in the response to the original request.
Type: String
Default: None
Required: Yes
", + "GetOperationDetailResponse$OperationId": "The identifier for the operation.
Type: String
", + "OperationSummary$OperationId": "Identifier returned to track the requested action.
Type: String
", + "RegisterDomainResponse$OperationId": "Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.
Type: String
Default: None
Constraints: Maximum 255 characters.
", + "TransferDomainResponse$OperationId": "Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.
Type: String
Default: None
Constraints: Maximum 255 characters.
", + "UpdateDomainContactPrivacyResponse$OperationId": "Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.
Type: String
Default: None
Constraints: Maximum 255 characters.
", + "UpdateDomainContactResponse$OperationId": "Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.
Type: String
Default: None
Constraints: Maximum 255 characters.
", + "UpdateDomainNameserversResponse$OperationId": "Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.
Type: String
Default: None
Constraints: Maximum 255 characters.
" + } + }, + "OperationLimitExceeded": { + "base": "The number of operations or jobs running exceeded the allowed threshold for the account.
", + "refs": { + } + }, + "OperationStatus": { + "base": null, + "refs": { + "GetOperationDetailResponse$Status": "The current status of the requested operation in the system.
Type: String
", + "OperationSummary$Status": "The current status of the requested operation in the system.
Type: String
" + } + }, + "OperationSummary": { + "base": "OperationSummary includes the following elements.
", + "refs": { + "OperationSummaryList$member": null + } + }, + "OperationSummaryList": { + "base": null, + "refs": { + "ListOperationsResponse$Operations": "Lists summaries of the operations.
Type: Complex type containing a list of operation summaries
Children: OperationId, Status, SubmittedDate, Type
The type of operation that was requested.
Type: String
", + "OperationSummary$Type": "Type of the action requested.
Type: String
Valid values: REGISTER_DOMAIN | DELETE_DOMAIN | TRANSFER_IN_DOMAIN | UPDATE_DOMAIN_CONTACT | UPDATE_NAMESERVER | CHANGE_PRIVACY_PROTECTION | DOMAIN_LOCK
For an initial request for a list of domains, omit this element. If the number of domains that are associated with the current AWS account is greater than the value that you specified for MaxItems, you can use Marker to return additional domains. Get the value of NextPageMarker from the previous response, and submit another request that includes the value of NextPageMarker in the Marker element.
Type: String
Default: None
Constraints: The marker must match the value specified in the previous request.
Required: No
", + "ListDomainsResponse$NextPageMarker": "If there are more domains than you specified for MaxItems in the request, submit another request and include the value of NextPageMarker in the value of Marker.
Type: String
Parent: Operations
For an initial request for a list of operations, omit this element. If the number of operations that are not yet complete is greater than the value that you specified for MaxItems, you can use Marker to return additional operations. Get the value of NextPageMarker from the previous response, and submit another request that includes the value of NextPageMarker in the Marker element.
Type: String
Default: None
Required: No
", + "ListOperationsResponse$NextPageMarker": "If there are more operations than you specified for MaxItems in the request, submit another request and include the value of NextPageMarker in the value of Marker.
Type: String
Parent: Operations
Number of domains to be returned.
Type: Integer
Default: 20
Constraints: A numeral between 1 and 100.
Required: No
", + "ListOperationsRequest$MaxItems": "Number of domains to be returned.
Type: Integer
Default: 20
Constraints: A value between 1 and 100.
Required: No
" + } + }, + "ReachabilityStatus": { + "base": null, + "refs": { + "GetContactReachabilityStatusResponse$status": "Whether the registrant contact has responded. PENDING indicates that we sent the confirmation email and haven't received a response yet, DONE indicates that we sent the email and got confirmation from the registrant contact, and EXPIRED indicates that the time limit expired before the registrant contact responded.
Type: String
Valid values: PENDING, DONE, EXPIRED
The RegisterDomain request includes the following elements.
", + "refs": { + } + }, + "RegisterDomainResponse": { + "base": "The RegisterDomain response includes the following element.
", + "refs": { + } + }, + "RegistrarName": { + "base": null, + "refs": { + "GetDomainDetailResponse$RegistrarName": "Name of the registrar of the domain as identified in the registry. Amazon Route 53 domains are registered by registrar Gandi. The value is \"GANDI SAS\".
Type: String
" + } + }, + "RegistrarUrl": { + "base": null, + "refs": { + "GetDomainDetailResponse$RegistrarUrl": "Web address of the registrar.
Type: String
" + } + }, + "RegistrarWhoIsServer": { + "base": null, + "refs": { + "GetDomainDetailResponse$WhoIsServer": "The fully qualified name of the WHOIS server that can answer the WHOIS query for the domain.
Type: String
" + } + }, + "RegistryDomainId": { + "base": null, + "refs": { + "GetDomainDetailResponse$RegistryDomainId": "Reserved for future use.
" + } + }, + "Reseller": { + "base": null, + "refs": { + "GetDomainDetailResponse$Reseller": "Reseller of the domain. Domains registered or transferred using Amazon Route 53 domains will have \"Amazon\" as the reseller.
Type: String
" + } + }, + "ResendContactReachabilityEmailRequest": { + "base": null, + "refs": { + } + }, + "ResendContactReachabilityEmailResponse": { + "base": null, + "refs": { + } + }, + "RetrieveDomainAuthCodeRequest": { + "base": "The RetrieveDomainAuthCode request includes the following element.
", + "refs": { + } + }, + "RetrieveDomainAuthCodeResponse": { + "base": "The RetrieveDomainAuthCode response includes the following element.
", + "refs": { + } + }, + "State": { + "base": null, + "refs": { + "ContactDetail$State": "The state or province of the contact's city.
Type: String
Default: None
Constraints: Maximum 255 characters.
Parents: RegistrantContact, AdminContact, TechContact
Required: No
" + } + }, + "TLDRulesViolation": { + "base": "The top-level domain does not support this operation.
", + "refs": { + } + }, + "Tag": { + "base": "Each tag includes the following elements.
", + "refs": { + "TagList$member": null + } + }, + "TagKey": { + "base": null, + "refs": { + "Tag$Key": "The key (name) of a tag.
Type: String
Default: None
Valid values: A-Z, a-z, 0-9, space, \".:/=+\\-@\"
Constraints: Each key can be 1-128 characters long.
Required: Yes
", + "TagKeyList$member": null + } + }, + "TagKeyList": { + "base": null, + "refs": { + "DeleteTagsForDomainRequest$TagsToDelete": "A list of tag keys to delete.
Type: A list that contains the keys of the tags that you want to delete.
Default: None
Required: No
'>" + } + }, + "TagList": { + "base": null, + "refs": { + "ListTagsForDomainResponse$TagList": "A list of the tags that are associated with the specified domain.
Type: A complex type containing a list of tags
Each tag includes the following elements.
Key
The key (name) of a tag.
Type: String
Value
The value of a tag.
Type: String
A list of the tag keys and values that you want to add or update. If you specify a key that already exists, the corresponding value will be replaced.
Type: A complex type containing a list of tags
Default: None
Required: No
'>Each tag includes the following elements:
Key
The key (name) of a tag.
Type: String
Default: None
Valid values: Unicode characters including alphanumeric, space, and \".:/=+\\-@\"
Constraints: Each key can be 1-128 characters long.
Required: Yes
Value
The value of a tag.
Type: String
Default: None
Valid values: Unicode characters including alphanumeric, space, and \".:/=+\\-@\"
Constraints: Each value can be 0-256 characters long.
Required: Yes
The value of a tag.
Type: String
Default: None
Valid values: A-Z, a-z, 0-9, space, \".:/=+\\-@\"
Constraints: Each value can be 0-256 characters long.
Required: Yes
" + } + }, + "Timestamp": { + "base": null, + "refs": { + "DomainSummary$Expiry": "Expiration date of the domain in Coordinated Universal Time (UTC).
Type: Long
", + "GetDomainDetailResponse$CreationDate": "The date when the domain was created as found in the response to a WHOIS query. The date format is Unix time.
", + "GetDomainDetailResponse$UpdatedDate": "The last updated date of the domain as found in the response to a WHOIS query. The date format is Unix time.
", + "GetDomainDetailResponse$ExpirationDate": "The date when the registration for the domain is set to expire. The date format is Unix time.
", + "GetOperationDetailResponse$SubmittedDate": "The date when the request was submitted.
", + "OperationSummary$SubmittedDate": "The date when the request was submitted.
" + } + }, + "TransferDomainRequest": { + "base": "The TransferDomain request includes the following elements.
", + "refs": { + } + }, + "TransferDomainResponse": { + "base": "The TranserDomain response includes the following element.
", + "refs": { + } + }, + "UnsupportedTLD": { + "base": "Amazon Route 53 does not support this top-level domain.
", + "refs": { + } + }, + "UpdateDomainContactPrivacyRequest": { + "base": "The UpdateDomainContactPrivacy request includes the following elements.
", + "refs": { + } + }, + "UpdateDomainContactPrivacyResponse": { + "base": "The UpdateDomainContactPrivacy response includes the following element.
", + "refs": { + } + }, + "UpdateDomainContactRequest": { + "base": "The UpdateDomainContact request includes the following elements.
", + "refs": { + } + }, + "UpdateDomainContactResponse": { + "base": "The UpdateDomainContact response includes the following element.
", + "refs": { + } + }, + "UpdateDomainNameserversRequest": { + "base": "The UpdateDomainNameserver request includes the following elements.
", + "refs": { + } + }, + "UpdateDomainNameserversResponse": { + "base": "The UpdateDomainNameservers response includes the following element.
", + "refs": { + } + }, + "UpdateTagsForDomainRequest": { + "base": "The UpdateTagsForDomainRequest includes the following elements.
", + "refs": { + } + }, + "UpdateTagsForDomainResponse": { + "base": null, + "refs": { + } + }, + "ZipCode": { + "base": null, + "refs": { + "ContactDetail$ZipCode": "The zip or postal code of the contact's address.
Type: String
Default: None
Constraints: Maximum 255 characters.
Parents: RegistrantContact, AdminContact, TechContact
Required: No
" + } + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/route53domains/2014-05-15/examples-1.json b/vendor/github.com/aws/aws-sdk-go/models/apis/route53domains/2014-05-15/examples-1.json new file mode 100644 index 000000000..0ea7e3b0b --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/route53domains/2014-05-15/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/route53domains/2014-05-15/paginators-1.json b/vendor/github.com/aws/aws-sdk-go/models/apis/route53domains/2014-05-15/paginators-1.json new file mode 100644 index 000000000..8d1a73ab2 --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/route53domains/2014-05-15/paginators-1.json @@ -0,0 +1,17 @@ +{ + "version": "1.0", + "pagination": { + "ListDomains": { + "limit_key": "MaxItems", + "input_token": "Marker", + "output_token": "NextPageMarker", + "result_key": "Domains" + }, + "ListOperations": { + "limit_key": "MaxItems", + "input_token": "Marker", + "output_token": "NextPageMarker", + "result_key": "Operations" + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/s3/2006-03-01/api-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/s3/2006-03-01/api-2.json new file mode 100644 index 000000000..310dd8c57 --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/s3/2006-03-01/api-2.json @@ -0,0 +1,4517 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2006-03-01", + "checksumFormat":"md5", + "endpointPrefix":"s3", + "globalEndpoint":"s3.amazonaws.com", + "protocol":"rest-xml", + "serviceAbbreviation":"Amazon S3", + "serviceFullName":"Amazon Simple Storage Service", + "signatureVersion":"s3", + "timestampFormat":"rfc822" + }, + "operations":{ + "AbortMultipartUpload":{ + "name":"AbortMultipartUpload", + "http":{ + "method":"DELETE", + "requestUri":"/{Bucket}/{Key+}" + }, + "input":{"shape":"AbortMultipartUploadRequest"}, + "output":{"shape":"AbortMultipartUploadOutput"}, + "errors":[ + {"shape":"NoSuchUpload"} + ], + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadAbort.html" + }, + "CompleteMultipartUpload":{ + "name":"CompleteMultipartUpload", + "http":{ + "method":"POST", + "requestUri":"/{Bucket}/{Key+}" + }, + "input":{"shape":"CompleteMultipartUploadRequest"}, + "output":{"shape":"CompleteMultipartUploadOutput"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadComplete.html" + }, + "CopyObject":{ + "name":"CopyObject", + "http":{ + "method":"PUT", + "requestUri":"/{Bucket}/{Key+}" + }, + "input":{"shape":"CopyObjectRequest"}, + "output":{"shape":"CopyObjectOutput"}, + "errors":[ + {"shape":"ObjectNotInActiveTierError"} + ], + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectCOPY.html", + "alias":"PutObjectCopy" + }, + "CreateBucket":{ + "name":"CreateBucket", + "http":{ + "method":"PUT", + "requestUri":"/{Bucket}" + }, + "input":{"shape":"CreateBucketRequest"}, + "output":{"shape":"CreateBucketOutput"}, + "errors":[ + {"shape":"BucketAlreadyExists"}, + {"shape":"BucketAlreadyOwnedByYou"} + ], + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUT.html", + "alias":"PutBucket" + }, + "CreateMultipartUpload":{ + "name":"CreateMultipartUpload", + "http":{ + "method":"POST", + "requestUri":"/{Bucket}/{Key+}?uploads" + }, + "input":{"shape":"CreateMultipartUploadRequest"}, + "output":{"shape":"CreateMultipartUploadOutput"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadInitiate.html", + "alias":"InitiateMultipartUpload" + }, + "DeleteBucket":{ + "name":"DeleteBucket", + "http":{ + "method":"DELETE", + "requestUri":"/{Bucket}" + }, + "input":{"shape":"DeleteBucketRequest"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETE.html" + }, + "DeleteBucketCors":{ + "name":"DeleteBucketCors", + "http":{ + "method":"DELETE", + "requestUri":"/{Bucket}?cors" + }, + "input":{"shape":"DeleteBucketCorsRequest"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETEcors.html" + }, + "DeleteBucketLifecycle":{ + "name":"DeleteBucketLifecycle", + "http":{ + "method":"DELETE", + "requestUri":"/{Bucket}?lifecycle" + }, + "input":{"shape":"DeleteBucketLifecycleRequest"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETElifecycle.html" + }, + "DeleteBucketPolicy":{ + "name":"DeleteBucketPolicy", + "http":{ + "method":"DELETE", + "requestUri":"/{Bucket}?policy" + }, + "input":{"shape":"DeleteBucketPolicyRequest"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETEpolicy.html" + }, + "DeleteBucketReplication":{ + "name":"DeleteBucketReplication", + "http":{ + "method":"DELETE", + "requestUri":"/{Bucket}?replication" + }, + "input":{"shape":"DeleteBucketReplicationRequest"} + }, + "DeleteBucketTagging":{ + "name":"DeleteBucketTagging", + "http":{ + "method":"DELETE", + "requestUri":"/{Bucket}?tagging" + }, + "input":{"shape":"DeleteBucketTaggingRequest"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETEtagging.html" + }, + "DeleteBucketWebsite":{ + "name":"DeleteBucketWebsite", + "http":{ + "method":"DELETE", + "requestUri":"/{Bucket}?website" + }, + "input":{"shape":"DeleteBucketWebsiteRequest"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETEwebsite.html" + }, + "DeleteObject":{ + "name":"DeleteObject", + "http":{ + "method":"DELETE", + "requestUri":"/{Bucket}/{Key+}" + }, + "input":{"shape":"DeleteObjectRequest"}, + "output":{"shape":"DeleteObjectOutput"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectDELETE.html" + }, + "DeleteObjects":{ + "name":"DeleteObjects", + "http":{ + "method":"POST", + "requestUri":"/{Bucket}?delete" + }, + "input":{"shape":"DeleteObjectsRequest"}, + "output":{"shape":"DeleteObjectsOutput"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/multiobjectdeleteapi.html", + "alias":"DeleteMultipleObjects" + }, + "GetBucketAccelerateConfiguration":{ + "name":"GetBucketAccelerateConfiguration", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}?accelerate" + }, + "input":{"shape":"GetBucketAccelerateConfigurationRequest"}, + "output":{"shape":"GetBucketAccelerateConfigurationOutput"} + }, + "GetBucketAcl":{ + "name":"GetBucketAcl", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}?acl" + }, + "input":{"shape":"GetBucketAclRequest"}, + "output":{"shape":"GetBucketAclOutput"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETacl.html" + }, + "GetBucketCors":{ + "name":"GetBucketCors", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}?cors" + }, + "input":{"shape":"GetBucketCorsRequest"}, + "output":{"shape":"GetBucketCorsOutput"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETcors.html" + }, + "GetBucketLifecycle":{ + "name":"GetBucketLifecycle", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}?lifecycle" + }, + "input":{"shape":"GetBucketLifecycleRequest"}, + "output":{"shape":"GetBucketLifecycleOutput"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETlifecycle.html", + "deprecated":true + }, + "GetBucketLifecycleConfiguration":{ + "name":"GetBucketLifecycleConfiguration", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}?lifecycle" + }, + "input":{"shape":"GetBucketLifecycleConfigurationRequest"}, + "output":{"shape":"GetBucketLifecycleConfigurationOutput"} + }, + "GetBucketLocation":{ + "name":"GetBucketLocation", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}?location" + }, + "input":{"shape":"GetBucketLocationRequest"}, + "output":{"shape":"GetBucketLocationOutput"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETlocation.html" + }, + "GetBucketLogging":{ + "name":"GetBucketLogging", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}?logging" + }, + "input":{"shape":"GetBucketLoggingRequest"}, + "output":{"shape":"GetBucketLoggingOutput"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETlogging.html" + }, + "GetBucketNotification":{ + "name":"GetBucketNotification", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}?notification" + }, + "input":{"shape":"GetBucketNotificationConfigurationRequest"}, + "output":{"shape":"NotificationConfigurationDeprecated"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETnotification.html", + "deprecated":true + }, + "GetBucketNotificationConfiguration":{ + "name":"GetBucketNotificationConfiguration", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}?notification" + }, + "input":{"shape":"GetBucketNotificationConfigurationRequest"}, + "output":{"shape":"NotificationConfiguration"} + }, + "GetBucketPolicy":{ + "name":"GetBucketPolicy", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}?policy" + }, + "input":{"shape":"GetBucketPolicyRequest"}, + "output":{"shape":"GetBucketPolicyOutput"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETpolicy.html" + }, + "GetBucketReplication":{ + "name":"GetBucketReplication", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}?replication" + }, + "input":{"shape":"GetBucketReplicationRequest"}, + "output":{"shape":"GetBucketReplicationOutput"} + }, + "GetBucketRequestPayment":{ + "name":"GetBucketRequestPayment", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}?requestPayment" + }, + "input":{"shape":"GetBucketRequestPaymentRequest"}, + "output":{"shape":"GetBucketRequestPaymentOutput"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTrequestPaymentGET.html" + }, + "GetBucketTagging":{ + "name":"GetBucketTagging", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}?tagging" + }, + "input":{"shape":"GetBucketTaggingRequest"}, + "output":{"shape":"GetBucketTaggingOutput"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETtagging.html" + }, + "GetBucketVersioning":{ + "name":"GetBucketVersioning", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}?versioning" + }, + "input":{"shape":"GetBucketVersioningRequest"}, + "output":{"shape":"GetBucketVersioningOutput"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETversioningStatus.html" + }, + "GetBucketWebsite":{ + "name":"GetBucketWebsite", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}?website" + }, + "input":{"shape":"GetBucketWebsiteRequest"}, + "output":{"shape":"GetBucketWebsiteOutput"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETwebsite.html" + }, + "GetObject":{ + "name":"GetObject", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}/{Key+}" + }, + "input":{"shape":"GetObjectRequest"}, + "output":{"shape":"GetObjectOutput"}, + "errors":[ + {"shape":"NoSuchKey"} + ], + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectGET.html" + }, + "GetObjectAcl":{ + "name":"GetObjectAcl", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}/{Key+}?acl" + }, + "input":{"shape":"GetObjectAclRequest"}, + "output":{"shape":"GetObjectAclOutput"}, + "errors":[ + {"shape":"NoSuchKey"} + ], + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectGETacl.html" + }, + "GetObjectTorrent":{ + "name":"GetObjectTorrent", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}/{Key+}?torrent" + }, + "input":{"shape":"GetObjectTorrentRequest"}, + "output":{"shape":"GetObjectTorrentOutput"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectGETtorrent.html" + }, + "HeadBucket":{ + "name":"HeadBucket", + "http":{ + "method":"HEAD", + "requestUri":"/{Bucket}" + }, + "input":{"shape":"HeadBucketRequest"}, + "errors":[ + {"shape":"NoSuchBucket"} + ], + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketHEAD.html" + }, + "HeadObject":{ + "name":"HeadObject", + "http":{ + "method":"HEAD", + "requestUri":"/{Bucket}/{Key+}" + }, + "input":{"shape":"HeadObjectRequest"}, + "output":{"shape":"HeadObjectOutput"}, + "errors":[ + {"shape":"NoSuchKey"} + ], + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectHEAD.html" + }, + "ListBuckets":{ + "name":"ListBuckets", + "http":{ + "method":"GET", + "requestUri":"/" + }, + "output":{"shape":"ListBucketsOutput"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTServiceGET.html", + "alias":"GetService" + }, + "ListMultipartUploads":{ + "name":"ListMultipartUploads", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}?uploads" + }, + "input":{"shape":"ListMultipartUploadsRequest"}, + "output":{"shape":"ListMultipartUploadsOutput"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadListMPUpload.html" + }, + "ListObjectVersions":{ + "name":"ListObjectVersions", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}?versions" + }, + "input":{"shape":"ListObjectVersionsRequest"}, + "output":{"shape":"ListObjectVersionsOutput"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETVersion.html", + "alias":"GetBucketObjectVersions" + }, + "ListObjects":{ + "name":"ListObjects", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}" + }, + "input":{"shape":"ListObjectsRequest"}, + "output":{"shape":"ListObjectsOutput"}, + "errors":[ + {"shape":"NoSuchBucket"} + ], + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGET.html", + "alias":"GetBucket" + }, + "ListObjectsV2":{ + "name":"ListObjectsV2", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}?list-type=2" + }, + "input":{"shape":"ListObjectsV2Request"}, + "output":{"shape":"ListObjectsV2Output"}, + "errors":[ + {"shape":"NoSuchBucket"} + ] + }, + "ListParts":{ + "name":"ListParts", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}/{Key+}" + }, + "input":{"shape":"ListPartsRequest"}, + "output":{"shape":"ListPartsOutput"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadListParts.html" + }, + "PutBucketAccelerateConfiguration":{ + "name":"PutBucketAccelerateConfiguration", + "http":{ + "method":"PUT", + "requestUri":"/{Bucket}?accelerate" + }, + "input":{"shape":"PutBucketAccelerateConfigurationRequest"} + }, + "PutBucketAcl":{ + "name":"PutBucketAcl", + "http":{ + "method":"PUT", + "requestUri":"/{Bucket}?acl" + }, + "input":{"shape":"PutBucketAclRequest"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTacl.html" + }, + "PutBucketCors":{ + "name":"PutBucketCors", + "http":{ + "method":"PUT", + "requestUri":"/{Bucket}?cors" + }, + "input":{"shape":"PutBucketCorsRequest"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTcors.html" + }, + "PutBucketLifecycle":{ + "name":"PutBucketLifecycle", + "http":{ + "method":"PUT", + "requestUri":"/{Bucket}?lifecycle" + }, + "input":{"shape":"PutBucketLifecycleRequest"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTlifecycle.html", + "deprecated":true + }, + "PutBucketLifecycleConfiguration":{ + "name":"PutBucketLifecycleConfiguration", + "http":{ + "method":"PUT", + "requestUri":"/{Bucket}?lifecycle" + }, + "input":{"shape":"PutBucketLifecycleConfigurationRequest"} + }, + "PutBucketLogging":{ + "name":"PutBucketLogging", + "http":{ + "method":"PUT", + "requestUri":"/{Bucket}?logging" + }, + "input":{"shape":"PutBucketLoggingRequest"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTlogging.html" + }, + "PutBucketNotification":{ + "name":"PutBucketNotification", + "http":{ + "method":"PUT", + "requestUri":"/{Bucket}?notification" + }, + "input":{"shape":"PutBucketNotificationRequest"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTnotification.html", + "deprecated":true + }, + "PutBucketNotificationConfiguration":{ + "name":"PutBucketNotificationConfiguration", + "http":{ + "method":"PUT", + "requestUri":"/{Bucket}?notification" + }, + "input":{"shape":"PutBucketNotificationConfigurationRequest"} + }, + "PutBucketPolicy":{ + "name":"PutBucketPolicy", + "http":{ + "method":"PUT", + "requestUri":"/{Bucket}?policy" + }, + "input":{"shape":"PutBucketPolicyRequest"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTpolicy.html" + }, + "PutBucketReplication":{ + "name":"PutBucketReplication", + "http":{ + "method":"PUT", + "requestUri":"/{Bucket}?replication" + }, + "input":{"shape":"PutBucketReplicationRequest"} + }, + "PutBucketRequestPayment":{ + "name":"PutBucketRequestPayment", + "http":{ + "method":"PUT", + "requestUri":"/{Bucket}?requestPayment" + }, + "input":{"shape":"PutBucketRequestPaymentRequest"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTrequestPaymentPUT.html" + }, + "PutBucketTagging":{ + "name":"PutBucketTagging", + "http":{ + "method":"PUT", + "requestUri":"/{Bucket}?tagging" + }, + "input":{"shape":"PutBucketTaggingRequest"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTtagging.html" + }, + "PutBucketVersioning":{ + "name":"PutBucketVersioning", + "http":{ + "method":"PUT", + "requestUri":"/{Bucket}?versioning" + }, + "input":{"shape":"PutBucketVersioningRequest"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTVersioningStatus.html" + }, + "PutBucketWebsite":{ + "name":"PutBucketWebsite", + "http":{ + "method":"PUT", + "requestUri":"/{Bucket}?website" + }, + "input":{"shape":"PutBucketWebsiteRequest"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTwebsite.html" + }, + "PutObject":{ + "name":"PutObject", + "http":{ + "method":"PUT", + "requestUri":"/{Bucket}/{Key+}" + }, + "input":{"shape":"PutObjectRequest"}, + "output":{"shape":"PutObjectOutput"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectPUT.html" + }, + "PutObjectAcl":{ + "name":"PutObjectAcl", + "http":{ + "method":"PUT", + "requestUri":"/{Bucket}/{Key+}?acl" + }, + "input":{"shape":"PutObjectAclRequest"}, + "output":{"shape":"PutObjectAclOutput"}, + "errors":[ + {"shape":"NoSuchKey"} + ], + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectPUTacl.html" + }, + "RestoreObject":{ + "name":"RestoreObject", + "http":{ + "method":"POST", + "requestUri":"/{Bucket}/{Key+}?restore" + }, + "input":{"shape":"RestoreObjectRequest"}, + "output":{"shape":"RestoreObjectOutput"}, + "errors":[ + {"shape":"ObjectAlreadyInActiveTierError"} + ], + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectRestore.html", + "alias":"PostObjectRestore" + }, + "UploadPart":{ + "name":"UploadPart", + "http":{ + "method":"PUT", + "requestUri":"/{Bucket}/{Key+}" + }, + "input":{"shape":"UploadPartRequest"}, + "output":{"shape":"UploadPartOutput"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadUploadPart.html" + }, + "UploadPartCopy":{ + "name":"UploadPartCopy", + "http":{ + "method":"PUT", + "requestUri":"/{Bucket}/{Key+}" + }, + "input":{"shape":"UploadPartCopyRequest"}, + "output":{"shape":"UploadPartCopyOutput"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadUploadPartCopy.html" + } + }, + "shapes":{ + "AbortDate":{"type":"timestamp"}, + "AbortIncompleteMultipartUpload":{ + "type":"structure", + "members":{ + "DaysAfterInitiation":{"shape":"DaysAfterInitiation"} + } + }, + "AbortMultipartUploadOutput":{ + "type":"structure", + "members":{ + "RequestCharged":{ + "shape":"RequestCharged", + "location":"header", + "locationName":"x-amz-request-charged" + } + } + }, + "AbortMultipartUploadRequest":{ + "type":"structure", + "required":[ + "Bucket", + "Key", + "UploadId" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + }, + "Key":{ + "shape":"ObjectKey", + "location":"uri", + "locationName":"Key" + }, + "UploadId":{ + "shape":"MultipartUploadId", + "location":"querystring", + "locationName":"uploadId" + }, + "RequestPayer":{ + "shape":"RequestPayer", + "location":"header", + "locationName":"x-amz-request-payer" + } + } + }, + "AbortRuleId":{"type":"string"}, + "AccelerateConfiguration":{ + "type":"structure", + "members":{ + "Status":{"shape":"BucketAccelerateStatus"} + } + }, + "AcceptRanges":{"type":"string"}, + "AccessControlPolicy":{ + "type":"structure", + "members":{ + "Grants":{ + "shape":"Grants", + "locationName":"AccessControlList" + }, + "Owner":{"shape":"Owner"} + } + }, + "AllowedHeader":{"type":"string"}, + "AllowedHeaders":{ + "type":"list", + "member":{"shape":"AllowedHeader"}, + "flattened":true + }, + "AllowedMethod":{"type":"string"}, + "AllowedMethods":{ + "type":"list", + "member":{"shape":"AllowedMethod"}, + "flattened":true + }, + "AllowedOrigin":{"type":"string"}, + "AllowedOrigins":{ + "type":"list", + "member":{"shape":"AllowedOrigin"}, + "flattened":true + }, + "Body":{"type":"blob"}, + "Bucket":{ + "type":"structure", + "members":{ + "Name":{"shape":"BucketName"}, + "CreationDate":{"shape":"CreationDate"} + } + }, + "BucketAccelerateStatus":{ + "type":"string", + "enum":[ + "Enabled", + "Suspended" + ] + }, + "BucketAlreadyExists":{ + "type":"structure", + "members":{ + }, + "exception":true + }, + "BucketAlreadyOwnedByYou":{ + "type":"structure", + "members":{ + }, + "exception":true + }, + "BucketCannedACL":{ + "type":"string", + "enum":[ + "private", + "public-read", + "public-read-write", + "authenticated-read" + ] + }, + "BucketLifecycleConfiguration":{ + "type":"structure", + "required":["Rules"], + "members":{ + "Rules":{ + "shape":"LifecycleRules", + "locationName":"Rule" + } + } + }, + "BucketLocationConstraint":{ + "type":"string", + "enum":[ + "EU", + "eu-west-1", + "us-west-1", + "us-west-2", + "ap-south-1", + "ap-southeast-1", + "ap-southeast-2", + "ap-northeast-1", + "sa-east-1", + "cn-north-1", + "eu-central-1" + ] + }, + "BucketLoggingStatus":{ + "type":"structure", + "members":{ + "LoggingEnabled":{"shape":"LoggingEnabled"} + } + }, + "BucketLogsPermission":{ + "type":"string", + "enum":[ + "FULL_CONTROL", + "READ", + "WRITE" + ] + }, + "BucketName":{"type":"string"}, + "BucketVersioningStatus":{ + "type":"string", + "enum":[ + "Enabled", + "Suspended" + ] + }, + "Buckets":{ + "type":"list", + "member":{ + "shape":"Bucket", + "locationName":"Bucket" + } + }, + "CORSConfiguration":{ + "type":"structure", + "required":["CORSRules"], + "members":{ + "CORSRules":{ + "shape":"CORSRules", + "locationName":"CORSRule" + } + } + }, + "CORSRule":{ + "type":"structure", + "required":[ + "AllowedMethods", + "AllowedOrigins" + ], + "members":{ + "AllowedHeaders":{ + "shape":"AllowedHeaders", + "locationName":"AllowedHeader" + }, + "AllowedMethods":{ + "shape":"AllowedMethods", + "locationName":"AllowedMethod" + }, + "AllowedOrigins":{ + "shape":"AllowedOrigins", + "locationName":"AllowedOrigin" + }, + "ExposeHeaders":{ + "shape":"ExposeHeaders", + "locationName":"ExposeHeader" + }, + "MaxAgeSeconds":{"shape":"MaxAgeSeconds"} + } + }, + "CORSRules":{ + "type":"list", + "member":{"shape":"CORSRule"}, + "flattened":true + }, + "CacheControl":{"type":"string"}, + "CloudFunction":{"type":"string"}, + "CloudFunctionConfiguration":{ + "type":"structure", + "members":{ + "Id":{"shape":"NotificationId"}, + "Event":{ + "shape":"Event", + "deprecated":true + }, + "Events":{ + "shape":"EventList", + "locationName":"Event" + }, + "CloudFunction":{"shape":"CloudFunction"}, + "InvocationRole":{"shape":"CloudFunctionInvocationRole"} + } + }, + "CloudFunctionInvocationRole":{"type":"string"}, + "Code":{"type":"string"}, + "CommonPrefix":{ + "type":"structure", + "members":{ + "Prefix":{"shape":"Prefix"} + } + }, + "CommonPrefixList":{ + "type":"list", + "member":{"shape":"CommonPrefix"}, + "flattened":true + }, + "CompleteMultipartUploadOutput":{ + "type":"structure", + "members":{ + "Location":{"shape":"Location"}, + "Bucket":{"shape":"BucketName"}, + "Key":{"shape":"ObjectKey"}, + "Expiration":{ + "shape":"Expiration", + "location":"header", + "locationName":"x-amz-expiration" + }, + "ETag":{"shape":"ETag"}, + "ServerSideEncryption":{ + "shape":"ServerSideEncryption", + "location":"header", + "locationName":"x-amz-server-side-encryption" + }, + "VersionId":{ + "shape":"ObjectVersionId", + "location":"header", + "locationName":"x-amz-version-id" + }, + "SSEKMSKeyId":{ + "shape":"SSEKMSKeyId", + "location":"header", + "locationName":"x-amz-server-side-encryption-aws-kms-key-id" + }, + "RequestCharged":{ + "shape":"RequestCharged", + "location":"header", + "locationName":"x-amz-request-charged" + } + } + }, + "CompleteMultipartUploadRequest":{ + "type":"structure", + "required":[ + "Bucket", + "Key", + "UploadId" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + }, + "Key":{ + "shape":"ObjectKey", + "location":"uri", + "locationName":"Key" + }, + "MultipartUpload":{ + "shape":"CompletedMultipartUpload", + "locationName":"CompleteMultipartUpload", + "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} + }, + "UploadId":{ + "shape":"MultipartUploadId", + "location":"querystring", + "locationName":"uploadId" + }, + "RequestPayer":{ + "shape":"RequestPayer", + "location":"header", + "locationName":"x-amz-request-payer" + } + }, + "payload":"MultipartUpload" + }, + "CompletedMultipartUpload":{ + "type":"structure", + "members":{ + "Parts":{ + "shape":"CompletedPartList", + "locationName":"Part" + } + } + }, + "CompletedPart":{ + "type":"structure", + "members":{ + "ETag":{"shape":"ETag"}, + "PartNumber":{"shape":"PartNumber"} + } + }, + "CompletedPartList":{ + "type":"list", + "member":{"shape":"CompletedPart"}, + "flattened":true + }, + "Condition":{ + "type":"structure", + "members":{ + "HttpErrorCodeReturnedEquals":{"shape":"HttpErrorCodeReturnedEquals"}, + "KeyPrefixEquals":{"shape":"KeyPrefixEquals"} + } + }, + "ContentDisposition":{"type":"string"}, + "ContentEncoding":{"type":"string"}, + "ContentLanguage":{"type":"string"}, + "ContentLength":{"type":"long"}, + "ContentMD5":{"type":"string"}, + "ContentRange":{"type":"string"}, + "ContentType":{"type":"string"}, + "CopyObjectOutput":{ + "type":"structure", + "members":{ + "CopyObjectResult":{"shape":"CopyObjectResult"}, + "Expiration":{ + "shape":"Expiration", + "location":"header", + "locationName":"x-amz-expiration" + }, + "CopySourceVersionId":{ + "shape":"CopySourceVersionId", + "location":"header", + "locationName":"x-amz-copy-source-version-id" + }, + "VersionId":{ + "shape":"ObjectVersionId", + "location":"header", + "locationName":"x-amz-version-id" + }, + "ServerSideEncryption":{ + "shape":"ServerSideEncryption", + "location":"header", + "locationName":"x-amz-server-side-encryption" + }, + "SSECustomerAlgorithm":{ + "shape":"SSECustomerAlgorithm", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-algorithm" + }, + "SSECustomerKeyMD5":{ + "shape":"SSECustomerKeyMD5", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-key-MD5" + }, + "SSEKMSKeyId":{ + "shape":"SSEKMSKeyId", + "location":"header", + "locationName":"x-amz-server-side-encryption-aws-kms-key-id" + }, + "RequestCharged":{ + "shape":"RequestCharged", + "location":"header", + "locationName":"x-amz-request-charged" + } + }, + "payload":"CopyObjectResult" + }, + "CopyObjectRequest":{ + "type":"structure", + "required":[ + "Bucket", + "CopySource", + "Key" + ], + "members":{ + "ACL":{ + "shape":"ObjectCannedACL", + "location":"header", + "locationName":"x-amz-acl" + }, + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + }, + "CacheControl":{ + "shape":"CacheControl", + "location":"header", + "locationName":"Cache-Control" + }, + "ContentDisposition":{ + "shape":"ContentDisposition", + "location":"header", + "locationName":"Content-Disposition" + }, + "ContentEncoding":{ + "shape":"ContentEncoding", + "location":"header", + "locationName":"Content-Encoding" + }, + "ContentLanguage":{ + "shape":"ContentLanguage", + "location":"header", + "locationName":"Content-Language" + }, + "ContentType":{ + "shape":"ContentType", + "location":"header", + "locationName":"Content-Type" + }, + "CopySource":{ + "shape":"CopySource", + "location":"header", + "locationName":"x-amz-copy-source" + }, + "CopySourceIfMatch":{ + "shape":"CopySourceIfMatch", + "location":"header", + "locationName":"x-amz-copy-source-if-match" + }, + "CopySourceIfModifiedSince":{ + "shape":"CopySourceIfModifiedSince", + "location":"header", + "locationName":"x-amz-copy-source-if-modified-since" + }, + "CopySourceIfNoneMatch":{ + "shape":"CopySourceIfNoneMatch", + "location":"header", + "locationName":"x-amz-copy-source-if-none-match" + }, + "CopySourceIfUnmodifiedSince":{ + "shape":"CopySourceIfUnmodifiedSince", + "location":"header", + "locationName":"x-amz-copy-source-if-unmodified-since" + }, + "Expires":{ + "shape":"Expires", + "location":"header", + "locationName":"Expires" + }, + "GrantFullControl":{ + "shape":"GrantFullControl", + "location":"header", + "locationName":"x-amz-grant-full-control" + }, + "GrantRead":{ + "shape":"GrantRead", + "location":"header", + "locationName":"x-amz-grant-read" + }, + "GrantReadACP":{ + "shape":"GrantReadACP", + "location":"header", + "locationName":"x-amz-grant-read-acp" + }, + "GrantWriteACP":{ + "shape":"GrantWriteACP", + "location":"header", + "locationName":"x-amz-grant-write-acp" + }, + "Key":{ + "shape":"ObjectKey", + "location":"uri", + "locationName":"Key" + }, + "Metadata":{ + "shape":"Metadata", + "location":"headers", + "locationName":"x-amz-meta-" + }, + "MetadataDirective":{ + "shape":"MetadataDirective", + "location":"header", + "locationName":"x-amz-metadata-directive" + }, + "ServerSideEncryption":{ + "shape":"ServerSideEncryption", + "location":"header", + "locationName":"x-amz-server-side-encryption" + }, + "StorageClass":{ + "shape":"StorageClass", + "location":"header", + "locationName":"x-amz-storage-class" + }, + "WebsiteRedirectLocation":{ + "shape":"WebsiteRedirectLocation", + "location":"header", + "locationName":"x-amz-website-redirect-location" + }, + "SSECustomerAlgorithm":{ + "shape":"SSECustomerAlgorithm", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-algorithm" + }, + "SSECustomerKey":{ + "shape":"SSECustomerKey", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-key" + }, + "SSECustomerKeyMD5":{ + "shape":"SSECustomerKeyMD5", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-key-MD5" + }, + "SSEKMSKeyId":{ + "shape":"SSEKMSKeyId", + "location":"header", + "locationName":"x-amz-server-side-encryption-aws-kms-key-id" + }, + "CopySourceSSECustomerAlgorithm":{ + "shape":"CopySourceSSECustomerAlgorithm", + "location":"header", + "locationName":"x-amz-copy-source-server-side-encryption-customer-algorithm" + }, + "CopySourceSSECustomerKey":{ + "shape":"CopySourceSSECustomerKey", + "location":"header", + "locationName":"x-amz-copy-source-server-side-encryption-customer-key" + }, + "CopySourceSSECustomerKeyMD5":{ + "shape":"CopySourceSSECustomerKeyMD5", + "location":"header", + "locationName":"x-amz-copy-source-server-side-encryption-customer-key-MD5" + }, + "RequestPayer":{ + "shape":"RequestPayer", + "location":"header", + "locationName":"x-amz-request-payer" + } + } + }, + "CopyObjectResult":{ + "type":"structure", + "members":{ + "ETag":{"shape":"ETag"}, + "LastModified":{"shape":"LastModified"} + } + }, + "CopyPartResult":{ + "type":"structure", + "members":{ + "ETag":{"shape":"ETag"}, + "LastModified":{"shape":"LastModified"} + } + }, + "CopySource":{ + "type":"string", + "pattern":"\\/.+\\/.+" + }, + "CopySourceIfMatch":{"type":"string"}, + "CopySourceIfModifiedSince":{"type":"timestamp"}, + "CopySourceIfNoneMatch":{"type":"string"}, + "CopySourceIfUnmodifiedSince":{"type":"timestamp"}, + "CopySourceRange":{"type":"string"}, + "CopySourceSSECustomerAlgorithm":{"type":"string"}, + "CopySourceSSECustomerKey":{ + "type":"string", + "sensitive":true + }, + "CopySourceSSECustomerKeyMD5":{"type":"string"}, + "CopySourceVersionId":{"type":"string"}, + "CreateBucketConfiguration":{ + "type":"structure", + "members":{ + "LocationConstraint":{"shape":"BucketLocationConstraint"} + } + }, + "CreateBucketOutput":{ + "type":"structure", + "members":{ + "Location":{ + "shape":"Location", + "location":"header", + "locationName":"Location" + } + } + }, + "CreateBucketRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "ACL":{ + "shape":"BucketCannedACL", + "location":"header", + "locationName":"x-amz-acl" + }, + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + }, + "CreateBucketConfiguration":{ + "shape":"CreateBucketConfiguration", + "locationName":"CreateBucketConfiguration", + "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} + }, + "GrantFullControl":{ + "shape":"GrantFullControl", + "location":"header", + "locationName":"x-amz-grant-full-control" + }, + "GrantRead":{ + "shape":"GrantRead", + "location":"header", + "locationName":"x-amz-grant-read" + }, + "GrantReadACP":{ + "shape":"GrantReadACP", + "location":"header", + "locationName":"x-amz-grant-read-acp" + }, + "GrantWrite":{ + "shape":"GrantWrite", + "location":"header", + "locationName":"x-amz-grant-write" + }, + "GrantWriteACP":{ + "shape":"GrantWriteACP", + "location":"header", + "locationName":"x-amz-grant-write-acp" + } + }, + "payload":"CreateBucketConfiguration" + }, + "CreateMultipartUploadOutput":{ + "type":"structure", + "members":{ + "AbortDate":{ + "shape":"AbortDate", + "location":"header", + "locationName":"x-amz-abort-date" + }, + "AbortRuleId":{ + "shape":"AbortRuleId", + "location":"header", + "locationName":"x-amz-abort-rule-id" + }, + "Bucket":{ + "shape":"BucketName", + "locationName":"Bucket" + }, + "Key":{"shape":"ObjectKey"}, + "UploadId":{"shape":"MultipartUploadId"}, + "ServerSideEncryption":{ + "shape":"ServerSideEncryption", + "location":"header", + "locationName":"x-amz-server-side-encryption" + }, + "SSECustomerAlgorithm":{ + "shape":"SSECustomerAlgorithm", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-algorithm" + }, + "SSECustomerKeyMD5":{ + "shape":"SSECustomerKeyMD5", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-key-MD5" + }, + "SSEKMSKeyId":{ + "shape":"SSEKMSKeyId", + "location":"header", + "locationName":"x-amz-server-side-encryption-aws-kms-key-id" + }, + "RequestCharged":{ + "shape":"RequestCharged", + "location":"header", + "locationName":"x-amz-request-charged" + } + } + }, + "CreateMultipartUploadRequest":{ + "type":"structure", + "required":[ + "Bucket", + "Key" + ], + "members":{ + "ACL":{ + "shape":"ObjectCannedACL", + "location":"header", + "locationName":"x-amz-acl" + }, + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + }, + "CacheControl":{ + "shape":"CacheControl", + "location":"header", + "locationName":"Cache-Control" + }, + "ContentDisposition":{ + "shape":"ContentDisposition", + "location":"header", + "locationName":"Content-Disposition" + }, + "ContentEncoding":{ + "shape":"ContentEncoding", + "location":"header", + "locationName":"Content-Encoding" + }, + "ContentLanguage":{ + "shape":"ContentLanguage", + "location":"header", + "locationName":"Content-Language" + }, + "ContentType":{ + "shape":"ContentType", + "location":"header", + "locationName":"Content-Type" + }, + "Expires":{ + "shape":"Expires", + "location":"header", + "locationName":"Expires" + }, + "GrantFullControl":{ + "shape":"GrantFullControl", + "location":"header", + "locationName":"x-amz-grant-full-control" + }, + "GrantRead":{ + "shape":"GrantRead", + "location":"header", + "locationName":"x-amz-grant-read" + }, + "GrantReadACP":{ + "shape":"GrantReadACP", + "location":"header", + "locationName":"x-amz-grant-read-acp" + }, + "GrantWriteACP":{ + "shape":"GrantWriteACP", + "location":"header", + "locationName":"x-amz-grant-write-acp" + }, + "Key":{ + "shape":"ObjectKey", + "location":"uri", + "locationName":"Key" + }, + "Metadata":{ + "shape":"Metadata", + "location":"headers", + "locationName":"x-amz-meta-" + }, + "ServerSideEncryption":{ + "shape":"ServerSideEncryption", + "location":"header", + "locationName":"x-amz-server-side-encryption" + }, + "StorageClass":{ + "shape":"StorageClass", + "location":"header", + "locationName":"x-amz-storage-class" + }, + "WebsiteRedirectLocation":{ + "shape":"WebsiteRedirectLocation", + "location":"header", + "locationName":"x-amz-website-redirect-location" + }, + "SSECustomerAlgorithm":{ + "shape":"SSECustomerAlgorithm", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-algorithm" + }, + "SSECustomerKey":{ + "shape":"SSECustomerKey", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-key" + }, + "SSECustomerKeyMD5":{ + "shape":"SSECustomerKeyMD5", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-key-MD5" + }, + "SSEKMSKeyId":{ + "shape":"SSEKMSKeyId", + "location":"header", + "locationName":"x-amz-server-side-encryption-aws-kms-key-id" + }, + "RequestPayer":{ + "shape":"RequestPayer", + "location":"header", + "locationName":"x-amz-request-payer" + } + } + }, + "CreationDate":{"type":"timestamp"}, + "Date":{ + "type":"timestamp", + "timestampFormat":"iso8601" + }, + "Days":{"type":"integer"}, + "DaysAfterInitiation":{"type":"integer"}, + "Delete":{ + "type":"structure", + "required":["Objects"], + "members":{ + "Objects":{ + "shape":"ObjectIdentifierList", + "locationName":"Object" + }, + "Quiet":{"shape":"Quiet"} + } + }, + "DeleteBucketCorsRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + } + } + }, + "DeleteBucketLifecycleRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + } + } + }, + "DeleteBucketPolicyRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + } + } + }, + "DeleteBucketReplicationRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + } + } + }, + "DeleteBucketRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + } + } + }, + "DeleteBucketTaggingRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + } + } + }, + "DeleteBucketWebsiteRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + } + } + }, + "DeleteMarker":{"type":"boolean"}, + "DeleteMarkerEntry":{ + "type":"structure", + "members":{ + "Owner":{"shape":"Owner"}, + "Key":{"shape":"ObjectKey"}, + "VersionId":{"shape":"ObjectVersionId"}, + "IsLatest":{"shape":"IsLatest"}, + "LastModified":{"shape":"LastModified"} + } + }, + "DeleteMarkerVersionId":{"type":"string"}, + "DeleteMarkers":{ + "type":"list", + "member":{"shape":"DeleteMarkerEntry"}, + "flattened":true + }, + "DeleteObjectOutput":{ + "type":"structure", + "members":{ + "DeleteMarker":{ + "shape":"DeleteMarker", + "location":"header", + "locationName":"x-amz-delete-marker" + }, + "VersionId":{ + "shape":"ObjectVersionId", + "location":"header", + "locationName":"x-amz-version-id" + }, + "RequestCharged":{ + "shape":"RequestCharged", + "location":"header", + "locationName":"x-amz-request-charged" + } + } + }, + "DeleteObjectRequest":{ + "type":"structure", + "required":[ + "Bucket", + "Key" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + }, + "Key":{ + "shape":"ObjectKey", + "location":"uri", + "locationName":"Key" + }, + "MFA":{ + "shape":"MFA", + "location":"header", + "locationName":"x-amz-mfa" + }, + "VersionId":{ + "shape":"ObjectVersionId", + "location":"querystring", + "locationName":"versionId" + }, + "RequestPayer":{ + "shape":"RequestPayer", + "location":"header", + "locationName":"x-amz-request-payer" + } + } + }, + "DeleteObjectsOutput":{ + "type":"structure", + "members":{ + "Deleted":{"shape":"DeletedObjects"}, + "RequestCharged":{ + "shape":"RequestCharged", + "location":"header", + "locationName":"x-amz-request-charged" + }, + "Errors":{ + "shape":"Errors", + "locationName":"Error" + } + } + }, + "DeleteObjectsRequest":{ + "type":"structure", + "required":[ + "Bucket", + "Delete" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + }, + "Delete":{ + "shape":"Delete", + "locationName":"Delete", + "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} + }, + "MFA":{ + "shape":"MFA", + "location":"header", + "locationName":"x-amz-mfa" + }, + "RequestPayer":{ + "shape":"RequestPayer", + "location":"header", + "locationName":"x-amz-request-payer" + } + }, + "payload":"Delete" + }, + "DeletedObject":{ + "type":"structure", + "members":{ + "Key":{"shape":"ObjectKey"}, + "VersionId":{"shape":"ObjectVersionId"}, + "DeleteMarker":{"shape":"DeleteMarker"}, + "DeleteMarkerVersionId":{"shape":"DeleteMarkerVersionId"} + } + }, + "DeletedObjects":{ + "type":"list", + "member":{"shape":"DeletedObject"}, + "flattened":true + }, + "Delimiter":{"type":"string"}, + "Destination":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{"shape":"BucketName"}, + "StorageClass":{"shape":"StorageClass"} + } + }, + "DisplayName":{"type":"string"}, + "ETag":{"type":"string"}, + "EmailAddress":{"type":"string"}, + "EncodingType":{ + "type":"string", + "enum":["url"] + }, + "Error":{ + "type":"structure", + "members":{ + "Key":{"shape":"ObjectKey"}, + "VersionId":{"shape":"ObjectVersionId"}, + "Code":{"shape":"Code"}, + "Message":{"shape":"Message"} + } + }, + "ErrorDocument":{ + "type":"structure", + "required":["Key"], + "members":{ + "Key":{"shape":"ObjectKey"} + } + }, + "Errors":{ + "type":"list", + "member":{"shape":"Error"}, + "flattened":true + }, + "Event":{ + "type":"string", + "enum":[ + "s3:ReducedRedundancyLostObject", + "s3:ObjectCreated:*", + "s3:ObjectCreated:Put", + "s3:ObjectCreated:Post", + "s3:ObjectCreated:Copy", + "s3:ObjectCreated:CompleteMultipartUpload", + "s3:ObjectRemoved:*", + "s3:ObjectRemoved:Delete", + "s3:ObjectRemoved:DeleteMarkerCreated" + ] + }, + "EventList":{ + "type":"list", + "member":{"shape":"Event"}, + "flattened":true + }, + "Expiration":{"type":"string"}, + "ExpirationStatus":{ + "type":"string", + "enum":[ + "Enabled", + "Disabled" + ] + }, + "ExpiredObjectDeleteMarker":{"type":"boolean"}, + "Expires":{"type":"timestamp"}, + "ExposeHeader":{"type":"string"}, + "ExposeHeaders":{ + "type":"list", + "member":{"shape":"ExposeHeader"}, + "flattened":true + }, + "FetchOwner":{"type":"boolean"}, + "FilterRule":{ + "type":"structure", + "members":{ + "Name":{"shape":"FilterRuleName"}, + "Value":{"shape":"FilterRuleValue"} + } + }, + "FilterRuleList":{ + "type":"list", + "member":{"shape":"FilterRule"}, + "flattened":true + }, + "FilterRuleName":{ + "type":"string", + "enum":[ + "prefix", + "suffix" + ] + }, + "FilterRuleValue":{"type":"string"}, + "GetBucketAccelerateConfigurationOutput":{ + "type":"structure", + "members":{ + "Status":{"shape":"BucketAccelerateStatus"} + } + }, + "GetBucketAccelerateConfigurationRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + } + } + }, + "GetBucketAclOutput":{ + "type":"structure", + "members":{ + "Owner":{"shape":"Owner"}, + "Grants":{ + "shape":"Grants", + "locationName":"AccessControlList" + } + } + }, + "GetBucketAclRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + } + } + }, + "GetBucketCorsOutput":{ + "type":"structure", + "members":{ + "CORSRules":{ + "shape":"CORSRules", + "locationName":"CORSRule" + } + } + }, + "GetBucketCorsRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + } + } + }, + "GetBucketLifecycleConfigurationOutput":{ + "type":"structure", + "members":{ + "Rules":{ + "shape":"LifecycleRules", + "locationName":"Rule" + } + } + }, + "GetBucketLifecycleConfigurationRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + } + } + }, + "GetBucketLifecycleOutput":{ + "type":"structure", + "members":{ + "Rules":{ + "shape":"Rules", + "locationName":"Rule" + } + } + }, + "GetBucketLifecycleRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + } + } + }, + "GetBucketLocationOutput":{ + "type":"structure", + "members":{ + "LocationConstraint":{"shape":"BucketLocationConstraint"} + } + }, + "GetBucketLocationRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + } + } + }, + "GetBucketLoggingOutput":{ + "type":"structure", + "members":{ + "LoggingEnabled":{"shape":"LoggingEnabled"} + } + }, + "GetBucketLoggingRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + } + } + }, + "GetBucketNotificationConfigurationRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + } + } + }, + "GetBucketPolicyOutput":{ + "type":"structure", + "members":{ + "Policy":{"shape":"Policy"} + }, + "payload":"Policy" + }, + "GetBucketPolicyRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + } + } + }, + "GetBucketReplicationOutput":{ + "type":"structure", + "members":{ + "ReplicationConfiguration":{"shape":"ReplicationConfiguration"} + }, + "payload":"ReplicationConfiguration" + }, + "GetBucketReplicationRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + } + } + }, + "GetBucketRequestPaymentOutput":{ + "type":"structure", + "members":{ + "Payer":{"shape":"Payer"} + } + }, + "GetBucketRequestPaymentRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + } + } + }, + "GetBucketTaggingOutput":{ + "type":"structure", + "required":["TagSet"], + "members":{ + "TagSet":{"shape":"TagSet"} + } + }, + "GetBucketTaggingRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + } + } + }, + "GetBucketVersioningOutput":{ + "type":"structure", + "members":{ + "Status":{"shape":"BucketVersioningStatus"}, + "MFADelete":{ + "shape":"MFADeleteStatus", + "locationName":"MfaDelete" + } + } + }, + "GetBucketVersioningRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + } + } + }, + "GetBucketWebsiteOutput":{ + "type":"structure", + "members":{ + "RedirectAllRequestsTo":{"shape":"RedirectAllRequestsTo"}, + "IndexDocument":{"shape":"IndexDocument"}, + "ErrorDocument":{"shape":"ErrorDocument"}, + "RoutingRules":{"shape":"RoutingRules"} + } + }, + "GetBucketWebsiteRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + } + } + }, + "GetObjectAclOutput":{ + "type":"structure", + "members":{ + "Owner":{"shape":"Owner"}, + "Grants":{ + "shape":"Grants", + "locationName":"AccessControlList" + }, + "RequestCharged":{ + "shape":"RequestCharged", + "location":"header", + "locationName":"x-amz-request-charged" + } + } + }, + "GetObjectAclRequest":{ + "type":"structure", + "required":[ + "Bucket", + "Key" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + }, + "Key":{ + "shape":"ObjectKey", + "location":"uri", + "locationName":"Key" + }, + "VersionId":{ + "shape":"ObjectVersionId", + "location":"querystring", + "locationName":"versionId" + }, + "RequestPayer":{ + "shape":"RequestPayer", + "location":"header", + "locationName":"x-amz-request-payer" + } + } + }, + "GetObjectOutput":{ + "type":"structure", + "members":{ + "Body":{ + "shape":"Body", + "streaming":true + }, + "DeleteMarker":{ + "shape":"DeleteMarker", + "location":"header", + "locationName":"x-amz-delete-marker" + }, + "AcceptRanges":{ + "shape":"AcceptRanges", + "location":"header", + "locationName":"accept-ranges" + }, + "Expiration":{ + "shape":"Expiration", + "location":"header", + "locationName":"x-amz-expiration" + }, + "Restore":{ + "shape":"Restore", + "location":"header", + "locationName":"x-amz-restore" + }, + "LastModified":{ + "shape":"LastModified", + "location":"header", + "locationName":"Last-Modified" + }, + "ContentLength":{ + "shape":"ContentLength", + "location":"header", + "locationName":"Content-Length" + }, + "ETag":{ + "shape":"ETag", + "location":"header", + "locationName":"ETag" + }, + "MissingMeta":{ + "shape":"MissingMeta", + "location":"header", + "locationName":"x-amz-missing-meta" + }, + "VersionId":{ + "shape":"ObjectVersionId", + "location":"header", + "locationName":"x-amz-version-id" + }, + "CacheControl":{ + "shape":"CacheControl", + "location":"header", + "locationName":"Cache-Control" + }, + "ContentDisposition":{ + "shape":"ContentDisposition", + "location":"header", + "locationName":"Content-Disposition" + }, + "ContentEncoding":{ + "shape":"ContentEncoding", + "location":"header", + "locationName":"Content-Encoding" + }, + "ContentLanguage":{ + "shape":"ContentLanguage", + "location":"header", + "locationName":"Content-Language" + }, + "ContentRange":{ + "shape":"ContentRange", + "location":"header", + "locationName":"Content-Range" + }, + "ContentType":{ + "shape":"ContentType", + "location":"header", + "locationName":"Content-Type" + }, + "Expires":{ + "shape":"Expires", + "location":"header", + "locationName":"Expires" + }, + "WebsiteRedirectLocation":{ + "shape":"WebsiteRedirectLocation", + "location":"header", + "locationName":"x-amz-website-redirect-location" + }, + "ServerSideEncryption":{ + "shape":"ServerSideEncryption", + "location":"header", + "locationName":"x-amz-server-side-encryption" + }, + "Metadata":{ + "shape":"Metadata", + "location":"headers", + "locationName":"x-amz-meta-" + }, + "SSECustomerAlgorithm":{ + "shape":"SSECustomerAlgorithm", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-algorithm" + }, + "SSECustomerKeyMD5":{ + "shape":"SSECustomerKeyMD5", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-key-MD5" + }, + "SSEKMSKeyId":{ + "shape":"SSEKMSKeyId", + "location":"header", + "locationName":"x-amz-server-side-encryption-aws-kms-key-id" + }, + "StorageClass":{ + "shape":"StorageClass", + "location":"header", + "locationName":"x-amz-storage-class" + }, + "RequestCharged":{ + "shape":"RequestCharged", + "location":"header", + "locationName":"x-amz-request-charged" + }, + "ReplicationStatus":{ + "shape":"ReplicationStatus", + "location":"header", + "locationName":"x-amz-replication-status" + } + }, + "payload":"Body" + }, + "GetObjectRequest":{ + "type":"structure", + "required":[ + "Bucket", + "Key" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + }, + "IfMatch":{ + "shape":"IfMatch", + "location":"header", + "locationName":"If-Match" + }, + "IfModifiedSince":{ + "shape":"IfModifiedSince", + "location":"header", + "locationName":"If-Modified-Since" + }, + "IfNoneMatch":{ + "shape":"IfNoneMatch", + "location":"header", + "locationName":"If-None-Match" + }, + "IfUnmodifiedSince":{ + "shape":"IfUnmodifiedSince", + "location":"header", + "locationName":"If-Unmodified-Since" + }, + "Key":{ + "shape":"ObjectKey", + "location":"uri", + "locationName":"Key" + }, + "Range":{ + "shape":"Range", + "location":"header", + "locationName":"Range" + }, + "ResponseCacheControl":{ + "shape":"ResponseCacheControl", + "location":"querystring", + "locationName":"response-cache-control" + }, + "ResponseContentDisposition":{ + "shape":"ResponseContentDisposition", + "location":"querystring", + "locationName":"response-content-disposition" + }, + "ResponseContentEncoding":{ + "shape":"ResponseContentEncoding", + "location":"querystring", + "locationName":"response-content-encoding" + }, + "ResponseContentLanguage":{ + "shape":"ResponseContentLanguage", + "location":"querystring", + "locationName":"response-content-language" + }, + "ResponseContentType":{ + "shape":"ResponseContentType", + "location":"querystring", + "locationName":"response-content-type" + }, + "ResponseExpires":{ + "shape":"ResponseExpires", + "location":"querystring", + "locationName":"response-expires" + }, + "VersionId":{ + "shape":"ObjectVersionId", + "location":"querystring", + "locationName":"versionId" + }, + "SSECustomerAlgorithm":{ + "shape":"SSECustomerAlgorithm", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-algorithm" + }, + "SSECustomerKey":{ + "shape":"SSECustomerKey", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-key" + }, + "SSECustomerKeyMD5":{ + "shape":"SSECustomerKeyMD5", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-key-MD5" + }, + "RequestPayer":{ + "shape":"RequestPayer", + "location":"header", + "locationName":"x-amz-request-payer" + } + } + }, + "GetObjectTorrentOutput":{ + "type":"structure", + "members":{ + "Body":{ + "shape":"Body", + "streaming":true + }, + "RequestCharged":{ + "shape":"RequestCharged", + "location":"header", + "locationName":"x-amz-request-charged" + } + }, + "payload":"Body" + }, + "GetObjectTorrentRequest":{ + "type":"structure", + "required":[ + "Bucket", + "Key" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + }, + "Key":{ + "shape":"ObjectKey", + "location":"uri", + "locationName":"Key" + }, + "RequestPayer":{ + "shape":"RequestPayer", + "location":"header", + "locationName":"x-amz-request-payer" + } + } + }, + "Grant":{ + "type":"structure", + "members":{ + "Grantee":{"shape":"Grantee"}, + "Permission":{"shape":"Permission"} + } + }, + "GrantFullControl":{"type":"string"}, + "GrantRead":{"type":"string"}, + "GrantReadACP":{"type":"string"}, + "GrantWrite":{"type":"string"}, + "GrantWriteACP":{"type":"string"}, + "Grantee":{ + "type":"structure", + "required":["Type"], + "members":{ + "DisplayName":{"shape":"DisplayName"}, + "EmailAddress":{"shape":"EmailAddress"}, + "ID":{"shape":"ID"}, + "Type":{ + "shape":"Type", + "locationName":"xsi:type", + "xmlAttribute":true + }, + "URI":{"shape":"URI"} + }, + "xmlNamespace":{ + "prefix":"xsi", + "uri":"http://www.w3.org/2001/XMLSchema-instance" + } + }, + "Grants":{ + "type":"list", + "member":{ + "shape":"Grant", + "locationName":"Grant" + } + }, + "HeadBucketRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + } + } + }, + "HeadObjectOutput":{ + "type":"structure", + "members":{ + "DeleteMarker":{ + "shape":"DeleteMarker", + "location":"header", + "locationName":"x-amz-delete-marker" + }, + "AcceptRanges":{ + "shape":"AcceptRanges", + "location":"header", + "locationName":"accept-ranges" + }, + "Expiration":{ + "shape":"Expiration", + "location":"header", + "locationName":"x-amz-expiration" + }, + "Restore":{ + "shape":"Restore", + "location":"header", + "locationName":"x-amz-restore" + }, + "LastModified":{ + "shape":"LastModified", + "location":"header", + "locationName":"Last-Modified" + }, + "ContentLength":{ + "shape":"ContentLength", + "location":"header", + "locationName":"Content-Length" + }, + "ETag":{ + "shape":"ETag", + "location":"header", + "locationName":"ETag" + }, + "MissingMeta":{ + "shape":"MissingMeta", + "location":"header", + "locationName":"x-amz-missing-meta" + }, + "VersionId":{ + "shape":"ObjectVersionId", + "location":"header", + "locationName":"x-amz-version-id" + }, + "CacheControl":{ + "shape":"CacheControl", + "location":"header", + "locationName":"Cache-Control" + }, + "ContentDisposition":{ + "shape":"ContentDisposition", + "location":"header", + "locationName":"Content-Disposition" + }, + "ContentEncoding":{ + "shape":"ContentEncoding", + "location":"header", + "locationName":"Content-Encoding" + }, + "ContentLanguage":{ + "shape":"ContentLanguage", + "location":"header", + "locationName":"Content-Language" + }, + "ContentType":{ + "shape":"ContentType", + "location":"header", + "locationName":"Content-Type" + }, + "Expires":{ + "shape":"Expires", + "location":"header", + "locationName":"Expires" + }, + "WebsiteRedirectLocation":{ + "shape":"WebsiteRedirectLocation", + "location":"header", + "locationName":"x-amz-website-redirect-location" + }, + "ServerSideEncryption":{ + "shape":"ServerSideEncryption", + "location":"header", + "locationName":"x-amz-server-side-encryption" + }, + "Metadata":{ + "shape":"Metadata", + "location":"headers", + "locationName":"x-amz-meta-" + }, + "SSECustomerAlgorithm":{ + "shape":"SSECustomerAlgorithm", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-algorithm" + }, + "SSECustomerKeyMD5":{ + "shape":"SSECustomerKeyMD5", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-key-MD5" + }, + "SSEKMSKeyId":{ + "shape":"SSEKMSKeyId", + "location":"header", + "locationName":"x-amz-server-side-encryption-aws-kms-key-id" + }, + "StorageClass":{ + "shape":"StorageClass", + "location":"header", + "locationName":"x-amz-storage-class" + }, + "RequestCharged":{ + "shape":"RequestCharged", + "location":"header", + "locationName":"x-amz-request-charged" + }, + "ReplicationStatus":{ + "shape":"ReplicationStatus", + "location":"header", + "locationName":"x-amz-replication-status" + } + } + }, + "HeadObjectRequest":{ + "type":"structure", + "required":[ + "Bucket", + "Key" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + }, + "IfMatch":{ + "shape":"IfMatch", + "location":"header", + "locationName":"If-Match" + }, + "IfModifiedSince":{ + "shape":"IfModifiedSince", + "location":"header", + "locationName":"If-Modified-Since" + }, + "IfNoneMatch":{ + "shape":"IfNoneMatch", + "location":"header", + "locationName":"If-None-Match" + }, + "IfUnmodifiedSince":{ + "shape":"IfUnmodifiedSince", + "location":"header", + "locationName":"If-Unmodified-Since" + }, + "Key":{ + "shape":"ObjectKey", + "location":"uri", + "locationName":"Key" + }, + "Range":{ + "shape":"Range", + "location":"header", + "locationName":"Range" + }, + "VersionId":{ + "shape":"ObjectVersionId", + "location":"querystring", + "locationName":"versionId" + }, + "SSECustomerAlgorithm":{ + "shape":"SSECustomerAlgorithm", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-algorithm" + }, + "SSECustomerKey":{ + "shape":"SSECustomerKey", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-key" + }, + "SSECustomerKeyMD5":{ + "shape":"SSECustomerKeyMD5", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-key-MD5" + }, + "RequestPayer":{ + "shape":"RequestPayer", + "location":"header", + "locationName":"x-amz-request-payer" + } + } + }, + "HostName":{"type":"string"}, + "HttpErrorCodeReturnedEquals":{"type":"string"}, + "HttpRedirectCode":{"type":"string"}, + "ID":{"type":"string"}, + "IfMatch":{"type":"string"}, + "IfModifiedSince":{"type":"timestamp"}, + "IfNoneMatch":{"type":"string"}, + "IfUnmodifiedSince":{"type":"timestamp"}, + "IndexDocument":{ + "type":"structure", + "required":["Suffix"], + "members":{ + "Suffix":{"shape":"Suffix"} + } + }, + "Initiated":{"type":"timestamp"}, + "Initiator":{ + "type":"structure", + "members":{ + "ID":{"shape":"ID"}, + "DisplayName":{"shape":"DisplayName"} + } + }, + "IsLatest":{"type":"boolean"}, + "IsTruncated":{"type":"boolean"}, + "KeyCount":{"type":"integer"}, + "KeyMarker":{"type":"string"}, + "KeyPrefixEquals":{"type":"string"}, + "LambdaFunctionArn":{"type":"string"}, + "LambdaFunctionConfiguration":{ + "type":"structure", + "required":[ + "LambdaFunctionArn", + "Events" + ], + "members":{ + "Id":{"shape":"NotificationId"}, + "LambdaFunctionArn":{ + "shape":"LambdaFunctionArn", + "locationName":"CloudFunction" + }, + "Events":{ + "shape":"EventList", + "locationName":"Event" + }, + "Filter":{"shape":"NotificationConfigurationFilter"} + } + }, + "LambdaFunctionConfigurationList":{ + "type":"list", + "member":{"shape":"LambdaFunctionConfiguration"}, + "flattened":true + }, + "LastModified":{"type":"timestamp"}, + "LifecycleConfiguration":{ + "type":"structure", + "required":["Rules"], + "members":{ + "Rules":{ + "shape":"Rules", + "locationName":"Rule" + } + } + }, + "LifecycleExpiration":{ + "type":"structure", + "members":{ + "Date":{"shape":"Date"}, + "Days":{"shape":"Days"}, + "ExpiredObjectDeleteMarker":{"shape":"ExpiredObjectDeleteMarker"} + } + }, + "LifecycleRule":{ + "type":"structure", + "required":[ + "Prefix", + "Status" + ], + "members":{ + "Expiration":{"shape":"LifecycleExpiration"}, + "ID":{"shape":"ID"}, + "Prefix":{"shape":"Prefix"}, + "Status":{"shape":"ExpirationStatus"}, + "Transitions":{ + "shape":"TransitionList", + "locationName":"Transition" + }, + "NoncurrentVersionTransitions":{ + "shape":"NoncurrentVersionTransitionList", + "locationName":"NoncurrentVersionTransition" + }, + "NoncurrentVersionExpiration":{"shape":"NoncurrentVersionExpiration"}, + "AbortIncompleteMultipartUpload":{"shape":"AbortIncompleteMultipartUpload"} + } + }, + "LifecycleRules":{ + "type":"list", + "member":{"shape":"LifecycleRule"}, + "flattened":true + }, + "ListBucketsOutput":{ + "type":"structure", + "members":{ + "Buckets":{"shape":"Buckets"}, + "Owner":{"shape":"Owner"} + } + }, + "ListMultipartUploadsOutput":{ + "type":"structure", + "members":{ + "Bucket":{"shape":"BucketName"}, + "KeyMarker":{"shape":"KeyMarker"}, + "UploadIdMarker":{"shape":"UploadIdMarker"}, + "NextKeyMarker":{"shape":"NextKeyMarker"}, + "Prefix":{"shape":"Prefix"}, + "Delimiter":{"shape":"Delimiter"}, + "NextUploadIdMarker":{"shape":"NextUploadIdMarker"}, + "MaxUploads":{"shape":"MaxUploads"}, + "IsTruncated":{"shape":"IsTruncated"}, + "Uploads":{ + "shape":"MultipartUploadList", + "locationName":"Upload" + }, + "CommonPrefixes":{"shape":"CommonPrefixList"}, + "EncodingType":{"shape":"EncodingType"} + } + }, + "ListMultipartUploadsRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + }, + "Delimiter":{ + "shape":"Delimiter", + "location":"querystring", + "locationName":"delimiter" + }, + "EncodingType":{ + "shape":"EncodingType", + "location":"querystring", + "locationName":"encoding-type" + }, + "KeyMarker":{ + "shape":"KeyMarker", + "location":"querystring", + "locationName":"key-marker" + }, + "MaxUploads":{ + "shape":"MaxUploads", + "location":"querystring", + "locationName":"max-uploads" + }, + "Prefix":{ + "shape":"Prefix", + "location":"querystring", + "locationName":"prefix" + }, + "UploadIdMarker":{ + "shape":"UploadIdMarker", + "location":"querystring", + "locationName":"upload-id-marker" + } + } + }, + "ListObjectVersionsOutput":{ + "type":"structure", + "members":{ + "IsTruncated":{"shape":"IsTruncated"}, + "KeyMarker":{"shape":"KeyMarker"}, + "VersionIdMarker":{"shape":"VersionIdMarker"}, + "NextKeyMarker":{"shape":"NextKeyMarker"}, + "NextVersionIdMarker":{"shape":"NextVersionIdMarker"}, + "Versions":{ + "shape":"ObjectVersionList", + "locationName":"Version" + }, + "DeleteMarkers":{ + "shape":"DeleteMarkers", + "locationName":"DeleteMarker" + }, + "Name":{"shape":"BucketName"}, + "Prefix":{"shape":"Prefix"}, + "Delimiter":{"shape":"Delimiter"}, + "MaxKeys":{"shape":"MaxKeys"}, + "CommonPrefixes":{"shape":"CommonPrefixList"}, + "EncodingType":{"shape":"EncodingType"} + } + }, + "ListObjectVersionsRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + }, + "Delimiter":{ + "shape":"Delimiter", + "location":"querystring", + "locationName":"delimiter" + }, + "EncodingType":{ + "shape":"EncodingType", + "location":"querystring", + "locationName":"encoding-type" + }, + "KeyMarker":{ + "shape":"KeyMarker", + "location":"querystring", + "locationName":"key-marker" + }, + "MaxKeys":{ + "shape":"MaxKeys", + "location":"querystring", + "locationName":"max-keys" + }, + "Prefix":{ + "shape":"Prefix", + "location":"querystring", + "locationName":"prefix" + }, + "VersionIdMarker":{ + "shape":"VersionIdMarker", + "location":"querystring", + "locationName":"version-id-marker" + } + } + }, + "ListObjectsOutput":{ + "type":"structure", + "members":{ + "IsTruncated":{"shape":"IsTruncated"}, + "Marker":{"shape":"Marker"}, + "NextMarker":{"shape":"NextMarker"}, + "Contents":{"shape":"ObjectList"}, + "Name":{"shape":"BucketName"}, + "Prefix":{"shape":"Prefix"}, + "Delimiter":{"shape":"Delimiter"}, + "MaxKeys":{"shape":"MaxKeys"}, + "CommonPrefixes":{"shape":"CommonPrefixList"}, + "EncodingType":{"shape":"EncodingType"} + } + }, + "ListObjectsRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + }, + "Delimiter":{ + "shape":"Delimiter", + "location":"querystring", + "locationName":"delimiter" + }, + "EncodingType":{ + "shape":"EncodingType", + "location":"querystring", + "locationName":"encoding-type" + }, + "Marker":{ + "shape":"Marker", + "location":"querystring", + "locationName":"marker" + }, + "MaxKeys":{ + "shape":"MaxKeys", + "location":"querystring", + "locationName":"max-keys" + }, + "Prefix":{ + "shape":"Prefix", + "location":"querystring", + "locationName":"prefix" + } + } + }, + "ListObjectsV2Output":{ + "type":"structure", + "members":{ + "IsTruncated":{"shape":"IsTruncated"}, + "Contents":{"shape":"ObjectList"}, + "Name":{"shape":"BucketName"}, + "Prefix":{"shape":"Prefix"}, + "Delimiter":{"shape":"Delimiter"}, + "MaxKeys":{"shape":"MaxKeys"}, + "CommonPrefixes":{"shape":"CommonPrefixList"}, + "EncodingType":{"shape":"EncodingType"}, + "KeyCount":{"shape":"KeyCount"}, + "ContinuationToken":{"shape":"Token"}, + "NextContinuationToken":{"shape":"NextToken"}, + "StartAfter":{"shape":"StartAfter"} + } + }, + "ListObjectsV2Request":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + }, + "Delimiter":{ + "shape":"Delimiter", + "location":"querystring", + "locationName":"delimiter" + }, + "EncodingType":{ + "shape":"EncodingType", + "location":"querystring", + "locationName":"encoding-type" + }, + "MaxKeys":{ + "shape":"MaxKeys", + "location":"querystring", + "locationName":"max-keys" + }, + "Prefix":{ + "shape":"Prefix", + "location":"querystring", + "locationName":"prefix" + }, + "ContinuationToken":{ + "shape":"Token", + "location":"querystring", + "locationName":"continuation-token" + }, + "FetchOwner":{ + "shape":"FetchOwner", + "location":"querystring", + "locationName":"fetch-owner" + }, + "StartAfter":{ + "shape":"StartAfter", + "location":"querystring", + "locationName":"start-after" + } + } + }, + "ListPartsOutput":{ + "type":"structure", + "members":{ + "AbortDate":{ + "shape":"AbortDate", + "location":"header", + "locationName":"x-amz-abort-date" + }, + "AbortRuleId":{ + "shape":"AbortRuleId", + "location":"header", + "locationName":"x-amz-abort-rule-id" + }, + "Bucket":{"shape":"BucketName"}, + "Key":{"shape":"ObjectKey"}, + "UploadId":{"shape":"MultipartUploadId"}, + "PartNumberMarker":{"shape":"PartNumberMarker"}, + "NextPartNumberMarker":{"shape":"NextPartNumberMarker"}, + "MaxParts":{"shape":"MaxParts"}, + "IsTruncated":{"shape":"IsTruncated"}, + "Parts":{ + "shape":"Parts", + "locationName":"Part" + }, + "Initiator":{"shape":"Initiator"}, + "Owner":{"shape":"Owner"}, + "StorageClass":{"shape":"StorageClass"}, + "RequestCharged":{ + "shape":"RequestCharged", + "location":"header", + "locationName":"x-amz-request-charged" + } + } + }, + "ListPartsRequest":{ + "type":"structure", + "required":[ + "Bucket", + "Key", + "UploadId" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + }, + "Key":{ + "shape":"ObjectKey", + "location":"uri", + "locationName":"Key" + }, + "MaxParts":{ + "shape":"MaxParts", + "location":"querystring", + "locationName":"max-parts" + }, + "PartNumberMarker":{ + "shape":"PartNumberMarker", + "location":"querystring", + "locationName":"part-number-marker" + }, + "UploadId":{ + "shape":"MultipartUploadId", + "location":"querystring", + "locationName":"uploadId" + }, + "RequestPayer":{ + "shape":"RequestPayer", + "location":"header", + "locationName":"x-amz-request-payer" + } + } + }, + "Location":{"type":"string"}, + "LoggingEnabled":{ + "type":"structure", + "members":{ + "TargetBucket":{"shape":"TargetBucket"}, + "TargetGrants":{"shape":"TargetGrants"}, + "TargetPrefix":{"shape":"TargetPrefix"} + } + }, + "MFA":{"type":"string"}, + "MFADelete":{ + "type":"string", + "enum":[ + "Enabled", + "Disabled" + ] + }, + "MFADeleteStatus":{ + "type":"string", + "enum":[ + "Enabled", + "Disabled" + ] + }, + "Marker":{"type":"string"}, + "MaxAgeSeconds":{"type":"integer"}, + "MaxKeys":{"type":"integer"}, + "MaxParts":{"type":"integer"}, + "MaxUploads":{"type":"integer"}, + "Message":{"type":"string"}, + "Metadata":{ + "type":"map", + "key":{"shape":"MetadataKey"}, + "value":{"shape":"MetadataValue"} + }, + "MetadataDirective":{ + "type":"string", + "enum":[ + "COPY", + "REPLACE" + ] + }, + "MetadataKey":{"type":"string"}, + "MetadataValue":{"type":"string"}, + "MissingMeta":{"type":"integer"}, + "MultipartUpload":{ + "type":"structure", + "members":{ + "UploadId":{"shape":"MultipartUploadId"}, + "Key":{"shape":"ObjectKey"}, + "Initiated":{"shape":"Initiated"}, + "StorageClass":{"shape":"StorageClass"}, + "Owner":{"shape":"Owner"}, + "Initiator":{"shape":"Initiator"} + } + }, + "MultipartUploadId":{"type":"string"}, + "MultipartUploadList":{ + "type":"list", + "member":{"shape":"MultipartUpload"}, + "flattened":true + }, + "NextKeyMarker":{"type":"string"}, + "NextMarker":{"type":"string"}, + "NextPartNumberMarker":{"type":"integer"}, + "NextToken":{"type":"string"}, + "NextUploadIdMarker":{"type":"string"}, + "NextVersionIdMarker":{"type":"string"}, + "NoSuchBucket":{ + "type":"structure", + "members":{ + }, + "exception":true + }, + "NoSuchKey":{ + "type":"structure", + "members":{ + }, + "exception":true + }, + "NoSuchUpload":{ + "type":"structure", + "members":{ + }, + "exception":true + }, + "NoncurrentVersionExpiration":{ + "type":"structure", + "members":{ + "NoncurrentDays":{"shape":"Days"} + } + }, + "NoncurrentVersionTransition":{ + "type":"structure", + "members":{ + "NoncurrentDays":{"shape":"Days"}, + "StorageClass":{"shape":"TransitionStorageClass"} + } + }, + "NoncurrentVersionTransitionList":{ + "type":"list", + "member":{"shape":"NoncurrentVersionTransition"}, + "flattened":true + }, + "NotificationConfiguration":{ + "type":"structure", + "members":{ + "TopicConfigurations":{ + "shape":"TopicConfigurationList", + "locationName":"TopicConfiguration" + }, + "QueueConfigurations":{ + "shape":"QueueConfigurationList", + "locationName":"QueueConfiguration" + }, + "LambdaFunctionConfigurations":{ + "shape":"LambdaFunctionConfigurationList", + "locationName":"CloudFunctionConfiguration" + } + } + }, + "NotificationConfigurationDeprecated":{ + "type":"structure", + "members":{ + "TopicConfiguration":{"shape":"TopicConfigurationDeprecated"}, + "QueueConfiguration":{"shape":"QueueConfigurationDeprecated"}, + "CloudFunctionConfiguration":{"shape":"CloudFunctionConfiguration"} + } + }, + "NotificationConfigurationFilter":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"S3KeyFilter", + "locationName":"S3Key" + } + } + }, + "NotificationId":{"type":"string"}, + "Object":{ + "type":"structure", + "members":{ + "Key":{"shape":"ObjectKey"}, + "LastModified":{"shape":"LastModified"}, + "ETag":{"shape":"ETag"}, + "Size":{"shape":"Size"}, + "StorageClass":{"shape":"ObjectStorageClass"}, + "Owner":{"shape":"Owner"} + } + }, + "ObjectAlreadyInActiveTierError":{ + "type":"structure", + "members":{ + }, + "exception":true + }, + "ObjectCannedACL":{ + "type":"string", + "enum":[ + "private", + "public-read", + "public-read-write", + "authenticated-read", + "aws-exec-read", + "bucket-owner-read", + "bucket-owner-full-control" + ] + }, + "ObjectIdentifier":{ + "type":"structure", + "required":["Key"], + "members":{ + "Key":{"shape":"ObjectKey"}, + "VersionId":{"shape":"ObjectVersionId"} + } + }, + "ObjectIdentifierList":{ + "type":"list", + "member":{"shape":"ObjectIdentifier"}, + "flattened":true + }, + "ObjectKey":{ + "type":"string", + "min":1 + }, + "ObjectList":{ + "type":"list", + "member":{"shape":"Object"}, + "flattened":true + }, + "ObjectNotInActiveTierError":{ + "type":"structure", + "members":{ + }, + "exception":true + }, + "ObjectStorageClass":{ + "type":"string", + "enum":[ + "STANDARD", + "REDUCED_REDUNDANCY", + "GLACIER" + ] + }, + "ObjectVersion":{ + "type":"structure", + "members":{ + "ETag":{"shape":"ETag"}, + "Size":{"shape":"Size"}, + "StorageClass":{"shape":"ObjectVersionStorageClass"}, + "Key":{"shape":"ObjectKey"}, + "VersionId":{"shape":"ObjectVersionId"}, + "IsLatest":{"shape":"IsLatest"}, + "LastModified":{"shape":"LastModified"}, + "Owner":{"shape":"Owner"} + } + }, + "ObjectVersionId":{"type":"string"}, + "ObjectVersionList":{ + "type":"list", + "member":{"shape":"ObjectVersion"}, + "flattened":true + }, + "ObjectVersionStorageClass":{ + "type":"string", + "enum":["STANDARD"] + }, + "Owner":{ + "type":"structure", + "members":{ + "DisplayName":{"shape":"DisplayName"}, + "ID":{"shape":"ID"} + } + }, + "Part":{ + "type":"structure", + "members":{ + "PartNumber":{"shape":"PartNumber"}, + "LastModified":{"shape":"LastModified"}, + "ETag":{"shape":"ETag"}, + "Size":{"shape":"Size"} + } + }, + "PartNumber":{"type":"integer"}, + "PartNumberMarker":{"type":"integer"}, + "Parts":{ + "type":"list", + "member":{"shape":"Part"}, + "flattened":true + }, + "Payer":{ + "type":"string", + "enum":[ + "Requester", + "BucketOwner" + ] + }, + "Permission":{ + "type":"string", + "enum":[ + "FULL_CONTROL", + "WRITE", + "WRITE_ACP", + "READ", + "READ_ACP" + ] + }, + "Policy":{"type":"string"}, + "Prefix":{"type":"string"}, + "Protocol":{ + "type":"string", + "enum":[ + "http", + "https" + ] + }, + "PutBucketAccelerateConfigurationRequest":{ + "type":"structure", + "required":[ + "Bucket", + "AccelerateConfiguration" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + }, + "AccelerateConfiguration":{ + "shape":"AccelerateConfiguration", + "locationName":"AccelerateConfiguration", + "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} + } + }, + "payload":"AccelerateConfiguration" + }, + "PutBucketAclRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "ACL":{ + "shape":"BucketCannedACL", + "location":"header", + "locationName":"x-amz-acl" + }, + "AccessControlPolicy":{ + "shape":"AccessControlPolicy", + "locationName":"AccessControlPolicy", + "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} + }, + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + }, + "ContentMD5":{ + "shape":"ContentMD5", + "location":"header", + "locationName":"Content-MD5" + }, + "GrantFullControl":{ + "shape":"GrantFullControl", + "location":"header", + "locationName":"x-amz-grant-full-control" + }, + "GrantRead":{ + "shape":"GrantRead", + "location":"header", + "locationName":"x-amz-grant-read" + }, + "GrantReadACP":{ + "shape":"GrantReadACP", + "location":"header", + "locationName":"x-amz-grant-read-acp" + }, + "GrantWrite":{ + "shape":"GrantWrite", + "location":"header", + "locationName":"x-amz-grant-write" + }, + "GrantWriteACP":{ + "shape":"GrantWriteACP", + "location":"header", + "locationName":"x-amz-grant-write-acp" + } + }, + "payload":"AccessControlPolicy" + }, + "PutBucketCorsRequest":{ + "type":"structure", + "required":[ + "Bucket", + "CORSConfiguration" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + }, + "CORSConfiguration":{ + "shape":"CORSConfiguration", + "locationName":"CORSConfiguration", + "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} + }, + "ContentMD5":{ + "shape":"ContentMD5", + "location":"header", + "locationName":"Content-MD5" + } + }, + "payload":"CORSConfiguration" + }, + "PutBucketLifecycleConfigurationRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + }, + "LifecycleConfiguration":{ + "shape":"BucketLifecycleConfiguration", + "locationName":"LifecycleConfiguration", + "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} + } + }, + "payload":"LifecycleConfiguration" + }, + "PutBucketLifecycleRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + }, + "ContentMD5":{ + "shape":"ContentMD5", + "location":"header", + "locationName":"Content-MD5" + }, + "LifecycleConfiguration":{ + "shape":"LifecycleConfiguration", + "locationName":"LifecycleConfiguration", + "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} + } + }, + "payload":"LifecycleConfiguration" + }, + "PutBucketLoggingRequest":{ + "type":"structure", + "required":[ + "Bucket", + "BucketLoggingStatus" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + }, + "BucketLoggingStatus":{ + "shape":"BucketLoggingStatus", + "locationName":"BucketLoggingStatus", + "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} + }, + "ContentMD5":{ + "shape":"ContentMD5", + "location":"header", + "locationName":"Content-MD5" + } + }, + "payload":"BucketLoggingStatus" + }, + "PutBucketNotificationConfigurationRequest":{ + "type":"structure", + "required":[ + "Bucket", + "NotificationConfiguration" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + }, + "NotificationConfiguration":{ + "shape":"NotificationConfiguration", + "locationName":"NotificationConfiguration", + "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} + } + }, + "payload":"NotificationConfiguration" + }, + "PutBucketNotificationRequest":{ + "type":"structure", + "required":[ + "Bucket", + "NotificationConfiguration" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + }, + "ContentMD5":{ + "shape":"ContentMD5", + "location":"header", + "locationName":"Content-MD5" + }, + "NotificationConfiguration":{ + "shape":"NotificationConfigurationDeprecated", + "locationName":"NotificationConfiguration", + "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} + } + }, + "payload":"NotificationConfiguration" + }, + "PutBucketPolicyRequest":{ + "type":"structure", + "required":[ + "Bucket", + "Policy" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + }, + "ContentMD5":{ + "shape":"ContentMD5", + "location":"header", + "locationName":"Content-MD5" + }, + "Policy":{"shape":"Policy"} + }, + "payload":"Policy" + }, + "PutBucketReplicationRequest":{ + "type":"structure", + "required":[ + "Bucket", + "ReplicationConfiguration" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + }, + "ContentMD5":{ + "shape":"ContentMD5", + "location":"header", + "locationName":"Content-MD5" + }, + "ReplicationConfiguration":{ + "shape":"ReplicationConfiguration", + "locationName":"ReplicationConfiguration", + "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} + } + }, + "payload":"ReplicationConfiguration" + }, + "PutBucketRequestPaymentRequest":{ + "type":"structure", + "required":[ + "Bucket", + "RequestPaymentConfiguration" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + }, + "ContentMD5":{ + "shape":"ContentMD5", + "location":"header", + "locationName":"Content-MD5" + }, + "RequestPaymentConfiguration":{ + "shape":"RequestPaymentConfiguration", + "locationName":"RequestPaymentConfiguration", + "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} + } + }, + "payload":"RequestPaymentConfiguration" + }, + "PutBucketTaggingRequest":{ + "type":"structure", + "required":[ + "Bucket", + "Tagging" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + }, + "ContentMD5":{ + "shape":"ContentMD5", + "location":"header", + "locationName":"Content-MD5" + }, + "Tagging":{ + "shape":"Tagging", + "locationName":"Tagging", + "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} + } + }, + "payload":"Tagging" + }, + "PutBucketVersioningRequest":{ + "type":"structure", + "required":[ + "Bucket", + "VersioningConfiguration" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + }, + "ContentMD5":{ + "shape":"ContentMD5", + "location":"header", + "locationName":"Content-MD5" + }, + "MFA":{ + "shape":"MFA", + "location":"header", + "locationName":"x-amz-mfa" + }, + "VersioningConfiguration":{ + "shape":"VersioningConfiguration", + "locationName":"VersioningConfiguration", + "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} + } + }, + "payload":"VersioningConfiguration" + }, + "PutBucketWebsiteRequest":{ + "type":"structure", + "required":[ + "Bucket", + "WebsiteConfiguration" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + }, + "ContentMD5":{ + "shape":"ContentMD5", + "location":"header", + "locationName":"Content-MD5" + }, + "WebsiteConfiguration":{ + "shape":"WebsiteConfiguration", + "locationName":"WebsiteConfiguration", + "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} + } + }, + "payload":"WebsiteConfiguration" + }, + "PutObjectAclOutput":{ + "type":"structure", + "members":{ + "RequestCharged":{ + "shape":"RequestCharged", + "location":"header", + "locationName":"x-amz-request-charged" + } + } + }, + "PutObjectAclRequest":{ + "type":"structure", + "required":[ + "Bucket", + "Key" + ], + "members":{ + "ACL":{ + "shape":"ObjectCannedACL", + "location":"header", + "locationName":"x-amz-acl" + }, + "AccessControlPolicy":{ + "shape":"AccessControlPolicy", + "locationName":"AccessControlPolicy", + "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} + }, + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + }, + "ContentMD5":{ + "shape":"ContentMD5", + "location":"header", + "locationName":"Content-MD5" + }, + "GrantFullControl":{ + "shape":"GrantFullControl", + "location":"header", + "locationName":"x-amz-grant-full-control" + }, + "GrantRead":{ + "shape":"GrantRead", + "location":"header", + "locationName":"x-amz-grant-read" + }, + "GrantReadACP":{ + "shape":"GrantReadACP", + "location":"header", + "locationName":"x-amz-grant-read-acp" + }, + "GrantWrite":{ + "shape":"GrantWrite", + "location":"header", + "locationName":"x-amz-grant-write" + }, + "GrantWriteACP":{ + "shape":"GrantWriteACP", + "location":"header", + "locationName":"x-amz-grant-write-acp" + }, + "Key":{ + "shape":"ObjectKey", + "location":"uri", + "locationName":"Key" + }, + "RequestPayer":{ + "shape":"RequestPayer", + "location":"header", + "locationName":"x-amz-request-payer" + }, + "VersionId":{ + "shape":"ObjectVersionId", + "location":"querystring", + "locationName":"versionId" + } + }, + "payload":"AccessControlPolicy" + }, + "PutObjectOutput":{ + "type":"structure", + "members":{ + "Expiration":{ + "shape":"Expiration", + "location":"header", + "locationName":"x-amz-expiration" + }, + "ETag":{ + "shape":"ETag", + "location":"header", + "locationName":"ETag" + }, + "ServerSideEncryption":{ + "shape":"ServerSideEncryption", + "location":"header", + "locationName":"x-amz-server-side-encryption" + }, + "VersionId":{ + "shape":"ObjectVersionId", + "location":"header", + "locationName":"x-amz-version-id" + }, + "SSECustomerAlgorithm":{ + "shape":"SSECustomerAlgorithm", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-algorithm" + }, + "SSECustomerKeyMD5":{ + "shape":"SSECustomerKeyMD5", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-key-MD5" + }, + "SSEKMSKeyId":{ + "shape":"SSEKMSKeyId", + "location":"header", + "locationName":"x-amz-server-side-encryption-aws-kms-key-id" + }, + "RequestCharged":{ + "shape":"RequestCharged", + "location":"header", + "locationName":"x-amz-request-charged" + } + } + }, + "PutObjectRequest":{ + "type":"structure", + "required":[ + "Bucket", + "Key" + ], + "members":{ + "ACL":{ + "shape":"ObjectCannedACL", + "location":"header", + "locationName":"x-amz-acl" + }, + "Body":{ + "shape":"Body", + "streaming":true + }, + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + }, + "CacheControl":{ + "shape":"CacheControl", + "location":"header", + "locationName":"Cache-Control" + }, + "ContentDisposition":{ + "shape":"ContentDisposition", + "location":"header", + "locationName":"Content-Disposition" + }, + "ContentEncoding":{ + "shape":"ContentEncoding", + "location":"header", + "locationName":"Content-Encoding" + }, + "ContentLanguage":{ + "shape":"ContentLanguage", + "location":"header", + "locationName":"Content-Language" + }, + "ContentLength":{ + "shape":"ContentLength", + "location":"header", + "locationName":"Content-Length" + }, + "ContentMD5":{ + "shape":"ContentMD5", + "location":"header", + "locationName":"Content-MD5" + }, + "ContentType":{ + "shape":"ContentType", + "location":"header", + "locationName":"Content-Type" + }, + "Expires":{ + "shape":"Expires", + "location":"header", + "locationName":"Expires" + }, + "GrantFullControl":{ + "shape":"GrantFullControl", + "location":"header", + "locationName":"x-amz-grant-full-control" + }, + "GrantRead":{ + "shape":"GrantRead", + "location":"header", + "locationName":"x-amz-grant-read" + }, + "GrantReadACP":{ + "shape":"GrantReadACP", + "location":"header", + "locationName":"x-amz-grant-read-acp" + }, + "GrantWriteACP":{ + "shape":"GrantWriteACP", + "location":"header", + "locationName":"x-amz-grant-write-acp" + }, + "Key":{ + "shape":"ObjectKey", + "location":"uri", + "locationName":"Key" + }, + "Metadata":{ + "shape":"Metadata", + "location":"headers", + "locationName":"x-amz-meta-" + }, + "ServerSideEncryption":{ + "shape":"ServerSideEncryption", + "location":"header", + "locationName":"x-amz-server-side-encryption" + }, + "StorageClass":{ + "shape":"StorageClass", + "location":"header", + "locationName":"x-amz-storage-class" + }, + "WebsiteRedirectLocation":{ + "shape":"WebsiteRedirectLocation", + "location":"header", + "locationName":"x-amz-website-redirect-location" + }, + "SSECustomerAlgorithm":{ + "shape":"SSECustomerAlgorithm", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-algorithm" + }, + "SSECustomerKey":{ + "shape":"SSECustomerKey", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-key" + }, + "SSECustomerKeyMD5":{ + "shape":"SSECustomerKeyMD5", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-key-MD5" + }, + "SSEKMSKeyId":{ + "shape":"SSEKMSKeyId", + "location":"header", + "locationName":"x-amz-server-side-encryption-aws-kms-key-id" + }, + "RequestPayer":{ + "shape":"RequestPayer", + "location":"header", + "locationName":"x-amz-request-payer" + } + }, + "payload":"Body" + }, + "QueueArn":{"type":"string"}, + "QueueConfiguration":{ + "type":"structure", + "required":[ + "QueueArn", + "Events" + ], + "members":{ + "Id":{"shape":"NotificationId"}, + "QueueArn":{ + "shape":"QueueArn", + "locationName":"Queue" + }, + "Events":{ + "shape":"EventList", + "locationName":"Event" + }, + "Filter":{"shape":"NotificationConfigurationFilter"} + } + }, + "QueueConfigurationDeprecated":{ + "type":"structure", + "members":{ + "Id":{"shape":"NotificationId"}, + "Event":{ + "shape":"Event", + "deprecated":true + }, + "Events":{ + "shape":"EventList", + "locationName":"Event" + }, + "Queue":{"shape":"QueueArn"} + } + }, + "QueueConfigurationList":{ + "type":"list", + "member":{"shape":"QueueConfiguration"}, + "flattened":true + }, + "Quiet":{"type":"boolean"}, + "Range":{"type":"string"}, + "Redirect":{ + "type":"structure", + "members":{ + "HostName":{"shape":"HostName"}, + "HttpRedirectCode":{"shape":"HttpRedirectCode"}, + "Protocol":{"shape":"Protocol"}, + "ReplaceKeyPrefixWith":{"shape":"ReplaceKeyPrefixWith"}, + "ReplaceKeyWith":{"shape":"ReplaceKeyWith"} + } + }, + "RedirectAllRequestsTo":{ + "type":"structure", + "required":["HostName"], + "members":{ + "HostName":{"shape":"HostName"}, + "Protocol":{"shape":"Protocol"} + } + }, + "ReplaceKeyPrefixWith":{"type":"string"}, + "ReplaceKeyWith":{"type":"string"}, + "ReplicationConfiguration":{ + "type":"structure", + "required":[ + "Role", + "Rules" + ], + "members":{ + "Role":{"shape":"Role"}, + "Rules":{ + "shape":"ReplicationRules", + "locationName":"Rule" + } + } + }, + "ReplicationRule":{ + "type":"structure", + "required":[ + "Prefix", + "Status", + "Destination" + ], + "members":{ + "ID":{"shape":"ID"}, + "Prefix":{"shape":"Prefix"}, + "Status":{"shape":"ReplicationRuleStatus"}, + "Destination":{"shape":"Destination"} + } + }, + "ReplicationRuleStatus":{ + "type":"string", + "enum":[ + "Enabled", + "Disabled" + ] + }, + "ReplicationRules":{ + "type":"list", + "member":{"shape":"ReplicationRule"}, + "flattened":true + }, + "ReplicationStatus":{ + "type":"string", + "enum":[ + "COMPLETE", + "PENDING", + "FAILED", + "REPLICA" + ] + }, + "RequestCharged":{ + "type":"string", + "enum":["requester"] + }, + "RequestPayer":{ + "type":"string", + "enum":["requester"] + }, + "RequestPaymentConfiguration":{ + "type":"structure", + "required":["Payer"], + "members":{ + "Payer":{"shape":"Payer"} + } + }, + "ResponseCacheControl":{"type":"string"}, + "ResponseContentDisposition":{"type":"string"}, + "ResponseContentEncoding":{"type":"string"}, + "ResponseContentLanguage":{"type":"string"}, + "ResponseContentType":{"type":"string"}, + "ResponseExpires":{"type":"timestamp"}, + "Restore":{"type":"string"}, + "RestoreObjectOutput":{ + "type":"structure", + "members":{ + "RequestCharged":{ + "shape":"RequestCharged", + "location":"header", + "locationName":"x-amz-request-charged" + } + } + }, + "RestoreObjectRequest":{ + "type":"structure", + "required":[ + "Bucket", + "Key" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + }, + "Key":{ + "shape":"ObjectKey", + "location":"uri", + "locationName":"Key" + }, + "VersionId":{ + "shape":"ObjectVersionId", + "location":"querystring", + "locationName":"versionId" + }, + "RestoreRequest":{ + "shape":"RestoreRequest", + "locationName":"RestoreRequest", + "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} + }, + "RequestPayer":{ + "shape":"RequestPayer", + "location":"header", + "locationName":"x-amz-request-payer" + } + }, + "payload":"RestoreRequest" + }, + "RestoreRequest":{ + "type":"structure", + "required":["Days"], + "members":{ + "Days":{"shape":"Days"} + } + }, + "Role":{"type":"string"}, + "RoutingRule":{ + "type":"structure", + "required":["Redirect"], + "members":{ + "Condition":{"shape":"Condition"}, + "Redirect":{"shape":"Redirect"} + } + }, + "RoutingRules":{ + "type":"list", + "member":{ + "shape":"RoutingRule", + "locationName":"RoutingRule" + } + }, + "Rule":{ + "type":"structure", + "required":[ + "Prefix", + "Status" + ], + "members":{ + "Expiration":{"shape":"LifecycleExpiration"}, + "ID":{"shape":"ID"}, + "Prefix":{"shape":"Prefix"}, + "Status":{"shape":"ExpirationStatus"}, + "Transition":{"shape":"Transition"}, + "NoncurrentVersionTransition":{"shape":"NoncurrentVersionTransition"}, + "NoncurrentVersionExpiration":{"shape":"NoncurrentVersionExpiration"}, + "AbortIncompleteMultipartUpload":{"shape":"AbortIncompleteMultipartUpload"} + } + }, + "Rules":{ + "type":"list", + "member":{"shape":"Rule"}, + "flattened":true + }, + "S3KeyFilter":{ + "type":"structure", + "members":{ + "FilterRules":{ + "shape":"FilterRuleList", + "locationName":"FilterRule" + } + } + }, + "SSECustomerAlgorithm":{"type":"string"}, + "SSECustomerKey":{ + "type":"string", + "sensitive":true + }, + "SSECustomerKeyMD5":{"type":"string"}, + "SSEKMSKeyId":{ + "type":"string", + "sensitive":true + }, + "ServerSideEncryption":{ + "type":"string", + "enum":[ + "AES256", + "aws:kms" + ] + }, + "Size":{"type":"integer"}, + "StartAfter":{"type":"string"}, + "StorageClass":{ + "type":"string", + "enum":[ + "STANDARD", + "REDUCED_REDUNDANCY", + "STANDARD_IA" + ] + }, + "Suffix":{"type":"string"}, + "Tag":{ + "type":"structure", + "required":[ + "Key", + "Value" + ], + "members":{ + "Key":{"shape":"ObjectKey"}, + "Value":{"shape":"Value"} + } + }, + "TagSet":{ + "type":"list", + "member":{ + "shape":"Tag", + "locationName":"Tag" + } + }, + "Tagging":{ + "type":"structure", + "required":["TagSet"], + "members":{ + "TagSet":{"shape":"TagSet"} + } + }, + "TargetBucket":{"type":"string"}, + "TargetGrant":{ + "type":"structure", + "members":{ + "Grantee":{"shape":"Grantee"}, + "Permission":{"shape":"BucketLogsPermission"} + } + }, + "TargetGrants":{ + "type":"list", + "member":{ + "shape":"TargetGrant", + "locationName":"Grant" + } + }, + "TargetPrefix":{"type":"string"}, + "Token":{"type":"string"}, + "TopicArn":{"type":"string"}, + "TopicConfiguration":{ + "type":"structure", + "required":[ + "TopicArn", + "Events" + ], + "members":{ + "Id":{"shape":"NotificationId"}, + "TopicArn":{ + "shape":"TopicArn", + "locationName":"Topic" + }, + "Events":{ + "shape":"EventList", + "locationName":"Event" + }, + "Filter":{"shape":"NotificationConfigurationFilter"} + } + }, + "TopicConfigurationDeprecated":{ + "type":"structure", + "members":{ + "Id":{"shape":"NotificationId"}, + "Events":{ + "shape":"EventList", + "locationName":"Event" + }, + "Event":{ + "shape":"Event", + "deprecated":true + }, + "Topic":{"shape":"TopicArn"} + } + }, + "TopicConfigurationList":{ + "type":"list", + "member":{"shape":"TopicConfiguration"}, + "flattened":true + }, + "Transition":{ + "type":"structure", + "members":{ + "Date":{"shape":"Date"}, + "Days":{"shape":"Days"}, + "StorageClass":{"shape":"TransitionStorageClass"} + } + }, + "TransitionList":{ + "type":"list", + "member":{"shape":"Transition"}, + "flattened":true + }, + "TransitionStorageClass":{ + "type":"string", + "enum":[ + "GLACIER", + "STANDARD_IA" + ] + }, + "Type":{ + "type":"string", + "enum":[ + "CanonicalUser", + "AmazonCustomerByEmail", + "Group" + ] + }, + "URI":{"type":"string"}, + "UploadIdMarker":{"type":"string"}, + "UploadPartCopyOutput":{ + "type":"structure", + "members":{ + "CopySourceVersionId":{ + "shape":"CopySourceVersionId", + "location":"header", + "locationName":"x-amz-copy-source-version-id" + }, + "CopyPartResult":{"shape":"CopyPartResult"}, + "ServerSideEncryption":{ + "shape":"ServerSideEncryption", + "location":"header", + "locationName":"x-amz-server-side-encryption" + }, + "SSECustomerAlgorithm":{ + "shape":"SSECustomerAlgorithm", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-algorithm" + }, + "SSECustomerKeyMD5":{ + "shape":"SSECustomerKeyMD5", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-key-MD5" + }, + "SSEKMSKeyId":{ + "shape":"SSEKMSKeyId", + "location":"header", + "locationName":"x-amz-server-side-encryption-aws-kms-key-id" + }, + "RequestCharged":{ + "shape":"RequestCharged", + "location":"header", + "locationName":"x-amz-request-charged" + } + }, + "payload":"CopyPartResult" + }, + "UploadPartCopyRequest":{ + "type":"structure", + "required":[ + "Bucket", + "CopySource", + "Key", + "PartNumber", + "UploadId" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + }, + "CopySource":{ + "shape":"CopySource", + "location":"header", + "locationName":"x-amz-copy-source" + }, + "CopySourceIfMatch":{ + "shape":"CopySourceIfMatch", + "location":"header", + "locationName":"x-amz-copy-source-if-match" + }, + "CopySourceIfModifiedSince":{ + "shape":"CopySourceIfModifiedSince", + "location":"header", + "locationName":"x-amz-copy-source-if-modified-since" + }, + "CopySourceIfNoneMatch":{ + "shape":"CopySourceIfNoneMatch", + "location":"header", + "locationName":"x-amz-copy-source-if-none-match" + }, + "CopySourceIfUnmodifiedSince":{ + "shape":"CopySourceIfUnmodifiedSince", + "location":"header", + "locationName":"x-amz-copy-source-if-unmodified-since" + }, + "CopySourceRange":{ + "shape":"CopySourceRange", + "location":"header", + "locationName":"x-amz-copy-source-range" + }, + "Key":{ + "shape":"ObjectKey", + "location":"uri", + "locationName":"Key" + }, + "PartNumber":{ + "shape":"PartNumber", + "location":"querystring", + "locationName":"partNumber" + }, + "UploadId":{ + "shape":"MultipartUploadId", + "location":"querystring", + "locationName":"uploadId" + }, + "SSECustomerAlgorithm":{ + "shape":"SSECustomerAlgorithm", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-algorithm" + }, + "SSECustomerKey":{ + "shape":"SSECustomerKey", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-key" + }, + "SSECustomerKeyMD5":{ + "shape":"SSECustomerKeyMD5", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-key-MD5" + }, + "CopySourceSSECustomerAlgorithm":{ + "shape":"CopySourceSSECustomerAlgorithm", + "location":"header", + "locationName":"x-amz-copy-source-server-side-encryption-customer-algorithm" + }, + "CopySourceSSECustomerKey":{ + "shape":"CopySourceSSECustomerKey", + "location":"header", + "locationName":"x-amz-copy-source-server-side-encryption-customer-key" + }, + "CopySourceSSECustomerKeyMD5":{ + "shape":"CopySourceSSECustomerKeyMD5", + "location":"header", + "locationName":"x-amz-copy-source-server-side-encryption-customer-key-MD5" + }, + "RequestPayer":{ + "shape":"RequestPayer", + "location":"header", + "locationName":"x-amz-request-payer" + } + } + }, + "UploadPartOutput":{ + "type":"structure", + "members":{ + "ServerSideEncryption":{ + "shape":"ServerSideEncryption", + "location":"header", + "locationName":"x-amz-server-side-encryption" + }, + "ETag":{ + "shape":"ETag", + "location":"header", + "locationName":"ETag" + }, + "SSECustomerAlgorithm":{ + "shape":"SSECustomerAlgorithm", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-algorithm" + }, + "SSECustomerKeyMD5":{ + "shape":"SSECustomerKeyMD5", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-key-MD5" + }, + "SSEKMSKeyId":{ + "shape":"SSEKMSKeyId", + "location":"header", + "locationName":"x-amz-server-side-encryption-aws-kms-key-id" + }, + "RequestCharged":{ + "shape":"RequestCharged", + "location":"header", + "locationName":"x-amz-request-charged" + } + } + }, + "UploadPartRequest":{ + "type":"structure", + "required":[ + "Bucket", + "Key", + "PartNumber", + "UploadId" + ], + "members":{ + "Body":{ + "shape":"Body", + "streaming":true + }, + "Bucket":{ + "shape":"BucketName", + "location":"uri", + "locationName":"Bucket" + }, + "ContentLength":{ + "shape":"ContentLength", + "location":"header", + "locationName":"Content-Length" + }, + "ContentMD5":{ + "shape":"ContentMD5", + "location":"header", + "locationName":"Content-MD5" + }, + "Key":{ + "shape":"ObjectKey", + "location":"uri", + "locationName":"Key" + }, + "PartNumber":{ + "shape":"PartNumber", + "location":"querystring", + "locationName":"partNumber" + }, + "UploadId":{ + "shape":"MultipartUploadId", + "location":"querystring", + "locationName":"uploadId" + }, + "SSECustomerAlgorithm":{ + "shape":"SSECustomerAlgorithm", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-algorithm" + }, + "SSECustomerKey":{ + "shape":"SSECustomerKey", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-key" + }, + "SSECustomerKeyMD5":{ + "shape":"SSECustomerKeyMD5", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-key-MD5" + }, + "RequestPayer":{ + "shape":"RequestPayer", + "location":"header", + "locationName":"x-amz-request-payer" + } + }, + "payload":"Body" + }, + "Value":{"type":"string"}, + "VersionIdMarker":{"type":"string"}, + "VersioningConfiguration":{ + "type":"structure", + "members":{ + "MFADelete":{ + "shape":"MFADelete", + "locationName":"MfaDelete" + }, + "Status":{"shape":"BucketVersioningStatus"} + } + }, + "WebsiteConfiguration":{ + "type":"structure", + "members":{ + "ErrorDocument":{"shape":"ErrorDocument"}, + "IndexDocument":{"shape":"IndexDocument"}, + "RedirectAllRequestsTo":{"shape":"RedirectAllRequestsTo"}, + "RoutingRules":{"shape":"RoutingRules"} + } + }, + "WebsiteRedirectLocation":{"type":"string"} + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/s3/2006-03-01/docs-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/s3/2006-03-01/docs-2.json new file mode 100644 index 000000000..5aa6c5cdb --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/s3/2006-03-01/docs-2.json @@ -0,0 +1,2445 @@ +{ + "version": "2.0", + "service": null, + "operations": { + "AbortMultipartUpload": "Aborts a multipart upload.
To verify that all parts have been removed, so you don't get charged for the part storage, you should call the List Parts operation and ensure the parts list is empty.
", + "CompleteMultipartUpload": "Completes a multipart upload by assembling previously uploaded parts.", + "CopyObject": "Creates a copy of an object that is already stored in Amazon S3.", + "CreateBucket": "Creates a new bucket.", + "CreateMultipartUpload": "Initiates a multipart upload and returns an upload ID.
Note: After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage.
", + "DeleteBucket": "Deletes the bucket. All objects (including all object versions and Delete Markers) in the bucket must be deleted before the bucket itself can be deleted.", + "DeleteBucketCors": "Deletes the cors configuration information set for the bucket.", + "DeleteBucketLifecycle": "Deletes the lifecycle configuration from the bucket.", + "DeleteBucketPolicy": "Deletes the policy from the bucket.", + "DeleteBucketReplication": "Deletes the replication configuration from the bucket.", + "DeleteBucketTagging": "Deletes the tags from the bucket.", + "DeleteBucketWebsite": "This operation removes the website configuration from the bucket.", + "DeleteObject": "Removes the null version (if there is one) of an object and inserts a delete marker, which becomes the latest version of the object. If there isn't a null version, Amazon S3 does not remove any objects.", + "DeleteObjects": "This operation enables you to delete multiple objects from a bucket using a single HTTP request. You may specify up to 1000 keys.", + "GetBucketAccelerateConfiguration": "Returns the accelerate configuration of a bucket.", + "GetBucketAcl": "Gets the access control policy for the bucket.", + "GetBucketCors": "Returns the cors configuration for the bucket.", + "GetBucketLifecycle": "Deprecated, see the GetBucketLifecycleConfiguration operation.", + "GetBucketLifecycleConfiguration": "Returns the lifecycle configuration information set on the bucket.", + "GetBucketLocation": "Returns the region the bucket resides in.", + "GetBucketLogging": "Returns the logging status of a bucket and the permissions users have to view and modify that status. To use GET, you must be the bucket owner.", + "GetBucketNotification": "Deprecated, see the GetBucketNotificationConfiguration operation.", + "GetBucketNotificationConfiguration": "Returns the notification configuration of a bucket.", + "GetBucketPolicy": "Returns the policy of a specified bucket.", + "GetBucketReplication": "Deprecated, see the GetBucketReplicationConfiguration operation.", + "GetBucketRequestPayment": "Returns the request payment configuration of a bucket.", + "GetBucketTagging": "Returns the tag set associated with the bucket.", + "GetBucketVersioning": "Returns the versioning state of a bucket.", + "GetBucketWebsite": "Returns the website configuration for a bucket.", + "GetObject": "Retrieves objects from Amazon S3.", + "GetObjectAcl": "Returns the access control list (ACL) of an object.", + "GetObjectTorrent": "Return torrent files from a bucket.", + "HeadBucket": "This operation is useful to determine if a bucket exists and you have permission to access it.", + "HeadObject": "The HEAD operation retrieves metadata from an object without returning the object itself. This operation is useful if you're only interested in an object's metadata. To use HEAD, you must have READ access to the object.", + "ListBuckets": "Returns a list of all buckets owned by the authenticated sender of the request.", + "ListMultipartUploads": "This operation lists in-progress multipart uploads.", + "ListObjectVersions": "Returns metadata about all of the versions of objects in a bucket.", + "ListObjects": "Returns some or all (up to 1000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket.", + "ListObjectsV2": "Returns some or all (up to 1000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. Note: ListObjectsV2 is the revised List Objects API and we recommend you use this revised API for new application development.", + "ListParts": "Lists the parts that have been uploaded for a specific multipart upload.", + "PutBucketAccelerateConfiguration": "Sets the accelerate configuration of an existing bucket.", + "PutBucketAcl": "Sets the permissions on a bucket using access control lists (ACL).", + "PutBucketCors": "Sets the cors configuration for a bucket.", + "PutBucketLifecycle": "Deprecated, see the PutBucketLifecycleConfiguration operation.", + "PutBucketLifecycleConfiguration": "Sets lifecycle configuration for your bucket. If a lifecycle configuration exists, it replaces it.", + "PutBucketLogging": "Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters. To set the logging status of a bucket, you must be the bucket owner.", + "PutBucketNotification": "Deprecated, see the PutBucketNotificationConfiguraiton operation.", + "PutBucketNotificationConfiguration": "Enables notifications of specified events for a bucket.", + "PutBucketPolicy": "Replaces a policy on a bucket. If the bucket already has a policy, the one in this request completely replaces it.", + "PutBucketReplication": "Creates a new replication configuration (or replaces an existing one, if present).", + "PutBucketRequestPayment": "Sets the request payment configuration for a bucket. By default, the bucket owner pays for downloads from the bucket. This configuration parameter enables the bucket owner (only) to specify that the person requesting the download will be charged for the download. Documentation on requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html", + "PutBucketTagging": "Sets the tags for a bucket.", + "PutBucketVersioning": "Sets the versioning state of an existing bucket. To set the versioning state, you must be the bucket owner.", + "PutBucketWebsite": "Set the website configuration for a bucket.", + "PutObject": "Adds an object to a bucket.", + "PutObjectAcl": "uses the acl subresource to set the access control list (ACL) permissions for an object that already exists in a bucket", + "RestoreObject": "Restores an archived copy of an object back into Amazon S3", + "UploadPart": "Uploads a part in a multipart upload.
Note: After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage.
", + "UploadPartCopy": "Uploads a part by copying data from an existing object as data source." + }, + "shapes": { + "AbortDate": { + "base": null, + "refs": { + "CreateMultipartUploadOutput$AbortDate": "Date when multipart upload will become eligible for abort operation by lifecycle.", + "ListPartsOutput$AbortDate": "Date when multipart upload will become eligible for abort operation by lifecycle." + } + }, + "AbortIncompleteMultipartUpload": { + "base": "Specifies the days since the initiation of an Incomplete Multipart Upload that Lifecycle will wait before permanently removing all parts of the upload.", + "refs": { + "LifecycleRule$AbortIncompleteMultipartUpload": null, + "Rule$AbortIncompleteMultipartUpload": null + } + }, + "AbortMultipartUploadOutput": { + "base": null, + "refs": { + } + }, + "AbortMultipartUploadRequest": { + "base": null, + "refs": { + } + }, + "AbortRuleId": { + "base": null, + "refs": { + "CreateMultipartUploadOutput$AbortRuleId": "Id of the lifecycle rule that makes a multipart upload eligible for abort operation.", + "ListPartsOutput$AbortRuleId": "Id of the lifecycle rule that makes a multipart upload eligible for abort operation." + } + }, + "AccelerateConfiguration": { + "base": null, + "refs": { + "PutBucketAccelerateConfigurationRequest$AccelerateConfiguration": "Specifies the Accelerate Configuration you want to set for the bucket." + } + }, + "AcceptRanges": { + "base": null, + "refs": { + "GetObjectOutput$AcceptRanges": null, + "HeadObjectOutput$AcceptRanges": null + } + }, + "AccessControlPolicy": { + "base": null, + "refs": { + "PutBucketAclRequest$AccessControlPolicy": null, + "PutObjectAclRequest$AccessControlPolicy": null + } + }, + "AllowedHeader": { + "base": null, + "refs": { + "AllowedHeaders$member": null + } + }, + "AllowedHeaders": { + "base": null, + "refs": { + "CORSRule$AllowedHeaders": "Specifies which headers are allowed in a pre-flight OPTIONS request." + } + }, + "AllowedMethod": { + "base": null, + "refs": { + "AllowedMethods$member": null + } + }, + "AllowedMethods": { + "base": null, + "refs": { + "CORSRule$AllowedMethods": "Identifies HTTP methods that the domain/origin specified in the rule is allowed to execute." + } + }, + "AllowedOrigin": { + "base": null, + "refs": { + "AllowedOrigins$member": null + } + }, + "AllowedOrigins": { + "base": null, + "refs": { + "CORSRule$AllowedOrigins": "One or more origins you want customers to be able to access the bucket from." + } + }, + "Body": { + "base": null, + "refs": { + "GetObjectOutput$Body": "Object data.", + "GetObjectTorrentOutput$Body": null, + "PutObjectRequest$Body": "Object data.", + "UploadPartRequest$Body": "Object data." + } + }, + "Bucket": { + "base": null, + "refs": { + "Buckets$member": null + } + }, + "BucketAccelerateStatus": { + "base": null, + "refs": { + "AccelerateConfiguration$Status": "The accelerate configuration of the bucket.", + "GetBucketAccelerateConfigurationOutput$Status": "The accelerate configuration of the bucket." + } + }, + "BucketAlreadyExists": { + "base": "The requested bucket name is not available. The bucket namespace is shared by all users of the system. Please select a different name and try again.", + "refs": { + } + }, + "BucketAlreadyOwnedByYou": { + "base": null, + "refs": { + } + }, + "BucketCannedACL": { + "base": null, + "refs": { + "CreateBucketRequest$ACL": "The canned ACL to apply to the bucket.", + "PutBucketAclRequest$ACL": "The canned ACL to apply to the bucket." + } + }, + "BucketLifecycleConfiguration": { + "base": null, + "refs": { + "PutBucketLifecycleConfigurationRequest$LifecycleConfiguration": null + } + }, + "BucketLocationConstraint": { + "base": null, + "refs": { + "CreateBucketConfiguration$LocationConstraint": "Specifies the region where the bucket will be created. If you don't specify a region, the bucket will be created in US Standard.", + "GetBucketLocationOutput$LocationConstraint": null + } + }, + "BucketLoggingStatus": { + "base": null, + "refs": { + "PutBucketLoggingRequest$BucketLoggingStatus": null + } + }, + "BucketLogsPermission": { + "base": null, + "refs": { + "TargetGrant$Permission": "Logging permissions assigned to the Grantee for the bucket." + } + }, + "BucketName": { + "base": null, + "refs": { + "AbortMultipartUploadRequest$Bucket": null, + "Bucket$Name": "The name of the bucket.", + "CompleteMultipartUploadOutput$Bucket": null, + "CompleteMultipartUploadRequest$Bucket": null, + "CopyObjectRequest$Bucket": null, + "CreateBucketRequest$Bucket": null, + "CreateMultipartUploadOutput$Bucket": "Name of the bucket to which the multipart upload was initiated.", + "CreateMultipartUploadRequest$Bucket": null, + "DeleteBucketCorsRequest$Bucket": null, + "DeleteBucketLifecycleRequest$Bucket": null, + "DeleteBucketPolicyRequest$Bucket": null, + "DeleteBucketReplicationRequest$Bucket": null, + "DeleteBucketRequest$Bucket": null, + "DeleteBucketTaggingRequest$Bucket": null, + "DeleteBucketWebsiteRequest$Bucket": null, + "DeleteObjectRequest$Bucket": null, + "DeleteObjectsRequest$Bucket": null, + "Destination$Bucket": "Amazon resource name (ARN) of the bucket where you want Amazon S3 to store replicas of the object identified by the rule.", + "GetBucketAccelerateConfigurationRequest$Bucket": "Name of the bucket for which the accelerate configuration is retrieved.", + "GetBucketAclRequest$Bucket": null, + "GetBucketCorsRequest$Bucket": null, + "GetBucketLifecycleConfigurationRequest$Bucket": null, + "GetBucketLifecycleRequest$Bucket": null, + "GetBucketLocationRequest$Bucket": null, + "GetBucketLoggingRequest$Bucket": null, + "GetBucketNotificationConfigurationRequest$Bucket": "Name of the bucket to get the notification configuration for.", + "GetBucketPolicyRequest$Bucket": null, + "GetBucketReplicationRequest$Bucket": null, + "GetBucketRequestPaymentRequest$Bucket": null, + "GetBucketTaggingRequest$Bucket": null, + "GetBucketVersioningRequest$Bucket": null, + "GetBucketWebsiteRequest$Bucket": null, + "GetObjectAclRequest$Bucket": null, + "GetObjectRequest$Bucket": null, + "GetObjectTorrentRequest$Bucket": null, + "HeadBucketRequest$Bucket": null, + "HeadObjectRequest$Bucket": null, + "ListMultipartUploadsOutput$Bucket": "Name of the bucket to which the multipart upload was initiated.", + "ListMultipartUploadsRequest$Bucket": null, + "ListObjectVersionsOutput$Name": null, + "ListObjectVersionsRequest$Bucket": null, + "ListObjectsOutput$Name": null, + "ListObjectsRequest$Bucket": null, + "ListObjectsV2Output$Name": "Name of the bucket to list.", + "ListObjectsV2Request$Bucket": "Name of the bucket to list.", + "ListPartsOutput$Bucket": "Name of the bucket to which the multipart upload was initiated.", + "ListPartsRequest$Bucket": null, + "PutBucketAccelerateConfigurationRequest$Bucket": "Name of the bucket for which the accelerate configuration is set.", + "PutBucketAclRequest$Bucket": null, + "PutBucketCorsRequest$Bucket": null, + "PutBucketLifecycleConfigurationRequest$Bucket": null, + "PutBucketLifecycleRequest$Bucket": null, + "PutBucketLoggingRequest$Bucket": null, + "PutBucketNotificationConfigurationRequest$Bucket": null, + "PutBucketNotificationRequest$Bucket": null, + "PutBucketPolicyRequest$Bucket": null, + "PutBucketReplicationRequest$Bucket": null, + "PutBucketRequestPaymentRequest$Bucket": null, + "PutBucketTaggingRequest$Bucket": null, + "PutBucketVersioningRequest$Bucket": null, + "PutBucketWebsiteRequest$Bucket": null, + "PutObjectAclRequest$Bucket": null, + "PutObjectRequest$Bucket": "Name of the bucket to which the PUT operation was initiated.", + "RestoreObjectRequest$Bucket": null, + "UploadPartCopyRequest$Bucket": null, + "UploadPartRequest$Bucket": "Name of the bucket to which the multipart upload was initiated." + } + }, + "BucketVersioningStatus": { + "base": null, + "refs": { + "GetBucketVersioningOutput$Status": "The versioning state of the bucket.", + "VersioningConfiguration$Status": "The versioning state of the bucket." + } + }, + "Buckets": { + "base": null, + "refs": { + "ListBucketsOutput$Buckets": null + } + }, + "CORSConfiguration": { + "base": null, + "refs": { + "PutBucketCorsRequest$CORSConfiguration": null + } + }, + "CORSRule": { + "base": null, + "refs": { + "CORSRules$member": null + } + }, + "CORSRules": { + "base": null, + "refs": { + "CORSConfiguration$CORSRules": null, + "GetBucketCorsOutput$CORSRules": null + } + }, + "CacheControl": { + "base": null, + "refs": { + "CopyObjectRequest$CacheControl": "Specifies caching behavior along the request/reply chain.", + "CreateMultipartUploadRequest$CacheControl": "Specifies caching behavior along the request/reply chain.", + "GetObjectOutput$CacheControl": "Specifies caching behavior along the request/reply chain.", + "HeadObjectOutput$CacheControl": "Specifies caching behavior along the request/reply chain.", + "PutObjectRequest$CacheControl": "Specifies caching behavior along the request/reply chain." + } + }, + "CloudFunction": { + "base": null, + "refs": { + "CloudFunctionConfiguration$CloudFunction": null + } + }, + "CloudFunctionConfiguration": { + "base": null, + "refs": { + "NotificationConfigurationDeprecated$CloudFunctionConfiguration": null + } + }, + "CloudFunctionInvocationRole": { + "base": null, + "refs": { + "CloudFunctionConfiguration$InvocationRole": null + } + }, + "Code": { + "base": null, + "refs": { + "Error$Code": null + } + }, + "CommonPrefix": { + "base": null, + "refs": { + "CommonPrefixList$member": null + } + }, + "CommonPrefixList": { + "base": null, + "refs": { + "ListMultipartUploadsOutput$CommonPrefixes": null, + "ListObjectVersionsOutput$CommonPrefixes": null, + "ListObjectsOutput$CommonPrefixes": null, + "ListObjectsV2Output$CommonPrefixes": "CommonPrefixes contains all (if there are any) keys between Prefix and the next occurrence of the string specified by delimiter" + } + }, + "CompleteMultipartUploadOutput": { + "base": null, + "refs": { + } + }, + "CompleteMultipartUploadRequest": { + "base": null, + "refs": { + } + }, + "CompletedMultipartUpload": { + "base": null, + "refs": { + "CompleteMultipartUploadRequest$MultipartUpload": null + } + }, + "CompletedPart": { + "base": null, + "refs": { + "CompletedPartList$member": null + } + }, + "CompletedPartList": { + "base": null, + "refs": { + "CompletedMultipartUpload$Parts": null + } + }, + "Condition": { + "base": null, + "refs": { + "RoutingRule$Condition": "A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the /docs folder, redirect to the /documents folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might process the error." + } + }, + "ContentDisposition": { + "base": null, + "refs": { + "CopyObjectRequest$ContentDisposition": "Specifies presentational information for the object.", + "CreateMultipartUploadRequest$ContentDisposition": "Specifies presentational information for the object.", + "GetObjectOutput$ContentDisposition": "Specifies presentational information for the object.", + "HeadObjectOutput$ContentDisposition": "Specifies presentational information for the object.", + "PutObjectRequest$ContentDisposition": "Specifies presentational information for the object." + } + }, + "ContentEncoding": { + "base": null, + "refs": { + "CopyObjectRequest$ContentEncoding": "Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.", + "CreateMultipartUploadRequest$ContentEncoding": "Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.", + "GetObjectOutput$ContentEncoding": "Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.", + "HeadObjectOutput$ContentEncoding": "Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.", + "PutObjectRequest$ContentEncoding": "Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field." + } + }, + "ContentLanguage": { + "base": null, + "refs": { + "CopyObjectRequest$ContentLanguage": "The language the content is in.", + "CreateMultipartUploadRequest$ContentLanguage": "The language the content is in.", + "GetObjectOutput$ContentLanguage": "The language the content is in.", + "HeadObjectOutput$ContentLanguage": "The language the content is in.", + "PutObjectRequest$ContentLanguage": "The language the content is in." + } + }, + "ContentLength": { + "base": null, + "refs": { + "GetObjectOutput$ContentLength": "Size of the body in bytes.", + "HeadObjectOutput$ContentLength": "Size of the body in bytes.", + "PutObjectRequest$ContentLength": "Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically.", + "UploadPartRequest$ContentLength": "Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically." + } + }, + "ContentMD5": { + "base": null, + "refs": { + "PutBucketAclRequest$ContentMD5": null, + "PutBucketCorsRequest$ContentMD5": null, + "PutBucketLifecycleRequest$ContentMD5": null, + "PutBucketLoggingRequest$ContentMD5": null, + "PutBucketNotificationRequest$ContentMD5": null, + "PutBucketPolicyRequest$ContentMD5": null, + "PutBucketReplicationRequest$ContentMD5": null, + "PutBucketRequestPaymentRequest$ContentMD5": null, + "PutBucketTaggingRequest$ContentMD5": null, + "PutBucketVersioningRequest$ContentMD5": null, + "PutBucketWebsiteRequest$ContentMD5": null, + "PutObjectAclRequest$ContentMD5": null, + "PutObjectRequest$ContentMD5": "The base64-encoded 128-bit MD5 digest of the part data.", + "UploadPartRequest$ContentMD5": "The base64-encoded 128-bit MD5 digest of the part data." + } + }, + "ContentRange": { + "base": null, + "refs": { + "GetObjectOutput$ContentRange": "The portion of the object returned in the response." + } + }, + "ContentType": { + "base": null, + "refs": { + "CopyObjectRequest$ContentType": "A standard MIME type describing the format of the object data.", + "CreateMultipartUploadRequest$ContentType": "A standard MIME type describing the format of the object data.", + "GetObjectOutput$ContentType": "A standard MIME type describing the format of the object data.", + "HeadObjectOutput$ContentType": "A standard MIME type describing the format of the object data.", + "PutObjectRequest$ContentType": "A standard MIME type describing the format of the object data." + } + }, + "CopyObjectOutput": { + "base": null, + "refs": { + } + }, + "CopyObjectRequest": { + "base": null, + "refs": { + } + }, + "CopyObjectResult": { + "base": null, + "refs": { + "CopyObjectOutput$CopyObjectResult": null + } + }, + "CopyPartResult": { + "base": null, + "refs": { + "UploadPartCopyOutput$CopyPartResult": null + } + }, + "CopySource": { + "base": null, + "refs": { + "CopyObjectRequest$CopySource": "The name of the source bucket and key name of the source object, separated by a slash (/). Must be URL-encoded.", + "UploadPartCopyRequest$CopySource": "The name of the source bucket and key name of the source object, separated by a slash (/). Must be URL-encoded." + } + }, + "CopySourceIfMatch": { + "base": null, + "refs": { + "CopyObjectRequest$CopySourceIfMatch": "Copies the object if its entity tag (ETag) matches the specified tag.", + "UploadPartCopyRequest$CopySourceIfMatch": "Copies the object if its entity tag (ETag) matches the specified tag." + } + }, + "CopySourceIfModifiedSince": { + "base": null, + "refs": { + "CopyObjectRequest$CopySourceIfModifiedSince": "Copies the object if it has been modified since the specified time.", + "UploadPartCopyRequest$CopySourceIfModifiedSince": "Copies the object if it has been modified since the specified time." + } + }, + "CopySourceIfNoneMatch": { + "base": null, + "refs": { + "CopyObjectRequest$CopySourceIfNoneMatch": "Copies the object if its entity tag (ETag) is different than the specified ETag.", + "UploadPartCopyRequest$CopySourceIfNoneMatch": "Copies the object if its entity tag (ETag) is different than the specified ETag." + } + }, + "CopySourceIfUnmodifiedSince": { + "base": null, + "refs": { + "CopyObjectRequest$CopySourceIfUnmodifiedSince": "Copies the object if it hasn't been modified since the specified time.", + "UploadPartCopyRequest$CopySourceIfUnmodifiedSince": "Copies the object if it hasn't been modified since the specified time." + } + }, + "CopySourceRange": { + "base": null, + "refs": { + "UploadPartCopyRequest$CopySourceRange": "The range of bytes to copy from the source object. The range value must use the form bytes=first-last, where the first and last are the zero-based byte offsets to copy. For example, bytes=0-9 indicates that you want to copy the first ten bytes of the source. You can copy a range only if the source object is greater than 5 GB." + } + }, + "CopySourceSSECustomerAlgorithm": { + "base": null, + "refs": { + "CopyObjectRequest$CopySourceSSECustomerAlgorithm": "Specifies the algorithm to use when decrypting the source object (e.g., AES256).", + "UploadPartCopyRequest$CopySourceSSECustomerAlgorithm": "Specifies the algorithm to use when decrypting the source object (e.g., AES256)." + } + }, + "CopySourceSSECustomerKey": { + "base": null, + "refs": { + "CopyObjectRequest$CopySourceSSECustomerKey": "Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object. The encryption key provided in this header must be one that was used when the source object was created.", + "UploadPartCopyRequest$CopySourceSSECustomerKey": "Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object. The encryption key provided in this header must be one that was used when the source object was created." + } + }, + "CopySourceSSECustomerKeyMD5": { + "base": null, + "refs": { + "CopyObjectRequest$CopySourceSSECustomerKeyMD5": "Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.", + "UploadPartCopyRequest$CopySourceSSECustomerKeyMD5": "Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error." + } + }, + "CopySourceVersionId": { + "base": null, + "refs": { + "CopyObjectOutput$CopySourceVersionId": null, + "UploadPartCopyOutput$CopySourceVersionId": "The version of the source object that was copied, if you have enabled versioning on the source bucket." + } + }, + "CreateBucketConfiguration": { + "base": null, + "refs": { + "CreateBucketRequest$CreateBucketConfiguration": null + } + }, + "CreateBucketOutput": { + "base": null, + "refs": { + } + }, + "CreateBucketRequest": { + "base": null, + "refs": { + } + }, + "CreateMultipartUploadOutput": { + "base": null, + "refs": { + } + }, + "CreateMultipartUploadRequest": { + "base": null, + "refs": { + } + }, + "CreationDate": { + "base": null, + "refs": { + "Bucket$CreationDate": "Date the bucket was created." + } + }, + "Date": { + "base": null, + "refs": { + "LifecycleExpiration$Date": "Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format.", + "Transition$Date": "Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format." + } + }, + "Days": { + "base": null, + "refs": { + "LifecycleExpiration$Days": "Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer.", + "NoncurrentVersionExpiration$NoncurrentDays": "Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see How Amazon S3 Calculates When an Object Became Noncurrent in the Amazon Simple Storage Service Developer Guide.", + "NoncurrentVersionTransition$NoncurrentDays": "Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see How Amazon S3 Calculates When an Object Became Noncurrent in the Amazon Simple Storage Service Developer Guide.", + "RestoreRequest$Days": "Lifetime of the active copy in days", + "Transition$Days": "Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer." + } + }, + "DaysAfterInitiation": { + "base": null, + "refs": { + "AbortIncompleteMultipartUpload$DaysAfterInitiation": "Indicates the number of days that must pass since initiation for Lifecycle to abort an Incomplete Multipart Upload." + } + }, + "Delete": { + "base": null, + "refs": { + "DeleteObjectsRequest$Delete": null + } + }, + "DeleteBucketCorsRequest": { + "base": null, + "refs": { + } + }, + "DeleteBucketLifecycleRequest": { + "base": null, + "refs": { + } + }, + "DeleteBucketPolicyRequest": { + "base": null, + "refs": { + } + }, + "DeleteBucketReplicationRequest": { + "base": null, + "refs": { + } + }, + "DeleteBucketRequest": { + "base": null, + "refs": { + } + }, + "DeleteBucketTaggingRequest": { + "base": null, + "refs": { + } + }, + "DeleteBucketWebsiteRequest": { + "base": null, + "refs": { + } + }, + "DeleteMarker": { + "base": null, + "refs": { + "DeleteObjectOutput$DeleteMarker": "Specifies whether the versioned object that was permanently deleted was (true) or was not (false) a delete marker.", + "DeletedObject$DeleteMarker": null, + "GetObjectOutput$DeleteMarker": "Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response.", + "HeadObjectOutput$DeleteMarker": "Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response." + } + }, + "DeleteMarkerEntry": { + "base": null, + "refs": { + "DeleteMarkers$member": null + } + }, + "DeleteMarkerVersionId": { + "base": null, + "refs": { + "DeletedObject$DeleteMarkerVersionId": null + } + }, + "DeleteMarkers": { + "base": null, + "refs": { + "ListObjectVersionsOutput$DeleteMarkers": null + } + }, + "DeleteObjectOutput": { + "base": null, + "refs": { + } + }, + "DeleteObjectRequest": { + "base": null, + "refs": { + } + }, + "DeleteObjectsOutput": { + "base": null, + "refs": { + } + }, + "DeleteObjectsRequest": { + "base": null, + "refs": { + } + }, + "DeletedObject": { + "base": null, + "refs": { + "DeletedObjects$member": null + } + }, + "DeletedObjects": { + "base": null, + "refs": { + "DeleteObjectsOutput$Deleted": null + } + }, + "Delimiter": { + "base": null, + "refs": { + "ListMultipartUploadsOutput$Delimiter": null, + "ListMultipartUploadsRequest$Delimiter": "Character you use to group keys.", + "ListObjectVersionsOutput$Delimiter": null, + "ListObjectVersionsRequest$Delimiter": "A delimiter is a character you use to group keys.", + "ListObjectsOutput$Delimiter": null, + "ListObjectsRequest$Delimiter": "A delimiter is a character you use to group keys.", + "ListObjectsV2Output$Delimiter": "A delimiter is a character you use to group keys.", + "ListObjectsV2Request$Delimiter": "A delimiter is a character you use to group keys." + } + }, + "Destination": { + "base": null, + "refs": { + "ReplicationRule$Destination": null + } + }, + "DisplayName": { + "base": null, + "refs": { + "Grantee$DisplayName": "Screen name of the grantee.", + "Initiator$DisplayName": "Name of the Principal.", + "Owner$DisplayName": null + } + }, + "ETag": { + "base": null, + "refs": { + "CompleteMultipartUploadOutput$ETag": "Entity tag of the object.", + "CompletedPart$ETag": "Entity tag returned when the part was uploaded.", + "CopyObjectResult$ETag": null, + "CopyPartResult$ETag": "Entity tag of the object.", + "GetObjectOutput$ETag": "An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL", + "HeadObjectOutput$ETag": "An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL", + "Object$ETag": null, + "ObjectVersion$ETag": null, + "Part$ETag": "Entity tag returned when the part was uploaded.", + "PutObjectOutput$ETag": "Entity tag for the uploaded object.", + "UploadPartOutput$ETag": "Entity tag for the uploaded object." + } + }, + "EmailAddress": { + "base": null, + "refs": { + "Grantee$EmailAddress": "Email address of the grantee." + } + }, + "EncodingType": { + "base": "Requests Amazon S3 to encode the object keys in the response and specifies the encoding method to use. An object key may contain any Unicode character; however, XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response.", + "refs": { + "ListMultipartUploadsOutput$EncodingType": "Encoding type used by Amazon S3 to encode object keys in the response.", + "ListMultipartUploadsRequest$EncodingType": null, + "ListObjectVersionsOutput$EncodingType": "Encoding type used by Amazon S3 to encode object keys in the response.", + "ListObjectVersionsRequest$EncodingType": null, + "ListObjectsOutput$EncodingType": "Encoding type used by Amazon S3 to encode object keys in the response.", + "ListObjectsRequest$EncodingType": null, + "ListObjectsV2Output$EncodingType": "Encoding type used by Amazon S3 to encode object keys in the response.", + "ListObjectsV2Request$EncodingType": "Encoding type used by Amazon S3 to encode object keys in the response." + } + }, + "Error": { + "base": null, + "refs": { + "Errors$member": null + } + }, + "ErrorDocument": { + "base": null, + "refs": { + "GetBucketWebsiteOutput$ErrorDocument": null, + "WebsiteConfiguration$ErrorDocument": null + } + }, + "Errors": { + "base": null, + "refs": { + "DeleteObjectsOutput$Errors": null + } + }, + "Event": { + "base": "Bucket event for which to send notifications.", + "refs": { + "CloudFunctionConfiguration$Event": null, + "EventList$member": null, + "QueueConfigurationDeprecated$Event": null, + "TopicConfigurationDeprecated$Event": "Bucket event for which to send notifications." + } + }, + "EventList": { + "base": null, + "refs": { + "CloudFunctionConfiguration$Events": null, + "LambdaFunctionConfiguration$Events": null, + "QueueConfiguration$Events": null, + "QueueConfigurationDeprecated$Events": null, + "TopicConfiguration$Events": null, + "TopicConfigurationDeprecated$Events": null + } + }, + "Expiration": { + "base": null, + "refs": { + "CompleteMultipartUploadOutput$Expiration": "If the object expiration is configured, this will contain the expiration date (expiry-date) and rule ID (rule-id). The value of rule-id is URL encoded.", + "CopyObjectOutput$Expiration": "If the object expiration is configured, the response includes this header.", + "GetObjectOutput$Expiration": "If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header. It includes the expiry-date and rule-id key value pairs providing object expiration information. The value of the rule-id is URL encoded.", + "HeadObjectOutput$Expiration": "If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header. It includes the expiry-date and rule-id key value pairs providing object expiration information. The value of the rule-id is URL encoded.", + "PutObjectOutput$Expiration": "If the object expiration is configured, this will contain the expiration date (expiry-date) and rule ID (rule-id). The value of rule-id is URL encoded." + } + }, + "ExpirationStatus": { + "base": null, + "refs": { + "LifecycleRule$Status": "If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied.", + "Rule$Status": "If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied." + } + }, + "ExpiredObjectDeleteMarker": { + "base": null, + "refs": { + "LifecycleExpiration$ExpiredObjectDeleteMarker": "Indicates whether Amazon S3 will remove a delete marker with no noncurrent versions. If set to true, the delete marker will be expired; if set to false the policy takes no action. This cannot be specified with Days or Date in a Lifecycle Expiration Policy." + } + }, + "Expires": { + "base": null, + "refs": { + "CopyObjectRequest$Expires": "The date and time at which the object is no longer cacheable.", + "CreateMultipartUploadRequest$Expires": "The date and time at which the object is no longer cacheable.", + "GetObjectOutput$Expires": "The date and time at which the object is no longer cacheable.", + "HeadObjectOutput$Expires": "The date and time at which the object is no longer cacheable.", + "PutObjectRequest$Expires": "The date and time at which the object is no longer cacheable." + } + }, + "ExposeHeader": { + "base": null, + "refs": { + "ExposeHeaders$member": null + } + }, + "ExposeHeaders": { + "base": null, + "refs": { + "CORSRule$ExposeHeaders": "One or more headers in the response that you want customers to be able to access from their applications (for example, from a JavaScript XMLHttpRequest object)." + } + }, + "FetchOwner": { + "base": null, + "refs": { + "ListObjectsV2Request$FetchOwner": "The owner field is not present in listV2 by default, if you want to return owner field with each key in the result then set the fetch owner field to true" + } + }, + "FilterRule": { + "base": "Container for key value pair that defines the criteria for the filter rule.", + "refs": { + "FilterRuleList$member": null + } + }, + "FilterRuleList": { + "base": "A list of containers for key value pair that defines the criteria for the filter rule.", + "refs": { + "S3KeyFilter$FilterRules": null + } + }, + "FilterRuleName": { + "base": null, + "refs": { + "FilterRule$Name": "Object key name prefix or suffix identifying one or more objects to which the filtering rule applies. Maximum prefix length can be up to 1,024 characters. Overlapping prefixes and suffixes are not supported. For more information, go to Configuring Event Notifications in the Amazon Simple Storage Service Developer Guide." + } + }, + "FilterRuleValue": { + "base": null, + "refs": { + "FilterRule$Value": null + } + }, + "GetBucketAccelerateConfigurationOutput": { + "base": null, + "refs": { + } + }, + "GetBucketAccelerateConfigurationRequest": { + "base": null, + "refs": { + } + }, + "GetBucketAclOutput": { + "base": null, + "refs": { + } + }, + "GetBucketAclRequest": { + "base": null, + "refs": { + } + }, + "GetBucketCorsOutput": { + "base": null, + "refs": { + } + }, + "GetBucketCorsRequest": { + "base": null, + "refs": { + } + }, + "GetBucketLifecycleConfigurationOutput": { + "base": null, + "refs": { + } + }, + "GetBucketLifecycleConfigurationRequest": { + "base": null, + "refs": { + } + }, + "GetBucketLifecycleOutput": { + "base": null, + "refs": { + } + }, + "GetBucketLifecycleRequest": { + "base": null, + "refs": { + } + }, + "GetBucketLocationOutput": { + "base": null, + "refs": { + } + }, + "GetBucketLocationRequest": { + "base": null, + "refs": { + } + }, + "GetBucketLoggingOutput": { + "base": null, + "refs": { + } + }, + "GetBucketLoggingRequest": { + "base": null, + "refs": { + } + }, + "GetBucketNotificationConfigurationRequest": { + "base": null, + "refs": { + } + }, + "GetBucketPolicyOutput": { + "base": null, + "refs": { + } + }, + "GetBucketPolicyRequest": { + "base": null, + "refs": { + } + }, + "GetBucketReplicationOutput": { + "base": null, + "refs": { + } + }, + "GetBucketReplicationRequest": { + "base": null, + "refs": { + } + }, + "GetBucketRequestPaymentOutput": { + "base": null, + "refs": { + } + }, + "GetBucketRequestPaymentRequest": { + "base": null, + "refs": { + } + }, + "GetBucketTaggingOutput": { + "base": null, + "refs": { + } + }, + "GetBucketTaggingRequest": { + "base": null, + "refs": { + } + }, + "GetBucketVersioningOutput": { + "base": null, + "refs": { + } + }, + "GetBucketVersioningRequest": { + "base": null, + "refs": { + } + }, + "GetBucketWebsiteOutput": { + "base": null, + "refs": { + } + }, + "GetBucketWebsiteRequest": { + "base": null, + "refs": { + } + }, + "GetObjectAclOutput": { + "base": null, + "refs": { + } + }, + "GetObjectAclRequest": { + "base": null, + "refs": { + } + }, + "GetObjectOutput": { + "base": null, + "refs": { + } + }, + "GetObjectRequest": { + "base": null, + "refs": { + } + }, + "GetObjectTorrentOutput": { + "base": null, + "refs": { + } + }, + "GetObjectTorrentRequest": { + "base": null, + "refs": { + } + }, + "Grant": { + "base": null, + "refs": { + "Grants$member": null + } + }, + "GrantFullControl": { + "base": null, + "refs": { + "CopyObjectRequest$GrantFullControl": "Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.", + "CreateBucketRequest$GrantFullControl": "Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.", + "CreateMultipartUploadRequest$GrantFullControl": "Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.", + "PutBucketAclRequest$GrantFullControl": "Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.", + "PutObjectAclRequest$GrantFullControl": "Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.", + "PutObjectRequest$GrantFullControl": "Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object." + } + }, + "GrantRead": { + "base": null, + "refs": { + "CopyObjectRequest$GrantRead": "Allows grantee to read the object data and its metadata.", + "CreateBucketRequest$GrantRead": "Allows grantee to list the objects in the bucket.", + "CreateMultipartUploadRequest$GrantRead": "Allows grantee to read the object data and its metadata.", + "PutBucketAclRequest$GrantRead": "Allows grantee to list the objects in the bucket.", + "PutObjectAclRequest$GrantRead": "Allows grantee to list the objects in the bucket.", + "PutObjectRequest$GrantRead": "Allows grantee to read the object data and its metadata." + } + }, + "GrantReadACP": { + "base": null, + "refs": { + "CopyObjectRequest$GrantReadACP": "Allows grantee to read the object ACL.", + "CreateBucketRequest$GrantReadACP": "Allows grantee to read the bucket ACL.", + "CreateMultipartUploadRequest$GrantReadACP": "Allows grantee to read the object ACL.", + "PutBucketAclRequest$GrantReadACP": "Allows grantee to read the bucket ACL.", + "PutObjectAclRequest$GrantReadACP": "Allows grantee to read the bucket ACL.", + "PutObjectRequest$GrantReadACP": "Allows grantee to read the object ACL." + } + }, + "GrantWrite": { + "base": null, + "refs": { + "CreateBucketRequest$GrantWrite": "Allows grantee to create, overwrite, and delete any object in the bucket.", + "PutBucketAclRequest$GrantWrite": "Allows grantee to create, overwrite, and delete any object in the bucket.", + "PutObjectAclRequest$GrantWrite": "Allows grantee to create, overwrite, and delete any object in the bucket." + } + }, + "GrantWriteACP": { + "base": null, + "refs": { + "CopyObjectRequest$GrantWriteACP": "Allows grantee to write the ACL for the applicable object.", + "CreateBucketRequest$GrantWriteACP": "Allows grantee to write the ACL for the applicable bucket.", + "CreateMultipartUploadRequest$GrantWriteACP": "Allows grantee to write the ACL for the applicable object.", + "PutBucketAclRequest$GrantWriteACP": "Allows grantee to write the ACL for the applicable bucket.", + "PutObjectAclRequest$GrantWriteACP": "Allows grantee to write the ACL for the applicable bucket.", + "PutObjectRequest$GrantWriteACP": "Allows grantee to write the ACL for the applicable object." + } + }, + "Grantee": { + "base": null, + "refs": { + "Grant$Grantee": null, + "TargetGrant$Grantee": null + } + }, + "Grants": { + "base": null, + "refs": { + "AccessControlPolicy$Grants": "A list of grants.", + "GetBucketAclOutput$Grants": "A list of grants.", + "GetObjectAclOutput$Grants": "A list of grants." + } + }, + "HeadBucketRequest": { + "base": null, + "refs": { + } + }, + "HeadObjectOutput": { + "base": null, + "refs": { + } + }, + "HeadObjectRequest": { + "base": null, + "refs": { + } + }, + "HostName": { + "base": null, + "refs": { + "Redirect$HostName": "The host name to use in the redirect request.", + "RedirectAllRequestsTo$HostName": "Name of the host where requests will be redirected." + } + }, + "HttpErrorCodeReturnedEquals": { + "base": null, + "refs": { + "Condition$HttpErrorCodeReturnedEquals": "The HTTP error code when the redirect is applied. In the event of an error, if the error code equals this value, then the specified redirect is applied. Required when parent element Condition is specified and sibling KeyPrefixEquals is not specified. If both are specified, then both must be true for the redirect to be applied." + } + }, + "HttpRedirectCode": { + "base": null, + "refs": { + "Redirect$HttpRedirectCode": "The HTTP redirect code to use on the response. Not required if one of the siblings is present." + } + }, + "ID": { + "base": null, + "refs": { + "Grantee$ID": "The canonical user ID of the grantee.", + "Initiator$ID": "If the principal is an AWS account, it provides the Canonical User ID. If the principal is an IAM User, it provides a user ARN value.", + "LifecycleRule$ID": "Unique identifier for the rule. The value cannot be longer than 255 characters.", + "Owner$ID": null, + "ReplicationRule$ID": "Unique identifier for the rule. The value cannot be longer than 255 characters.", + "Rule$ID": "Unique identifier for the rule. The value cannot be longer than 255 characters." + } + }, + "IfMatch": { + "base": null, + "refs": { + "GetObjectRequest$IfMatch": "Return the object only if its entity tag (ETag) is the same as the one specified, otherwise return a 412 (precondition failed).", + "HeadObjectRequest$IfMatch": "Return the object only if its entity tag (ETag) is the same as the one specified, otherwise return a 412 (precondition failed)." + } + }, + "IfModifiedSince": { + "base": null, + "refs": { + "GetObjectRequest$IfModifiedSince": "Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified).", + "HeadObjectRequest$IfModifiedSince": "Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified)." + } + }, + "IfNoneMatch": { + "base": null, + "refs": { + "GetObjectRequest$IfNoneMatch": "Return the object only if its entity tag (ETag) is different from the one specified, otherwise return a 304 (not modified).", + "HeadObjectRequest$IfNoneMatch": "Return the object only if its entity tag (ETag) is different from the one specified, otherwise return a 304 (not modified)." + } + }, + "IfUnmodifiedSince": { + "base": null, + "refs": { + "GetObjectRequest$IfUnmodifiedSince": "Return the object only if it has not been modified since the specified time, otherwise return a 412 (precondition failed).", + "HeadObjectRequest$IfUnmodifiedSince": "Return the object only if it has not been modified since the specified time, otherwise return a 412 (precondition failed)." + } + }, + "IndexDocument": { + "base": null, + "refs": { + "GetBucketWebsiteOutput$IndexDocument": null, + "WebsiteConfiguration$IndexDocument": null + } + }, + "Initiated": { + "base": null, + "refs": { + "MultipartUpload$Initiated": "Date and time at which the multipart upload was initiated." + } + }, + "Initiator": { + "base": null, + "refs": { + "ListPartsOutput$Initiator": "Identifies who initiated the multipart upload.", + "MultipartUpload$Initiator": "Identifies who initiated the multipart upload." + } + }, + "IsLatest": { + "base": null, + "refs": { + "DeleteMarkerEntry$IsLatest": "Specifies whether the object is (true) or is not (false) the latest version of an object.", + "ObjectVersion$IsLatest": "Specifies whether the object is (true) or is not (false) the latest version of an object." + } + }, + "IsTruncated": { + "base": null, + "refs": { + "ListMultipartUploadsOutput$IsTruncated": "Indicates whether the returned list of multipart uploads is truncated. A value of true indicates that the list was truncated. The list can be truncated if the number of multipart uploads exceeds the limit allowed or specified by max uploads.", + "ListObjectVersionsOutput$IsTruncated": "A flag that indicates whether or not Amazon S3 returned all of the results that satisfied the search criteria. If your results were truncated, you can make a follow-up paginated request using the NextKeyMarker and NextVersionIdMarker response parameters as a starting place in another request to return the rest of the results.", + "ListObjectsOutput$IsTruncated": "A flag that indicates whether or not Amazon S3 returned all of the results that satisfied the search criteria.", + "ListObjectsV2Output$IsTruncated": "A flag that indicates whether or not Amazon S3 returned all of the results that satisfied the search criteria.", + "ListPartsOutput$IsTruncated": "Indicates whether the returned list of parts is truncated." + } + }, + "KeyCount": { + "base": null, + "refs": { + "ListObjectsV2Output$KeyCount": "KeyCount is the number of keys returned with this request. KeyCount will always be less than equals to MaxKeys field. Say you ask for 50 keys, your result will include less than equals 50 keys" + } + }, + "KeyMarker": { + "base": null, + "refs": { + "ListMultipartUploadsOutput$KeyMarker": "The key at or after which the listing began.", + "ListMultipartUploadsRequest$KeyMarker": "Together with upload-id-marker, this parameter specifies the multipart upload after which listing should begin.", + "ListObjectVersionsOutput$KeyMarker": "Marks the last Key returned in a truncated response.", + "ListObjectVersionsRequest$KeyMarker": "Specifies the key to start with when listing objects in a bucket." + } + }, + "KeyPrefixEquals": { + "base": null, + "refs": { + "Condition$KeyPrefixEquals": "The object key name prefix when the redirect is applied. For example, to redirect requests for ExamplePage.html, the key prefix will be ExamplePage.html. To redirect request for all pages with the prefix docs/, the key prefix will be /docs, which identifies all objects in the docs/ folder. Required when the parent element Condition is specified and sibling HttpErrorCodeReturnedEquals is not specified. If both conditions are specified, both must be true for the redirect to be applied." + } + }, + "LambdaFunctionArn": { + "base": null, + "refs": { + "LambdaFunctionConfiguration$LambdaFunctionArn": "Lambda cloud function ARN that Amazon S3 can invoke when it detects events of the specified type." + } + }, + "LambdaFunctionConfiguration": { + "base": "Container for specifying the AWS Lambda notification configuration.", + "refs": { + "LambdaFunctionConfigurationList$member": null + } + }, + "LambdaFunctionConfigurationList": { + "base": null, + "refs": { + "NotificationConfiguration$LambdaFunctionConfigurations": null + } + }, + "LastModified": { + "base": null, + "refs": { + "CopyObjectResult$LastModified": null, + "CopyPartResult$LastModified": "Date and time at which the object was uploaded.", + "DeleteMarkerEntry$LastModified": "Date and time the object was last modified.", + "GetObjectOutput$LastModified": "Last modified date of the object", + "HeadObjectOutput$LastModified": "Last modified date of the object", + "Object$LastModified": null, + "ObjectVersion$LastModified": "Date and time the object was last modified.", + "Part$LastModified": "Date and time at which the part was uploaded." + } + }, + "LifecycleConfiguration": { + "base": null, + "refs": { + "PutBucketLifecycleRequest$LifecycleConfiguration": null + } + }, + "LifecycleExpiration": { + "base": null, + "refs": { + "LifecycleRule$Expiration": null, + "Rule$Expiration": null + } + }, + "LifecycleRule": { + "base": null, + "refs": { + "LifecycleRules$member": null + } + }, + "LifecycleRules": { + "base": null, + "refs": { + "BucketLifecycleConfiguration$Rules": null, + "GetBucketLifecycleConfigurationOutput$Rules": null + } + }, + "ListBucketsOutput": { + "base": null, + "refs": { + } + }, + "ListMultipartUploadsOutput": { + "base": null, + "refs": { + } + }, + "ListMultipartUploadsRequest": { + "base": null, + "refs": { + } + }, + "ListObjectVersionsOutput": { + "base": null, + "refs": { + } + }, + "ListObjectVersionsRequest": { + "base": null, + "refs": { + } + }, + "ListObjectsOutput": { + "base": null, + "refs": { + } + }, + "ListObjectsRequest": { + "base": null, + "refs": { + } + }, + "ListObjectsV2Output": { + "base": null, + "refs": { + } + }, + "ListObjectsV2Request": { + "base": null, + "refs": { + } + }, + "ListPartsOutput": { + "base": null, + "refs": { + } + }, + "ListPartsRequest": { + "base": null, + "refs": { + } + }, + "Location": { + "base": null, + "refs": { + "CompleteMultipartUploadOutput$Location": null, + "CreateBucketOutput$Location": null + } + }, + "LoggingEnabled": { + "base": null, + "refs": { + "BucketLoggingStatus$LoggingEnabled": null, + "GetBucketLoggingOutput$LoggingEnabled": null + } + }, + "MFA": { + "base": null, + "refs": { + "DeleteObjectRequest$MFA": "The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device.", + "DeleteObjectsRequest$MFA": "The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device.", + "PutBucketVersioningRequest$MFA": "The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device." + } + }, + "MFADelete": { + "base": null, + "refs": { + "VersioningConfiguration$MFADelete": "Specifies whether MFA delete is enabled in the bucket versioning configuration. This element is only returned if the bucket has been configured with MFA delete. If the bucket has never been so configured, this element is not returned." + } + }, + "MFADeleteStatus": { + "base": null, + "refs": { + "GetBucketVersioningOutput$MFADelete": "Specifies whether MFA delete is enabled in the bucket versioning configuration. This element is only returned if the bucket has been configured with MFA delete. If the bucket has never been so configured, this element is not returned." + } + }, + "Marker": { + "base": null, + "refs": { + "ListObjectsOutput$Marker": null, + "ListObjectsRequest$Marker": "Specifies the key to start with when listing objects in a bucket." + } + }, + "MaxAgeSeconds": { + "base": null, + "refs": { + "CORSRule$MaxAgeSeconds": "The time in seconds that your browser is to cache the preflight response for the specified resource." + } + }, + "MaxKeys": { + "base": null, + "refs": { + "ListObjectVersionsOutput$MaxKeys": null, + "ListObjectVersionsRequest$MaxKeys": "Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more.", + "ListObjectsOutput$MaxKeys": null, + "ListObjectsRequest$MaxKeys": "Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more.", + "ListObjectsV2Output$MaxKeys": "Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more.", + "ListObjectsV2Request$MaxKeys": "Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more." + } + }, + "MaxParts": { + "base": null, + "refs": { + "ListPartsOutput$MaxParts": "Maximum number of parts that were allowed in the response.", + "ListPartsRequest$MaxParts": "Sets the maximum number of parts to return." + } + }, + "MaxUploads": { + "base": null, + "refs": { + "ListMultipartUploadsOutput$MaxUploads": "Maximum number of multipart uploads that could have been included in the response.", + "ListMultipartUploadsRequest$MaxUploads": "Sets the maximum number of multipart uploads, from 1 to 1,000, to return in the response body. 1,000 is the maximum number of uploads that can be returned in a response." + } + }, + "Message": { + "base": null, + "refs": { + "Error$Message": null + } + }, + "Metadata": { + "base": null, + "refs": { + "CopyObjectRequest$Metadata": "A map of metadata to store with the object in S3.", + "CreateMultipartUploadRequest$Metadata": "A map of metadata to store with the object in S3.", + "GetObjectOutput$Metadata": "A map of metadata to store with the object in S3.", + "HeadObjectOutput$Metadata": "A map of metadata to store with the object in S3.", + "PutObjectRequest$Metadata": "A map of metadata to store with the object in S3." + } + }, + "MetadataDirective": { + "base": null, + "refs": { + "CopyObjectRequest$MetadataDirective": "Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request." + } + }, + "MetadataKey": { + "base": null, + "refs": { + "Metadata$key": null + } + }, + "MetadataValue": { + "base": null, + "refs": { + "Metadata$value": null + } + }, + "MissingMeta": { + "base": null, + "refs": { + "GetObjectOutput$MissingMeta": "This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers.", + "HeadObjectOutput$MissingMeta": "This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers." + } + }, + "MultipartUpload": { + "base": null, + "refs": { + "MultipartUploadList$member": null + } + }, + "MultipartUploadId": { + "base": null, + "refs": { + "AbortMultipartUploadRequest$UploadId": null, + "CompleteMultipartUploadRequest$UploadId": null, + "CreateMultipartUploadOutput$UploadId": "ID for the initiated multipart upload.", + "ListPartsOutput$UploadId": "Upload ID identifying the multipart upload whose parts are being listed.", + "ListPartsRequest$UploadId": "Upload ID identifying the multipart upload whose parts are being listed.", + "MultipartUpload$UploadId": "Upload ID that identifies the multipart upload.", + "UploadPartCopyRequest$UploadId": "Upload ID identifying the multipart upload whose part is being copied.", + "UploadPartRequest$UploadId": "Upload ID identifying the multipart upload whose part is being uploaded." + } + }, + "MultipartUploadList": { + "base": null, + "refs": { + "ListMultipartUploadsOutput$Uploads": null + } + }, + "NextKeyMarker": { + "base": null, + "refs": { + "ListMultipartUploadsOutput$NextKeyMarker": "When a list is truncated, this element specifies the value that should be used for the key-marker request parameter in a subsequent request.", + "ListObjectVersionsOutput$NextKeyMarker": "Use this value for the key marker request parameter in a subsequent request." + } + }, + "NextMarker": { + "base": null, + "refs": { + "ListObjectsOutput$NextMarker": "When response is truncated (the IsTruncated element value in the response is true), you can use the key name in this field as marker in the subsequent request to get next set of objects. Amazon S3 lists objects in alphabetical order Note: This element is returned only if you have delimiter request parameter specified. If response does not include the NextMaker and it is truncated, you can use the value of the last Key in the response as the marker in the subsequent request to get the next set of object keys." + } + }, + "NextPartNumberMarker": { + "base": null, + "refs": { + "ListPartsOutput$NextPartNumberMarker": "When a list is truncated, this element specifies the last part in the list, as well as the value to use for the part-number-marker request parameter in a subsequent request." + } + }, + "NextToken": { + "base": null, + "refs": { + "ListObjectsV2Output$NextContinuationToken": "NextContinuationToken is sent when isTruncated is true which means there are more keys in the bucket that can be listed. The next list requests to Amazon S3 can be continued with this NextContinuationToken. NextContinuationToken is obfuscated and is not a real key" + } + }, + "NextUploadIdMarker": { + "base": null, + "refs": { + "ListMultipartUploadsOutput$NextUploadIdMarker": "When a list is truncated, this element specifies the value that should be used for the upload-id-marker request parameter in a subsequent request." + } + }, + "NextVersionIdMarker": { + "base": null, + "refs": { + "ListObjectVersionsOutput$NextVersionIdMarker": "Use this value for the next version id marker parameter in a subsequent request." + } + }, + "NoSuchBucket": { + "base": "The specified bucket does not exist.", + "refs": { + } + }, + "NoSuchKey": { + "base": "The specified key does not exist.", + "refs": { + } + }, + "NoSuchUpload": { + "base": "The specified multipart upload does not exist.", + "refs": { + } + }, + "NoncurrentVersionExpiration": { + "base": "Specifies when noncurrent object versions expire. Upon expiration, Amazon S3 permanently deletes the noncurrent object versions. You set this lifecycle configuration action on a bucket that has versioning enabled (or suspended) to request that Amazon S3 delete noncurrent object versions at a specific period in the object's lifetime.", + "refs": { + "LifecycleRule$NoncurrentVersionExpiration": null, + "Rule$NoncurrentVersionExpiration": null + } + }, + "NoncurrentVersionTransition": { + "base": "Container for the transition rule that describes when noncurrent objects transition to the STANDARD_IA or GLACIER storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to the STANDARD_IA or GLACIER storage class at a specific period in the object's lifetime.", + "refs": { + "NoncurrentVersionTransitionList$member": null, + "Rule$NoncurrentVersionTransition": null + } + }, + "NoncurrentVersionTransitionList": { + "base": null, + "refs": { + "LifecycleRule$NoncurrentVersionTransitions": null + } + }, + "NotificationConfiguration": { + "base": "Container for specifying the notification configuration of the bucket. If this element is empty, notifications are turned off on the bucket.", + "refs": { + "PutBucketNotificationConfigurationRequest$NotificationConfiguration": null + } + }, + "NotificationConfigurationDeprecated": { + "base": null, + "refs": { + "PutBucketNotificationRequest$NotificationConfiguration": null + } + }, + "NotificationConfigurationFilter": { + "base": "Container for object key name filtering rules. For information about key name filtering, go to Configuring Event Notifications in the Amazon Simple Storage Service Developer Guide.", + "refs": { + "LambdaFunctionConfiguration$Filter": null, + "QueueConfiguration$Filter": null, + "TopicConfiguration$Filter": null + } + }, + "NotificationId": { + "base": "Optional unique identifier for configurations in a notification configuration. If you don't provide one, Amazon S3 will assign an ID.", + "refs": { + "CloudFunctionConfiguration$Id": null, + "LambdaFunctionConfiguration$Id": null, + "QueueConfiguration$Id": null, + "QueueConfigurationDeprecated$Id": null, + "TopicConfiguration$Id": null, + "TopicConfigurationDeprecated$Id": null + } + }, + "Object": { + "base": null, + "refs": { + "ObjectList$member": null + } + }, + "ObjectAlreadyInActiveTierError": { + "base": "This operation is not allowed against this storage tier", + "refs": { + } + }, + "ObjectCannedACL": { + "base": null, + "refs": { + "CopyObjectRequest$ACL": "The canned ACL to apply to the object.", + "CreateMultipartUploadRequest$ACL": "The canned ACL to apply to the object.", + "PutObjectAclRequest$ACL": "The canned ACL to apply to the object.", + "PutObjectRequest$ACL": "The canned ACL to apply to the object." + } + }, + "ObjectIdentifier": { + "base": null, + "refs": { + "ObjectIdentifierList$member": null + } + }, + "ObjectIdentifierList": { + "base": null, + "refs": { + "Delete$Objects": null + } + }, + "ObjectKey": { + "base": null, + "refs": { + "AbortMultipartUploadRequest$Key": null, + "CompleteMultipartUploadOutput$Key": null, + "CompleteMultipartUploadRequest$Key": null, + "CopyObjectRequest$Key": null, + "CreateMultipartUploadOutput$Key": "Object key for which the multipart upload was initiated.", + "CreateMultipartUploadRequest$Key": null, + "DeleteMarkerEntry$Key": "The object key.", + "DeleteObjectRequest$Key": null, + "DeletedObject$Key": null, + "Error$Key": null, + "ErrorDocument$Key": "The object key name to use when a 4XX class error occurs.", + "GetObjectAclRequest$Key": null, + "GetObjectRequest$Key": null, + "GetObjectTorrentRequest$Key": null, + "HeadObjectRequest$Key": null, + "ListPartsOutput$Key": "Object key for which the multipart upload was initiated.", + "ListPartsRequest$Key": null, + "MultipartUpload$Key": "Key of the object for which the multipart upload was initiated.", + "Object$Key": null, + "ObjectIdentifier$Key": "Key name of the object to delete.", + "ObjectVersion$Key": "The object key.", + "PutObjectAclRequest$Key": null, + "PutObjectRequest$Key": "Object key for which the PUT operation was initiated.", + "RestoreObjectRequest$Key": null, + "Tag$Key": "Name of the tag.", + "UploadPartCopyRequest$Key": null, + "UploadPartRequest$Key": "Object key for which the multipart upload was initiated." + } + }, + "ObjectList": { + "base": null, + "refs": { + "ListObjectsOutput$Contents": null, + "ListObjectsV2Output$Contents": "Metadata about each object returned." + } + }, + "ObjectNotInActiveTierError": { + "base": "The source object of the COPY operation is not in the active tier and is only stored in Amazon Glacier.", + "refs": { + } + }, + "ObjectStorageClass": { + "base": null, + "refs": { + "Object$StorageClass": "The class of storage used to store the object." + } + }, + "ObjectVersion": { + "base": null, + "refs": { + "ObjectVersionList$member": null + } + }, + "ObjectVersionId": { + "base": null, + "refs": { + "CompleteMultipartUploadOutput$VersionId": "Version of the object.", + "CopyObjectOutput$VersionId": "Version ID of the newly created copy.", + "DeleteMarkerEntry$VersionId": "Version ID of an object.", + "DeleteObjectOutput$VersionId": "Returns the version ID of the delete marker created as a result of the DELETE operation.", + "DeleteObjectRequest$VersionId": "VersionId used to reference a specific version of the object.", + "DeletedObject$VersionId": null, + "Error$VersionId": null, + "GetObjectAclRequest$VersionId": "VersionId used to reference a specific version of the object.", + "GetObjectOutput$VersionId": "Version of the object.", + "GetObjectRequest$VersionId": "VersionId used to reference a specific version of the object.", + "HeadObjectOutput$VersionId": "Version of the object.", + "HeadObjectRequest$VersionId": "VersionId used to reference a specific version of the object.", + "ObjectIdentifier$VersionId": "VersionId for the specific version of the object to delete.", + "ObjectVersion$VersionId": "Version ID of an object.", + "PutObjectAclRequest$VersionId": "VersionId used to reference a specific version of the object.", + "PutObjectOutput$VersionId": "Version of the object.", + "RestoreObjectRequest$VersionId": null + } + }, + "ObjectVersionList": { + "base": null, + "refs": { + "ListObjectVersionsOutput$Versions": null + } + }, + "ObjectVersionStorageClass": { + "base": null, + "refs": { + "ObjectVersion$StorageClass": "The class of storage used to store the object." + } + }, + "Owner": { + "base": null, + "refs": { + "AccessControlPolicy$Owner": null, + "DeleteMarkerEntry$Owner": null, + "GetBucketAclOutput$Owner": null, + "GetObjectAclOutput$Owner": null, + "ListBucketsOutput$Owner": null, + "ListPartsOutput$Owner": null, + "MultipartUpload$Owner": null, + "Object$Owner": null, + "ObjectVersion$Owner": null + } + }, + "Part": { + "base": null, + "refs": { + "Parts$member": null + } + }, + "PartNumber": { + "base": null, + "refs": { + "CompletedPart$PartNumber": "Part number that identifies the part. This is a positive integer between 1 and 10,000.", + "Part$PartNumber": "Part number identifying the part. This is a positive integer between 1 and 10,000.", + "UploadPartCopyRequest$PartNumber": "Part number of part being copied. This is a positive integer between 1 and 10,000.", + "UploadPartRequest$PartNumber": "Part number of part being uploaded. This is a positive integer between 1 and 10,000." + } + }, + "PartNumberMarker": { + "base": null, + "refs": { + "ListPartsOutput$PartNumberMarker": "Part number after which listing begins.", + "ListPartsRequest$PartNumberMarker": "Specifies the part after which listing should begin. Only parts with higher part numbers will be listed." + } + }, + "Parts": { + "base": null, + "refs": { + "ListPartsOutput$Parts": null + } + }, + "Payer": { + "base": null, + "refs": { + "GetBucketRequestPaymentOutput$Payer": "Specifies who pays for the download and request fees.", + "RequestPaymentConfiguration$Payer": "Specifies who pays for the download and request fees." + } + }, + "Permission": { + "base": null, + "refs": { + "Grant$Permission": "Specifies the permission given to the grantee." + } + }, + "Policy": { + "base": null, + "refs": { + "GetBucketPolicyOutput$Policy": "The bucket policy as a JSON document.", + "PutBucketPolicyRequest$Policy": "The bucket policy as a JSON document." + } + }, + "Prefix": { + "base": null, + "refs": { + "CommonPrefix$Prefix": null, + "LifecycleRule$Prefix": "Prefix identifying one or more objects to which the rule applies.", + "ListMultipartUploadsOutput$Prefix": "When a prefix is provided in the request, this field contains the specified prefix. The result contains only keys starting with the specified prefix.", + "ListMultipartUploadsRequest$Prefix": "Lists in-progress uploads only for those keys that begin with the specified prefix.", + "ListObjectVersionsOutput$Prefix": null, + "ListObjectVersionsRequest$Prefix": "Limits the response to keys that begin with the specified prefix.", + "ListObjectsOutput$Prefix": null, + "ListObjectsRequest$Prefix": "Limits the response to keys that begin with the specified prefix.", + "ListObjectsV2Output$Prefix": "Limits the response to keys that begin with the specified prefix.", + "ListObjectsV2Request$Prefix": "Limits the response to keys that begin with the specified prefix.", + "ReplicationRule$Prefix": "Object keyname prefix identifying one or more objects to which the rule applies. Maximum prefix length can be up to 1,024 characters. Overlapping prefixes are not supported.", + "Rule$Prefix": "Prefix identifying one or more objects to which the rule applies." + } + }, + "Protocol": { + "base": null, + "refs": { + "Redirect$Protocol": "Protocol to use (http, https) when redirecting requests. The default is the protocol that is used in the original request.", + "RedirectAllRequestsTo$Protocol": "Protocol to use (http, https) when redirecting requests. The default is the protocol that is used in the original request." + } + }, + "PutBucketAccelerateConfigurationRequest": { + "base": null, + "refs": { + } + }, + "PutBucketAclRequest": { + "base": null, + "refs": { + } + }, + "PutBucketCorsRequest": { + "base": null, + "refs": { + } + }, + "PutBucketLifecycleConfigurationRequest": { + "base": null, + "refs": { + } + }, + "PutBucketLifecycleRequest": { + "base": null, + "refs": { + } + }, + "PutBucketLoggingRequest": { + "base": null, + "refs": { + } + }, + "PutBucketNotificationConfigurationRequest": { + "base": null, + "refs": { + } + }, + "PutBucketNotificationRequest": { + "base": null, + "refs": { + } + }, + "PutBucketPolicyRequest": { + "base": null, + "refs": { + } + }, + "PutBucketReplicationRequest": { + "base": null, + "refs": { + } + }, + "PutBucketRequestPaymentRequest": { + "base": null, + "refs": { + } + }, + "PutBucketTaggingRequest": { + "base": null, + "refs": { + } + }, + "PutBucketVersioningRequest": { + "base": null, + "refs": { + } + }, + "PutBucketWebsiteRequest": { + "base": null, + "refs": { + } + }, + "PutObjectAclOutput": { + "base": null, + "refs": { + } + }, + "PutObjectAclRequest": { + "base": null, + "refs": { + } + }, + "PutObjectOutput": { + "base": null, + "refs": { + } + }, + "PutObjectRequest": { + "base": null, + "refs": { + } + }, + "QueueArn": { + "base": null, + "refs": { + "QueueConfiguration$QueueArn": "Amazon SQS queue ARN to which Amazon S3 will publish a message when it detects events of specified type.", + "QueueConfigurationDeprecated$Queue": null + } + }, + "QueueConfiguration": { + "base": "Container for specifying an configuration when you want Amazon S3 to publish events to an Amazon Simple Queue Service (Amazon SQS) queue.", + "refs": { + "QueueConfigurationList$member": null + } + }, + "QueueConfigurationDeprecated": { + "base": null, + "refs": { + "NotificationConfigurationDeprecated$QueueConfiguration": null + } + }, + "QueueConfigurationList": { + "base": null, + "refs": { + "NotificationConfiguration$QueueConfigurations": null + } + }, + "Quiet": { + "base": null, + "refs": { + "Delete$Quiet": "Element to enable quiet mode for the request. When you add this element, you must set its value to true." + } + }, + "Range": { + "base": null, + "refs": { + "GetObjectRequest$Range": "Downloads the specified range bytes of an object. For more information about the HTTP Range header, go to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.", + "HeadObjectRequest$Range": "Downloads the specified range bytes of an object. For more information about the HTTP Range header, go to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35." + } + }, + "Redirect": { + "base": null, + "refs": { + "RoutingRule$Redirect": "Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event of an error, you can can specify a different error code to return." + } + }, + "RedirectAllRequestsTo": { + "base": null, + "refs": { + "GetBucketWebsiteOutput$RedirectAllRequestsTo": null, + "WebsiteConfiguration$RedirectAllRequestsTo": null + } + }, + "ReplaceKeyPrefixWith": { + "base": null, + "refs": { + "Redirect$ReplaceKeyPrefixWith": "The object key prefix to use in the redirect request. For example, to redirect requests for all pages with prefix docs/ (objects in the docs/ folder) to documents/, you can set a condition block with KeyPrefixEquals set to docs/ and in the Redirect set ReplaceKeyPrefixWith to /documents. Not required if one of the siblings is present. Can be present only if ReplaceKeyWith is not provided." + } + }, + "ReplaceKeyWith": { + "base": null, + "refs": { + "Redirect$ReplaceKeyWith": "The specific object key to use in the redirect request. For example, redirect request to error.html. Not required if one of the sibling is present. Can be present only if ReplaceKeyPrefixWith is not provided." + } + }, + "ReplicationConfiguration": { + "base": "Container for replication rules. You can add as many as 1,000 rules. Total replication configuration size can be up to 2 MB.", + "refs": { + "GetBucketReplicationOutput$ReplicationConfiguration": null, + "PutBucketReplicationRequest$ReplicationConfiguration": null + } + }, + "ReplicationRule": { + "base": null, + "refs": { + "ReplicationRules$member": null + } + }, + "ReplicationRuleStatus": { + "base": null, + "refs": { + "ReplicationRule$Status": "The rule is ignored if status is not Enabled." + } + }, + "ReplicationRules": { + "base": null, + "refs": { + "ReplicationConfiguration$Rules": "Container for information about a particular replication rule. Replication configuration must have at least one rule and can contain up to 1,000 rules." + } + }, + "ReplicationStatus": { + "base": null, + "refs": { + "GetObjectOutput$ReplicationStatus": null, + "HeadObjectOutput$ReplicationStatus": null + } + }, + "RequestCharged": { + "base": "If present, indicates that the requester was successfully charged for the request.", + "refs": { + "AbortMultipartUploadOutput$RequestCharged": null, + "CompleteMultipartUploadOutput$RequestCharged": null, + "CopyObjectOutput$RequestCharged": null, + "CreateMultipartUploadOutput$RequestCharged": null, + "DeleteObjectOutput$RequestCharged": null, + "DeleteObjectsOutput$RequestCharged": null, + "GetObjectAclOutput$RequestCharged": null, + "GetObjectOutput$RequestCharged": null, + "GetObjectTorrentOutput$RequestCharged": null, + "HeadObjectOutput$RequestCharged": null, + "ListPartsOutput$RequestCharged": null, + "PutObjectAclOutput$RequestCharged": null, + "PutObjectOutput$RequestCharged": null, + "RestoreObjectOutput$RequestCharged": null, + "UploadPartCopyOutput$RequestCharged": null, + "UploadPartOutput$RequestCharged": null + } + }, + "RequestPayer": { + "base": "Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html", + "refs": { + "AbortMultipartUploadRequest$RequestPayer": null, + "CompleteMultipartUploadRequest$RequestPayer": null, + "CopyObjectRequest$RequestPayer": null, + "CreateMultipartUploadRequest$RequestPayer": null, + "DeleteObjectRequest$RequestPayer": null, + "DeleteObjectsRequest$RequestPayer": null, + "GetObjectAclRequest$RequestPayer": null, + "GetObjectRequest$RequestPayer": null, + "GetObjectTorrentRequest$RequestPayer": null, + "HeadObjectRequest$RequestPayer": null, + "ListPartsRequest$RequestPayer": null, + "PutObjectAclRequest$RequestPayer": null, + "PutObjectRequest$RequestPayer": null, + "RestoreObjectRequest$RequestPayer": null, + "UploadPartCopyRequest$RequestPayer": null, + "UploadPartRequest$RequestPayer": null + } + }, + "RequestPaymentConfiguration": { + "base": null, + "refs": { + "PutBucketRequestPaymentRequest$RequestPaymentConfiguration": null + } + }, + "ResponseCacheControl": { + "base": null, + "refs": { + "GetObjectRequest$ResponseCacheControl": "Sets the Cache-Control header of the response." + } + }, + "ResponseContentDisposition": { + "base": null, + "refs": { + "GetObjectRequest$ResponseContentDisposition": "Sets the Content-Disposition header of the response" + } + }, + "ResponseContentEncoding": { + "base": null, + "refs": { + "GetObjectRequest$ResponseContentEncoding": "Sets the Content-Encoding header of the response." + } + }, + "ResponseContentLanguage": { + "base": null, + "refs": { + "GetObjectRequest$ResponseContentLanguage": "Sets the Content-Language header of the response." + } + }, + "ResponseContentType": { + "base": null, + "refs": { + "GetObjectRequest$ResponseContentType": "Sets the Content-Type header of the response." + } + }, + "ResponseExpires": { + "base": null, + "refs": { + "GetObjectRequest$ResponseExpires": "Sets the Expires header of the response." + } + }, + "Restore": { + "base": null, + "refs": { + "GetObjectOutput$Restore": "Provides information about object restoration operation and expiration time of the restored object copy.", + "HeadObjectOutput$Restore": "Provides information about object restoration operation and expiration time of the restored object copy." + } + }, + "RestoreObjectOutput": { + "base": null, + "refs": { + } + }, + "RestoreObjectRequest": { + "base": null, + "refs": { + } + }, + "RestoreRequest": { + "base": null, + "refs": { + "RestoreObjectRequest$RestoreRequest": null + } + }, + "Role": { + "base": null, + "refs": { + "ReplicationConfiguration$Role": "Amazon Resource Name (ARN) of an IAM role for Amazon S3 to assume when replicating the objects." + } + }, + "RoutingRule": { + "base": null, + "refs": { + "RoutingRules$member": null + } + }, + "RoutingRules": { + "base": null, + "refs": { + "GetBucketWebsiteOutput$RoutingRules": null, + "WebsiteConfiguration$RoutingRules": null + } + }, + "Rule": { + "base": null, + "refs": { + "Rules$member": null + } + }, + "Rules": { + "base": null, + "refs": { + "GetBucketLifecycleOutput$Rules": null, + "LifecycleConfiguration$Rules": null + } + }, + "S3KeyFilter": { + "base": "Container for object key name prefix and suffix filtering rules.", + "refs": { + "NotificationConfigurationFilter$Key": null + } + }, + "SSECustomerAlgorithm": { + "base": null, + "refs": { + "CopyObjectOutput$SSECustomerAlgorithm": "If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.", + "CopyObjectRequest$SSECustomerAlgorithm": "Specifies the algorithm to use to when encrypting the object (e.g., AES256).", + "CreateMultipartUploadOutput$SSECustomerAlgorithm": "If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.", + "CreateMultipartUploadRequest$SSECustomerAlgorithm": "Specifies the algorithm to use to when encrypting the object (e.g., AES256).", + "GetObjectOutput$SSECustomerAlgorithm": "If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.", + "GetObjectRequest$SSECustomerAlgorithm": "Specifies the algorithm to use to when encrypting the object (e.g., AES256).", + "HeadObjectOutput$SSECustomerAlgorithm": "If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.", + "HeadObjectRequest$SSECustomerAlgorithm": "Specifies the algorithm to use to when encrypting the object (e.g., AES256).", + "PutObjectOutput$SSECustomerAlgorithm": "If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.", + "PutObjectRequest$SSECustomerAlgorithm": "Specifies the algorithm to use to when encrypting the object (e.g., AES256).", + "UploadPartCopyOutput$SSECustomerAlgorithm": "If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.", + "UploadPartCopyRequest$SSECustomerAlgorithm": "Specifies the algorithm to use to when encrypting the object (e.g., AES256).", + "UploadPartOutput$SSECustomerAlgorithm": "If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.", + "UploadPartRequest$SSECustomerAlgorithm": "Specifies the algorithm to use to when encrypting the object (e.g., AES256)." + } + }, + "SSECustomerKey": { + "base": null, + "refs": { + "CopyObjectRequest$SSECustomerKey": "Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.", + "CreateMultipartUploadRequest$SSECustomerKey": "Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.", + "GetObjectRequest$SSECustomerKey": "Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.", + "HeadObjectRequest$SSECustomerKey": "Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.", + "PutObjectRequest$SSECustomerKey": "Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.", + "UploadPartCopyRequest$SSECustomerKey": "Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header. This must be the same encryption key specified in the initiate multipart upload request.", + "UploadPartRequest$SSECustomerKey": "Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header. This must be the same encryption key specified in the initiate multipart upload request." + } + }, + "SSECustomerKeyMD5": { + "base": null, + "refs": { + "CopyObjectOutput$SSECustomerKeyMD5": "If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key.", + "CopyObjectRequest$SSECustomerKeyMD5": "Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.", + "CreateMultipartUploadOutput$SSECustomerKeyMD5": "If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key.", + "CreateMultipartUploadRequest$SSECustomerKeyMD5": "Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.", + "GetObjectOutput$SSECustomerKeyMD5": "If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key.", + "GetObjectRequest$SSECustomerKeyMD5": "Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.", + "HeadObjectOutput$SSECustomerKeyMD5": "If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key.", + "HeadObjectRequest$SSECustomerKeyMD5": "Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.", + "PutObjectOutput$SSECustomerKeyMD5": "If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key.", + "PutObjectRequest$SSECustomerKeyMD5": "Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.", + "UploadPartCopyOutput$SSECustomerKeyMD5": "If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key.", + "UploadPartCopyRequest$SSECustomerKeyMD5": "Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.", + "UploadPartOutput$SSECustomerKeyMD5": "If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key.", + "UploadPartRequest$SSECustomerKeyMD5": "Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error." + } + }, + "SSEKMSKeyId": { + "base": null, + "refs": { + "CompleteMultipartUploadOutput$SSEKMSKeyId": "If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object.", + "CopyObjectOutput$SSEKMSKeyId": "If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object.", + "CopyObjectRequest$SSEKMSKeyId": "Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not made via SSL or using SigV4. Documentation on configuring any of the officially supported AWS SDKs and CLI can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version", + "CreateMultipartUploadOutput$SSEKMSKeyId": "If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object.", + "CreateMultipartUploadRequest$SSEKMSKeyId": "Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not made via SSL or using SigV4. Documentation on configuring any of the officially supported AWS SDKs and CLI can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version", + "GetObjectOutput$SSEKMSKeyId": "If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object.", + "HeadObjectOutput$SSEKMSKeyId": "If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object.", + "PutObjectOutput$SSEKMSKeyId": "If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object.", + "PutObjectRequest$SSEKMSKeyId": "Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not made via SSL or using SigV4. Documentation on configuring any of the officially supported AWS SDKs and CLI can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version", + "UploadPartCopyOutput$SSEKMSKeyId": "If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object.", + "UploadPartOutput$SSEKMSKeyId": "If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object." + } + }, + "ServerSideEncryption": { + "base": null, + "refs": { + "CompleteMultipartUploadOutput$ServerSideEncryption": "The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).", + "CopyObjectOutput$ServerSideEncryption": "The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).", + "CopyObjectRequest$ServerSideEncryption": "The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).", + "CreateMultipartUploadOutput$ServerSideEncryption": "The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).", + "CreateMultipartUploadRequest$ServerSideEncryption": "The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).", + "GetObjectOutput$ServerSideEncryption": "The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).", + "HeadObjectOutput$ServerSideEncryption": "The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).", + "PutObjectOutput$ServerSideEncryption": "The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).", + "PutObjectRequest$ServerSideEncryption": "The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).", + "UploadPartCopyOutput$ServerSideEncryption": "The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).", + "UploadPartOutput$ServerSideEncryption": "The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms)." + } + }, + "Size": { + "base": null, + "refs": { + "Object$Size": null, + "ObjectVersion$Size": "Size in bytes of the object.", + "Part$Size": "Size of the uploaded part data." + } + }, + "StartAfter": { + "base": null, + "refs": { + "ListObjectsV2Output$StartAfter": "StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. StartAfter can be any key in the bucket", + "ListObjectsV2Request$StartAfter": "StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. StartAfter can be any key in the bucket" + } + }, + "StorageClass": { + "base": null, + "refs": { + "CopyObjectRequest$StorageClass": "The type of storage to use for the object. Defaults to 'STANDARD'.", + "CreateMultipartUploadRequest$StorageClass": "The type of storage to use for the object. Defaults to 'STANDARD'.", + "Destination$StorageClass": "The class of storage used to store the object.", + "GetObjectOutput$StorageClass": null, + "HeadObjectOutput$StorageClass": null, + "ListPartsOutput$StorageClass": "The class of storage used to store the object.", + "MultipartUpload$StorageClass": "The class of storage used to store the object.", + "PutObjectRequest$StorageClass": "The type of storage to use for the object. Defaults to 'STANDARD'." + } + }, + "Suffix": { + "base": null, + "refs": { + "IndexDocument$Suffix": "A suffix that is appended to a request that is for a directory on the website endpoint (e.g. if the suffix is index.html and you make a request to samplebucket/images/ the data that is returned will be for the object with the key name images/index.html) The suffix must not be empty and must not include a slash character." + } + }, + "Tag": { + "base": null, + "refs": { + "TagSet$member": null + } + }, + "TagSet": { + "base": null, + "refs": { + "GetBucketTaggingOutput$TagSet": null, + "Tagging$TagSet": null + } + }, + "Tagging": { + "base": null, + "refs": { + "PutBucketTaggingRequest$Tagging": null + } + }, + "TargetBucket": { + "base": null, + "refs": { + "LoggingEnabled$TargetBucket": "Specifies the bucket where you want Amazon S3 to store server access logs. You can have your logs delivered to any bucket that you own, including the same bucket that is being logged. You can also configure multiple buckets to deliver their logs to the same target bucket. In this case you should choose a different TargetPrefix for each source bucket so that the delivered log files can be distinguished by key." + } + }, + "TargetGrant": { + "base": null, + "refs": { + "TargetGrants$member": null + } + }, + "TargetGrants": { + "base": null, + "refs": { + "LoggingEnabled$TargetGrants": null + } + }, + "TargetPrefix": { + "base": null, + "refs": { + "LoggingEnabled$TargetPrefix": "This element lets you specify a prefix for the keys that the log files will be stored under." + } + }, + "Token": { + "base": null, + "refs": { + "ListObjectsV2Output$ContinuationToken": "ContinuationToken indicates Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key", + "ListObjectsV2Request$ContinuationToken": "ContinuationToken indicates Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key" + } + }, + "TopicArn": { + "base": null, + "refs": { + "TopicConfiguration$TopicArn": "Amazon SNS topic ARN to which Amazon S3 will publish a message when it detects events of specified type.", + "TopicConfigurationDeprecated$Topic": "Amazon SNS topic to which Amazon S3 will publish a message to report the specified events for the bucket." + } + }, + "TopicConfiguration": { + "base": "Container for specifying the configuration when you want Amazon S3 to publish events to an Amazon Simple Notification Service (Amazon SNS) topic.", + "refs": { + "TopicConfigurationList$member": null + } + }, + "TopicConfigurationDeprecated": { + "base": null, + "refs": { + "NotificationConfigurationDeprecated$TopicConfiguration": null + } + }, + "TopicConfigurationList": { + "base": null, + "refs": { + "NotificationConfiguration$TopicConfigurations": null + } + }, + "Transition": { + "base": null, + "refs": { + "Rule$Transition": null, + "TransitionList$member": null + } + }, + "TransitionList": { + "base": null, + "refs": { + "LifecycleRule$Transitions": null + } + }, + "TransitionStorageClass": { + "base": null, + "refs": { + "NoncurrentVersionTransition$StorageClass": "The class of storage used to store the object.", + "Transition$StorageClass": "The class of storage used to store the object." + } + }, + "Type": { + "base": null, + "refs": { + "Grantee$Type": "Type of grantee" + } + }, + "URI": { + "base": null, + "refs": { + "Grantee$URI": "URI of the grantee group." + } + }, + "UploadIdMarker": { + "base": null, + "refs": { + "ListMultipartUploadsOutput$UploadIdMarker": "Upload ID after which listing began.", + "ListMultipartUploadsRequest$UploadIdMarker": "Together with key-marker, specifies the multipart upload after which listing should begin. If key-marker is not specified, the upload-id-marker parameter is ignored." + } + }, + "UploadPartCopyOutput": { + "base": null, + "refs": { + } + }, + "UploadPartCopyRequest": { + "base": null, + "refs": { + } + }, + "UploadPartOutput": { + "base": null, + "refs": { + } + }, + "UploadPartRequest": { + "base": null, + "refs": { + } + }, + "Value": { + "base": null, + "refs": { + "Tag$Value": "Value of the tag." + } + }, + "VersionIdMarker": { + "base": null, + "refs": { + "ListObjectVersionsOutput$VersionIdMarker": null, + "ListObjectVersionsRequest$VersionIdMarker": "Specifies the object version you want to start listing from." + } + }, + "VersioningConfiguration": { + "base": null, + "refs": { + "PutBucketVersioningRequest$VersioningConfiguration": null + } + }, + "WebsiteConfiguration": { + "base": null, + "refs": { + "PutBucketWebsiteRequest$WebsiteConfiguration": null + } + }, + "WebsiteRedirectLocation": { + "base": null, + "refs": { + "CopyObjectRequest$WebsiteRedirectLocation": "If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.", + "CreateMultipartUploadRequest$WebsiteRedirectLocation": "If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.", + "GetObjectOutput$WebsiteRedirectLocation": "If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.", + "HeadObjectOutput$WebsiteRedirectLocation": "If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.", + "PutObjectRequest$WebsiteRedirectLocation": "If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata." + } + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/s3/2006-03-01/examples-1.json b/vendor/github.com/aws/aws-sdk-go/models/apis/s3/2006-03-01/examples-1.json new file mode 100644 index 000000000..0ea7e3b0b --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/s3/2006-03-01/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/s3/2006-03-01/paginators-1.json b/vendor/github.com/aws/aws-sdk-go/models/apis/s3/2006-03-01/paginators-1.json new file mode 100644 index 000000000..349892004 --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/s3/2006-03-01/paginators-1.json @@ -0,0 +1,66 @@ +{ + "pagination": { + "ListBuckets": { + "result_key": "Buckets" + }, + "ListMultipartUploads": { + "limit_key": "MaxUploads", + "more_results": "IsTruncated", + "output_token": [ + "NextKeyMarker", + "NextUploadIdMarker" + ], + "input_token": [ + "KeyMarker", + "UploadIdMarker" + ], + "result_key": [ + "Uploads", + "CommonPrefixes" + ] + }, + "ListObjectVersions": { + "more_results": "IsTruncated", + "limit_key": "MaxKeys", + "output_token": [ + "NextKeyMarker", + "NextVersionIdMarker" + ], + "input_token": [ + "KeyMarker", + "VersionIdMarker" + ], + "result_key": [ + "Versions", + "DeleteMarkers", + "CommonPrefixes" + ] + }, + "ListObjects": { + "more_results": "IsTruncated", + "limit_key": "MaxKeys", + "output_token": "NextMarker || Contents[-1].Key", + "input_token": "Marker", + "result_key": [ + "Contents", + "CommonPrefixes" + ] + }, + "ListObjectsV2": { + "limit_key": "MaxKeys", + "output_token": "NextContinuationToken", + "input_token": "ContinuationToken", + "result_key": [ + "Contents", + "CommonPrefixes" + ] + }, + "ListParts": { + "more_results": "IsTruncated", + "limit_key": "MaxParts", + "output_token": "NextPartNumberMarker", + "input_token": "PartNumberMarker", + "result_key": "Parts" + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/s3/2006-03-01/waiters-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/s3/2006-03-01/waiters-2.json new file mode 100644 index 000000000..b508a8f5b --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/s3/2006-03-01/waiters-2.json @@ -0,0 +1,73 @@ +{ + "version": 2, + "waiters": { + "BucketExists": { + "delay": 5, + "operation": "HeadBucket", + "maxAttempts": 20, + "acceptors": [ + { + "expected": 200, + "matcher": "status", + "state": "success" + }, + { + "expected": 301, + "matcher": "status", + "state": "success" + }, + { + "expected": 403, + "matcher": "status", + "state": "success" + }, + { + "expected": 404, + "matcher": "status", + "state": "retry" + } + ] + }, + "BucketNotExists": { + "delay": 5, + "operation": "HeadBucket", + "maxAttempts": 20, + "acceptors": [ + { + "expected": 404, + "matcher": "status", + "state": "success" + } + ] + }, + "ObjectExists": { + "delay": 5, + "operation": "HeadObject", + "maxAttempts": 20, + "acceptors": [ + { + "expected": 200, + "matcher": "status", + "state": "success" + }, + { + "expected": 404, + "matcher": "status", + "state": "retry" + } + ] + }, + "ObjectNotExists": { + "delay": 5, + "operation": "HeadObject", + "maxAttempts": 20, + "acceptors": [ + { + "expected": 404, + "matcher": "status", + "state": "success" + } + ] + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/sdb/2009-04-15/api-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/sdb/2009-04-15/api-2.json new file mode 100644 index 000000000..3eb686d6d --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/sdb/2009-04-15/api-2.json @@ -0,0 +1,971 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2009-04-15", + "endpointPrefix":"sdb", + "serviceFullName":"Amazon SimpleDB", + "signatureVersion":"v2", + "xmlNamespace":"http://sdb.amazonaws.com/doc/2009-04-15/", + "protocol":"query" + }, + "operations":{ + "BatchDeleteAttributes":{ + "name":"BatchDeleteAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchDeleteAttributesRequest"} + }, + "BatchPutAttributes":{ + "name":"BatchPutAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchPutAttributesRequest"}, + "errors":[ + { + "shape":"DuplicateItemName", + "error":{ + "code":"DuplicateItemName", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"InvalidParameterValue", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"MissingParameter", + "error":{ + "code":"MissingParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"NoSuchDomain", + "error":{ + "code":"NoSuchDomain", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"NumberItemAttributesExceeded", + "error":{ + "code":"NumberItemAttributesExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + { + "shape":"NumberDomainAttributesExceeded", + "error":{ + "code":"NumberDomainAttributesExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + { + "shape":"NumberDomainBytesExceeded", + "error":{ + "code":"NumberDomainBytesExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + { + "shape":"NumberSubmittedItemsExceeded", + "error":{ + "code":"NumberSubmittedItemsExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + { + "shape":"NumberSubmittedAttributesExceeded", + "error":{ + "code":"NumberSubmittedAttributesExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + } + ] + }, + "CreateDomain":{ + "name":"CreateDomain", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDomainRequest"}, + "errors":[ + { + "shape":"InvalidParameterValue", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"MissingParameter", + "error":{ + "code":"MissingParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"NumberDomainsExceeded", + "error":{ + "code":"NumberDomainsExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + } + ] + }, + "DeleteAttributes":{ + "name":"DeleteAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteAttributesRequest"}, + "errors":[ + { + "shape":"InvalidParameterValue", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"MissingParameter", + "error":{ + "code":"MissingParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"NoSuchDomain", + "error":{ + "code":"NoSuchDomain", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"AttributeDoesNotExist", + "error":{ + "code":"AttributeDoesNotExist", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + } + ] + }, + "DeleteDomain":{ + "name":"DeleteDomain", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDomainRequest"}, + "errors":[ + { + "shape":"MissingParameter", + "error":{ + "code":"MissingParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + } + ] + }, + "DomainMetadata":{ + "name":"DomainMetadata", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DomainMetadataRequest"}, + "output":{ + "shape":"DomainMetadataResult", + "resultWrapper":"DomainMetadataResult" + }, + "errors":[ + { + "shape":"MissingParameter", + "error":{ + "code":"MissingParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"NoSuchDomain", + "error":{ + "code":"NoSuchDomain", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + } + ] + }, + "GetAttributes":{ + "name":"GetAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetAttributesRequest"}, + "output":{ + "shape":"GetAttributesResult", + "resultWrapper":"GetAttributesResult" + }, + "errors":[ + { + "shape":"InvalidParameterValue", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"MissingParameter", + "error":{ + "code":"MissingParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"NoSuchDomain", + "error":{ + "code":"NoSuchDomain", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + } + ] + }, + "ListDomains":{ + "name":"ListDomains", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListDomainsRequest"}, + "output":{ + "shape":"ListDomainsResult", + "resultWrapper":"ListDomainsResult" + }, + "errors":[ + { + "shape":"InvalidParameterValue", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"InvalidNextToken", + "error":{ + "code":"InvalidNextToken", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + } + ] + }, + "PutAttributes":{ + "name":"PutAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutAttributesRequest"}, + "errors":[ + { + "shape":"InvalidParameterValue", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"MissingParameter", + "error":{ + "code":"MissingParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"NoSuchDomain", + "error":{ + "code":"NoSuchDomain", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"NumberDomainAttributesExceeded", + "error":{ + "code":"NumberDomainAttributesExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + { + "shape":"NumberDomainBytesExceeded", + "error":{ + "code":"NumberDomainBytesExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + { + "shape":"NumberItemAttributesExceeded", + "error":{ + "code":"NumberItemAttributesExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + { + "shape":"AttributeDoesNotExist", + "error":{ + "code":"AttributeDoesNotExist", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + } + ] + }, + "Select":{ + "name":"Select", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SelectRequest"}, + "output":{ + "shape":"SelectResult", + "resultWrapper":"SelectResult" + }, + "errors":[ + { + "shape":"InvalidParameterValue", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"InvalidNextToken", + "error":{ + "code":"InvalidNextToken", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"InvalidNumberPredicates", + "error":{ + "code":"InvalidNumberPredicates", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"InvalidNumberValueTests", + "error":{ + "code":"InvalidNumberValueTests", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"InvalidQueryExpression", + "error":{ + "code":"InvalidQueryExpression", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"MissingParameter", + "error":{ + "code":"MissingParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"NoSuchDomain", + "error":{ + "code":"NoSuchDomain", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"RequestTimeout", + "error":{ + "code":"RequestTimeout", + "httpStatusCode":408, + "senderFault":true + }, + "exception":true + }, + { + "shape":"TooManyRequestedAttributes", + "error":{ + "code":"TooManyRequestedAttributes", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + } + ] + } + }, + "shapes":{ + "Attribute":{ + "type":"structure", + "required":[ + "Name", + "Value" + ], + "members":{ + "Name":{"shape":"String"}, + "AlternateNameEncoding":{"shape":"String"}, + "Value":{"shape":"String"}, + "AlternateValueEncoding":{"shape":"String"} + } + }, + "AttributeDoesNotExist":{ + "type":"structure", + "members":{ + "BoxUsage":{"shape":"Float"} + }, + "error":{ + "code":"AttributeDoesNotExist", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "AttributeList":{ + "type":"list", + "member":{ + "shape":"Attribute", + "locationName":"Attribute" + }, + "flattened":true + }, + "AttributeNameList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"AttributeName" + }, + "flattened":true + }, + "BatchDeleteAttributesRequest":{ + "type":"structure", + "required":[ + "DomainName", + "Items" + ], + "members":{ + "DomainName":{"shape":"String"}, + "Items":{"shape":"DeletableItemList"} + } + }, + "BatchPutAttributesRequest":{ + "type":"structure", + "required":[ + "DomainName", + "Items" + ], + "members":{ + "DomainName":{"shape":"String"}, + "Items":{"shape":"ReplaceableItemList"} + } + }, + "Boolean":{"type":"boolean"}, + "CreateDomainRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{"shape":"String"} + } + }, + "DeletableAttribute":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{"shape":"String"}, + "Value":{"shape":"String"} + } + }, + "DeletableAttributeList":{ + "type":"list", + "member":{ + "shape":"DeletableAttribute", + "locationName":"Attribute" + }, + "flattened":true + }, + "DeletableItem":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"String", + "locationName":"ItemName" + }, + "Attributes":{"shape":"DeletableAttributeList"} + } + }, + "DeletableItemList":{ + "type":"list", + "member":{ + "shape":"DeletableItem", + "locationName":"Item" + }, + "flattened":true + }, + "DeleteAttributesRequest":{ + "type":"structure", + "required":[ + "DomainName", + "ItemName" + ], + "members":{ + "DomainName":{"shape":"String"}, + "ItemName":{"shape":"String"}, + "Attributes":{"shape":"DeletableAttributeList"}, + "Expected":{"shape":"UpdateCondition"} + } + }, + "DeleteDomainRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{"shape":"String"} + } + }, + "DomainMetadataRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{"shape":"String"} + } + }, + "DomainMetadataResult":{ + "type":"structure", + "members":{ + "ItemCount":{"shape":"Integer"}, + "ItemNamesSizeBytes":{"shape":"Long"}, + "AttributeNameCount":{"shape":"Integer"}, + "AttributeNamesSizeBytes":{"shape":"Long"}, + "AttributeValueCount":{"shape":"Integer"}, + "AttributeValuesSizeBytes":{"shape":"Long"}, + "Timestamp":{"shape":"Integer"} + } + }, + "DomainNameList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"DomainName" + }, + "flattened":true + }, + "DuplicateItemName":{ + "type":"structure", + "members":{ + "BoxUsage":{"shape":"Float"} + }, + "error":{ + "code":"DuplicateItemName", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "Float":{"type":"float"}, + "GetAttributesRequest":{ + "type":"structure", + "required":[ + "DomainName", + "ItemName" + ], + "members":{ + "DomainName":{"shape":"String"}, + "ItemName":{"shape":"String"}, + "AttributeNames":{"shape":"AttributeNameList"}, + "ConsistentRead":{"shape":"Boolean"} + } + }, + "GetAttributesResult":{ + "type":"structure", + "members":{ + "Attributes":{"shape":"AttributeList"} + } + }, + "Integer":{"type":"integer"}, + "InvalidNextToken":{ + "type":"structure", + "members":{ + "BoxUsage":{"shape":"Float"} + }, + "error":{ + "code":"InvalidNextToken", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidNumberPredicates":{ + "type":"structure", + "members":{ + "BoxUsage":{"shape":"Float"} + }, + "error":{ + "code":"InvalidNumberPredicates", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidNumberValueTests":{ + "type":"structure", + "members":{ + "BoxUsage":{"shape":"Float"} + }, + "error":{ + "code":"InvalidNumberValueTests", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidParameterValue":{ + "type":"structure", + "members":{ + "BoxUsage":{"shape":"Float"} + }, + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidQueryExpression":{ + "type":"structure", + "members":{ + "BoxUsage":{"shape":"Float"} + }, + "error":{ + "code":"InvalidQueryExpression", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "Item":{ + "type":"structure", + "required":[ + "Name", + "Attributes" + ], + "members":{ + "Name":{"shape":"String"}, + "AlternateNameEncoding":{"shape":"String"}, + "Attributes":{"shape":"AttributeList"} + } + }, + "ItemList":{ + "type":"list", + "member":{ + "shape":"Item", + "locationName":"Item" + }, + "flattened":true + }, + "ListDomainsRequest":{ + "type":"structure", + "members":{ + "MaxNumberOfDomains":{"shape":"Integer"}, + "NextToken":{"shape":"String"} + } + }, + "ListDomainsResult":{ + "type":"structure", + "members":{ + "DomainNames":{"shape":"DomainNameList"}, + "NextToken":{"shape":"String"} + } + }, + "Long":{"type":"long"}, + "MissingParameter":{ + "type":"structure", + "members":{ + "BoxUsage":{"shape":"Float"} + }, + "error":{ + "code":"MissingParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "NoSuchDomain":{ + "type":"structure", + "members":{ + "BoxUsage":{"shape":"Float"} + }, + "error":{ + "code":"NoSuchDomain", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "NumberDomainAttributesExceeded":{ + "type":"structure", + "members":{ + "BoxUsage":{"shape":"Float"} + }, + "error":{ + "code":"NumberDomainAttributesExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + "NumberDomainBytesExceeded":{ + "type":"structure", + "members":{ + "BoxUsage":{"shape":"Float"} + }, + "error":{ + "code":"NumberDomainBytesExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + "NumberDomainsExceeded":{ + "type":"structure", + "members":{ + "BoxUsage":{"shape":"Float"} + }, + "error":{ + "code":"NumberDomainsExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + "NumberItemAttributesExceeded":{ + "type":"structure", + "members":{ + "BoxUsage":{"shape":"Float"} + }, + "error":{ + "code":"NumberItemAttributesExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + "NumberSubmittedAttributesExceeded":{ + "type":"structure", + "members":{ + "BoxUsage":{"shape":"Float"} + }, + "error":{ + "code":"NumberSubmittedAttributesExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + "NumberSubmittedItemsExceeded":{ + "type":"structure", + "members":{ + "BoxUsage":{"shape":"Float"} + }, + "error":{ + "code":"NumberSubmittedItemsExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + "PutAttributesRequest":{ + "type":"structure", + "required":[ + "DomainName", + "ItemName", + "Attributes" + ], + "members":{ + "DomainName":{"shape":"String"}, + "ItemName":{"shape":"String"}, + "Attributes":{"shape":"ReplaceableAttributeList"}, + "Expected":{"shape":"UpdateCondition"} + } + }, + "ReplaceableAttribute":{ + "type":"structure", + "required":[ + "Name", + "Value" + ], + "members":{ + "Name":{"shape":"String"}, + "Value":{"shape":"String"}, + "Replace":{"shape":"Boolean"} + } + }, + "ReplaceableAttributeList":{ + "type":"list", + "member":{ + "shape":"ReplaceableAttribute", + "locationName":"Attribute" + }, + "flattened":true + }, + "ReplaceableItem":{ + "type":"structure", + "required":[ + "Name", + "Attributes" + ], + "members":{ + "Name":{ + "shape":"String", + "locationName":"ItemName" + }, + "Attributes":{"shape":"ReplaceableAttributeList"} + } + }, + "ReplaceableItemList":{ + "type":"list", + "member":{ + "shape":"ReplaceableItem", + "locationName":"Item" + }, + "flattened":true + }, + "RequestTimeout":{ + "type":"structure", + "members":{ + "BoxUsage":{"shape":"Float"} + }, + "error":{ + "code":"RequestTimeout", + "httpStatusCode":408, + "senderFault":true + }, + "exception":true + }, + "SelectRequest":{ + "type":"structure", + "required":["SelectExpression"], + "members":{ + "SelectExpression":{"shape":"String"}, + "NextToken":{"shape":"String"}, + "ConsistentRead":{"shape":"Boolean"} + } + }, + "SelectResult":{ + "type":"structure", + "members":{ + "Items":{"shape":"ItemList"}, + "NextToken":{"shape":"String"} + } + }, + "String":{"type":"string"}, + "TooManyRequestedAttributes":{ + "type":"structure", + "members":{ + "BoxUsage":{"shape":"Float"} + }, + "error":{ + "code":"TooManyRequestedAttributes", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "UpdateCondition":{ + "type":"structure", + "members":{ + "Name":{"shape":"String"}, + "Value":{"shape":"String"}, + "Exists":{"shape":"Boolean"} + } + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/sdb/2009-04-15/docs-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/sdb/2009-04-15/docs-2.json new file mode 100644 index 000000000..b4baed838 --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/sdb/2009-04-15/docs-2.json @@ -0,0 +1,353 @@ +{ + "version": "2.0", + "operations": { + "BatchDeleteAttributes": "Performs multiple DeleteAttributes operations in a single call, which reduces round trips and latencies. This enables Amazon SimpleDB to optimize requests, which generally yields better throughput.
If you specify BatchDeleteAttributes without attributes or values, all the attributes for the item are deleted.
BatchDeleteAttributes is an idempotent operation; running it multiple times on the same item or attribute doesn't result in an error.
The BatchDeleteAttributes operation succeeds or fails in its entirety. There are no partial deletes. You can execute multiple BatchDeleteAttributes operations and other operations in parallel. However, large numbers of concurrent BatchDeleteAttributes calls can result in Service Unavailable (503) responses.
This operation is vulnerable to exceeding the maximum URL size when making a REST request using the HTTP GET method.
This operation does not support conditions using Expected.X.Name, Expected.X.Value, or Expected.X.Exists.
The following limitations are enforced for this operation:
The BatchPutAttributes operation creates or replaces attributes within one or more items. By using this operation, the client can perform multiple PutAttribute operation with a single call. This helps yield savings in round trips and latencies, enabling Amazon SimpleDB to optimize requests and generally produce better throughput.
The client may specify the item name with the Item.X.ItemName parameter. The client may specify new attributes using a combination of the Item.X.Attribute.Y.Name and Item.X.Attribute.Y.Value parameters. The client may specify the first attribute for the first item using the parameters Item.0.Attribute.0.Name and Item.0.Attribute.0.Value, and for the second attribute for the first item by the parameters Item.0.Attribute.1.Name and Item.0.Attribute.1.Value, and so on.
Attributes are uniquely identified within an item by their name/value combination. For example, a single item can have the attributes { \"first_name\", \"first_value\" } and { \"first_name\", \"second_value\" }. However, it cannot have two attribute instances where both the Item.X.Attribute.Y.Name and Item.X.Attribute.Y.Value are the same.
Optionally, the requester can supply the Replace parameter for each individual value. Setting this value to true will cause the new attribute values to replace the existing attribute values. For example, if an item I has the attributes { 'a', '1' }, { 'b', '2'} and { 'b', '3' } and the requester does a BatchPutAttributes of {'I', 'b', '4' } with the Replace parameter set to true, the final attributes of the item will be { 'a', '1' } and { 'b', '4' }, replacing the previous values of the 'b' attribute with the new value.
BatchPutAttributes operation succeeds or fails in its entirety. There are no partial puts. Expected.X.Name, Expected.X.Value, or Expected.X.Exists. You can execute multiple BatchPutAttributes operations and other operations in parallel. However, large numbers of concurrent BatchPutAttributes calls can result in Service Unavailable (503) responses.
The following limitations are enforced for this operation:
BatchPutAttributes operation The CreateDomain operation creates a new domain. The domain name should be unique among the domains associated with the Access Key ID provided in the request. The CreateDomain operation may take 10 or more seconds to complete.
The client can create up to 100 domains per account.
If the client requires additional domains, go to http://aws.amazon.com/contact-us/simpledb-limit-request/.
", + "DeleteAttributes": "Deletes one or more attributes associated with an item. If all attributes of the item are deleted, the item is deleted.
DeleteAttributes is called without being passed any attributes or values specified, all the attributes for the item are deleted. DeleteAttributes is an idempotent operation; running it multiple times on the same item or attribute does not result in an error response.
Because Amazon SimpleDB makes multiple copies of item data and uses an eventual consistency update model, performing a GetAttributes or Select operation (read) immediately after a DeleteAttributes or PutAttributes operation (write) might not return updated item data.
The DeleteDomain operation deletes a domain. Any items (and their attributes) in the domain are deleted as well. The DeleteDomain operation might take 10 or more seconds to complete.
DeleteDomain on a domain that does not exist or running the function multiple times using the same domain name will not result in an error response. Returns information about the domain, including when the domain was created, the number of items and attributes in the domain, and the size of the attribute names and values.
", + "GetAttributes": "Returns all of the attributes associated with the specified item. Optionally, the attributes returned can be limited to one or more attributes by specifying an attribute name parameter.
If the item does not exist on the replica that was accessed for this operation, an empty set is returned. The system does not return an error as it cannot guarantee the item does not exist on other replicas.
The ListDomains operation lists all domains associated with the Access Key ID. It returns domain names up to the limit set by MaxNumberOfDomains. A NextToken is returned if there are more than MaxNumberOfDomains domains. Calling ListDomains successive times with the NextToken provided by the operation returns up to MaxNumberOfDomains more domain names with each successive operation call.
The PutAttributes operation creates or replaces attributes in an item. The client may specify new attributes using a combination of the Attribute.X.Name and Attribute.X.Value parameters. The client specifies the first attribute by the parameters Attribute.0.Name and Attribute.0.Value, the second attribute by the parameters Attribute.1.Name and Attribute.1.Value, and so on.
Attributes are uniquely identified in an item by their name/value combination. For example, a single item can have the attributes { \"first_name\", \"first_value\" } and { \"first_name\", second_value\" }. However, it cannot have two attribute instances where both the Attribute.X.Name and Attribute.X.Value are the same.
Optionally, the requestor can supply the Replace parameter for each individual attribute. Setting this value to true causes the new attribute value to replace the existing attribute value(s). For example, if an item has the attributes { 'a', '1' }, { 'b', '2'} and { 'b', '3' } and the requestor calls PutAttributes using the attributes { 'b', '4' } with the Replace parameter set to true, the final attributes of the item are changed to { 'a', '1' } and { 'b', '4' }, which replaces the previous values of the 'b' attribute with the new value.
PutAttributes to replace attribute values that do not exist will not result in an error response. You cannot specify an empty string as an attribute name.
Because Amazon SimpleDB makes multiple copies of client data and uses an eventual consistency update model, an immediate GetAttributes or Select operation (read) immediately after a PutAttributes or DeleteAttributes operation (write) might not return the updated data.
The following limitations are enforced for this operation:
The Select operation returns a set of attributes for ItemNames that match the select expression. Select is similar to the standard SQL SELECT statement.
The total size of the response cannot exceed 1 MB in total size. Amazon SimpleDB automatically adjusts the number of items returned per page to enforce this limit. For example, if the client asks to retrieve 2500 items, but each individual item is 10 kB in size, the system returns 100 items and an appropriate NextToken so the client can access the next page of results.
For information on how to construct select expressions, see Using Select to Create Amazon SimpleDB Queries in the Developer Guide.
" + }, + "service": "Amazon SimpleDB is a web service providing the core database functions of data indexing and querying in the cloud. By offloading the time and effort associated with building and operating a web-scale database, SimpleDB provides developers the freedom to focus on application development.A traditional, clustered relational database requires a sizable upfront capital outlay, is complex to design, and often requires extensive and repetitive database administration. Amazon SimpleDB is dramatically simpler, requiring no schema, automatically indexing your data and providing a simple API for storage and access. This approach eliminates the administrative burden of data modeling, index maintenance, and performance tuning. Developers gain access to this functionality within Amazon's proven computing environment, are able to scale instantly, and pay only for what they use.
Visit http://aws.amazon.com/simpledb/ for more information.
", + "shapes": { + "Attribute": { + "base": "", + "refs": { + "AttributeList$member": null + } + }, + "AttributeDoesNotExist": { + "base": "The specified attribute does not exist.
", + "refs": { + } + }, + "AttributeList": { + "base": null, + "refs": { + "GetAttributesResult$Attributes": "The list of attributes returned by the operation.", + "Item$Attributes": "A list of attributes." + } + }, + "AttributeNameList": { + "base": null, + "refs": { + "GetAttributesRequest$AttributeNames": "The names of the attributes." + } + }, + "BatchDeleteAttributesRequest": { + "base": null, + "refs": { + } + }, + "BatchPutAttributesRequest": { + "base": null, + "refs": { + } + }, + "Boolean": { + "base": null, + "refs": { + "GetAttributesRequest$ConsistentRead": "Determines whether or not strong consistency should be enforced when data is read from SimpleDB. Iftrue, any data previously written to SimpleDB will be returned. Otherwise, results will be consistent eventually, and the client may not see data that was written immediately before your read.",
+ "ReplaceableAttribute$Replace": "A flag specifying whether or not to replace the attribute/value pair or to add a new attribute/value pair. The default setting is false.",
+ "SelectRequest$ConsistentRead": "Determines whether or not strong consistency should be enforced when data is read from SimpleDB. If true, any data previously written to SimpleDB will be returned. Otherwise, results will be consistent eventually, and the client may not see data that was written immediately before your read.",
+ "UpdateCondition$Exists": "A value specifying whether or not the specified attribute must exist with the specified value in order for the update condition to be satisfied. Specify true if the attribute must exist for the update condition to be satisfied. Specify false if the attribute should not exist in order for the update condition to be satisfied.
The item name was specified more than once.
", + "refs": { + } + }, + "Float": { + "base": null, + "refs": { + "AttributeDoesNotExist$BoxUsage": null, + "DuplicateItemName$BoxUsage": null, + "InvalidNextToken$BoxUsage": null, + "InvalidNumberPredicates$BoxUsage": null, + "InvalidNumberValueTests$BoxUsage": null, + "InvalidParameterValue$BoxUsage": null, + "InvalidQueryExpression$BoxUsage": null, + "MissingParameter$BoxUsage": null, + "NoSuchDomain$BoxUsage": null, + "NumberDomainAttributesExceeded$BoxUsage": null, + "NumberDomainBytesExceeded$BoxUsage": null, + "NumberDomainsExceeded$BoxUsage": null, + "NumberItemAttributesExceeded$BoxUsage": null, + "NumberSubmittedAttributesExceeded$BoxUsage": null, + "NumberSubmittedItemsExceeded$BoxUsage": null, + "RequestTimeout$BoxUsage": null, + "TooManyRequestedAttributes$BoxUsage": null + } + }, + "GetAttributesRequest": { + "base": null, + "refs": { + } + }, + "GetAttributesResult": { + "base": null, + "refs": { + } + }, + "Integer": { + "base": null, + "refs": { + "DomainMetadataResult$ItemCount": "The number of all items in the domain.", + "DomainMetadataResult$AttributeNameCount": "The number of unique attribute names in the domain.", + "DomainMetadataResult$AttributeValueCount": "The number of all attribute name/value pairs in the domain.", + "DomainMetadataResult$Timestamp": "The data and time when metadata was calculated, in Epoch (UNIX) seconds.", + "ListDomainsRequest$MaxNumberOfDomains": "The maximum number of domain names you want returned. The range is 1 to 100. The default setting is 100." + } + }, + "InvalidNextToken": { + "base": "The specified NextToken is not valid.
", + "refs": { + } + }, + "InvalidNumberPredicates": { + "base": "Too many predicates exist in the query expression.
", + "refs": { + } + }, + "InvalidNumberValueTests": { + "base": "Too many predicates exist in the query expression.
", + "refs": { + } + }, + "InvalidParameterValue": { + "base": "The value for a parameter is invalid.
", + "refs": { + } + }, + "InvalidQueryExpression": { + "base": "The specified query expression syntax is not valid.
", + "refs": { + } + }, + "Item": { + "base": "", + "refs": { + "ItemList$member": null + } + }, + "ItemList": { + "base": null, + "refs": { + "SelectResult$Items": "A list of items that match the select expression." + } + }, + "ListDomainsRequest": { + "base": null, + "refs": { + } + }, + "ListDomainsResult": { + "base": null, + "refs": { + } + }, + "Long": { + "base": null, + "refs": { + "DomainMetadataResult$ItemNamesSizeBytes": "The total size of all item names in the domain, in bytes.", + "DomainMetadataResult$AttributeNamesSizeBytes": "The total size of all unique attribute names in the domain, in bytes.", + "DomainMetadataResult$AttributeValuesSizeBytes": "The total size of all attribute values in the domain, in bytes." + } + }, + "MissingParameter": { + "base": "The request must contain the specified missing parameter.
", + "refs": { + } + }, + "NoSuchDomain": { + "base": "The specified domain does not exist.
", + "refs": { + } + }, + "NumberDomainAttributesExceeded": { + "base": "Too many attributes in this domain.
", + "refs": { + } + }, + "NumberDomainBytesExceeded": { + "base": "Too many bytes in this domain.
", + "refs": { + } + }, + "NumberDomainsExceeded": { + "base": "Too many domains exist per this account.
", + "refs": { + } + }, + "NumberItemAttributesExceeded": { + "base": "Too many attributes in this item.
", + "refs": { + } + }, + "NumberSubmittedAttributesExceeded": { + "base": "Too many attributes exist in a single call.
", + "refs": { + } + }, + "NumberSubmittedItemsExceeded": { + "base": "Too many items exist in a single call.
", + "refs": { + } + }, + "PutAttributesRequest": { + "base": null, + "refs": { + } + }, + "ReplaceableAttribute": { + "base": "", + "refs": { + "ReplaceableAttributeList$member": null + } + }, + "ReplaceableAttributeList": { + "base": null, + "refs": { + "PutAttributesRequest$Attributes": "The list of attributes.", + "ReplaceableItem$Attributes": "The list of attributes for a replaceable item." + } + }, + "ReplaceableItem": { + "base": "", + "refs": { + "ReplaceableItemList$member": null + } + }, + "ReplaceableItemList": { + "base": null, + "refs": { + "BatchPutAttributesRequest$Items": "A list of items on which to perform the operation." + } + }, + "RequestTimeout": { + "base": "A timeout occurred when attempting to query the specified domain with specified query expression.
", + "refs": { + } + }, + "SelectRequest": { + "base": null, + "refs": { + } + }, + "SelectResult": { + "base": null, + "refs": { + } + }, + "String": { + "base": null, + "refs": { + "Attribute$Name": "The name of the attribute.", + "Attribute$AlternateNameEncoding": "", + "Attribute$Value": "The value of the attribute.", + "Attribute$AlternateValueEncoding": "", + "AttributeNameList$member": null, + "BatchDeleteAttributesRequest$DomainName": "The name of the domain in which the attributes are being deleted.", + "BatchPutAttributesRequest$DomainName": "The name of the domain in which the attributes are being stored.", + "CreateDomainRequest$DomainName": "The name of the domain to create. The name can range between 3 and 255 characters and can contain the following characters: a-z, A-Z, 0-9, '_', '-', and '.'.", + "DeletableAttribute$Name": "The name of the attribute.", + "DeletableAttribute$Value": "The value of the attribute.", + "DeletableItem$Name": null, + "DeleteAttributesRequest$DomainName": "The name of the domain in which to perform the operation.", + "DeleteAttributesRequest$ItemName": "The name of the item. Similar to rows on a spreadsheet, items represent individual objects that contain one or more value-attribute pairs.", + "DeleteDomainRequest$DomainName": "The name of the domain to delete.", + "DomainMetadataRequest$DomainName": "The name of the domain for which to display the metadata of.", + "DomainNameList$member": null, + "GetAttributesRequest$DomainName": "The name of the domain in which to perform the operation.", + "GetAttributesRequest$ItemName": "The name of the item.", + "Item$Name": "The name of the item.", + "Item$AlternateNameEncoding": "", + "ListDomainsRequest$NextToken": "A string informing Amazon SimpleDB where to start the next list of domain names.", + "ListDomainsResult$NextToken": "An opaque token indicating that there are more domains than the specifiedMaxNumberOfDomains still available.",
+ "PutAttributesRequest$DomainName": "The name of the domain in which to perform the operation.",
+ "PutAttributesRequest$ItemName": "The name of the item.",
+ "ReplaceableAttribute$Name": "The name of the replaceable attribute.",
+ "ReplaceableAttribute$Value": "The value of the replaceable attribute.",
+ "ReplaceableItem$Name": "The name of the replaceable item.",
+ "SelectRequest$SelectExpression": "The expression used to query the domain.",
+ "SelectRequest$NextToken": "A string informing Amazon SimpleDB where to start the next list of ItemNames.",
+ "SelectResult$NextToken": "An opaque token indicating that more items than MaxNumberOfItems were matched, the response size exceeded 1 megabyte, or the execution time exceeded 5 seconds.",
+ "UpdateCondition$Name": "The name of the attribute involved in the condition.
", + "UpdateCondition$Value": "The value of an attribute. This value can only be specified when the Exists parameter is equal to true.
Too many attributes requested.
", + "refs": { + } + }, + "UpdateCondition": { + "base": "Specifies the conditions under which data should be updated. If an update condition is specified for a request, the data will only be updated if the condition is satisfied. For example, if an attribute with a specific name and value exists, or if a specific attribute doesn't exist.
", + "refs": { + "DeleteAttributesRequest$Expected": "The update condition which, if specified, determines whether the specified attributes will be deleted or not. The update condition must be satisfied in order for this request to be processed and the attributes to be deleted.", + "PutAttributesRequest$Expected": "The update condition which, if specified, determines whether the specified attributes will be updated or not. The update condition must be satisfied in order for this request to be processed and the attributes to be updated." + } + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/sdb/2009-04-15/paginators-1.json b/vendor/github.com/aws/aws-sdk-go/models/apis/sdb/2009-04-15/paginators-1.json new file mode 100644 index 000000000..236209887 --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/sdb/2009-04-15/paginators-1.json @@ -0,0 +1,15 @@ +{ + "pagination": { + "ListDomains": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxNumberOfDomains", + "result_key": "DomainNames" + }, + "Select": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "Items" + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/servicecatalog/2015-12-10/api-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/servicecatalog/2015-12-10/api-2.json new file mode 100644 index 000000000..8e0e421e6 --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/servicecatalog/2015-12-10/api-2.json @@ -0,0 +1,749 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2015-12-10", + "endpointPrefix":"servicecatalog", + "jsonVersion":"1.1", + "protocol":"json", + "serviceFullName":"AWS Service Catalog", + "signatureVersion":"v4", + "targetPrefix":"AWS242ServiceCatalogService" + }, + "operations":{ + "DescribeProduct":{ + "name":"DescribeProduct", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeProductInput"}, + "output":{"shape":"DescribeProductOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParametersException"} + ] + }, + "DescribeProductView":{ + "name":"DescribeProductView", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeProductViewInput"}, + "output":{"shape":"DescribeProductViewOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParametersException"} + ] + }, + "DescribeProvisioningParameters":{ + "name":"DescribeProvisioningParameters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeProvisioningParametersInput"}, + "output":{"shape":"DescribeProvisioningParametersOutput"}, + "errors":[ + {"shape":"InvalidParametersException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "DescribeRecord":{ + "name":"DescribeRecord", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeRecordInput"}, + "output":{"shape":"DescribeRecordOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"} + ] + }, + "ListLaunchPaths":{ + "name":"ListLaunchPaths", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListLaunchPathsInput"}, + "output":{"shape":"ListLaunchPathsOutput"}, + "errors":[ + {"shape":"InvalidParametersException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "ListRecordHistory":{ + "name":"ListRecordHistory", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListRecordHistoryInput"}, + "output":{"shape":"ListRecordHistoryOutput"}, + "errors":[ + {"shape":"InvalidParametersException"} + ] + }, + "ProvisionProduct":{ + "name":"ProvisionProduct", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ProvisionProductInput"}, + "output":{"shape":"ProvisionProductOutput"}, + "errors":[ + {"shape":"InvalidParametersException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"DuplicateResourceException"} + ] + }, + "ScanProvisionedProducts":{ + "name":"ScanProvisionedProducts", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ScanProvisionedProductsInput"}, + "output":{"shape":"ScanProvisionedProductsOutput"}, + "errors":[ + {"shape":"InvalidParametersException"} + ] + }, + "SearchProducts":{ + "name":"SearchProducts", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SearchProductsInput"}, + "output":{"shape":"SearchProductsOutput"}, + "errors":[ + {"shape":"InvalidParametersException"} + ] + }, + "TerminateProvisionedProduct":{ + "name":"TerminateProvisionedProduct", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TerminateProvisionedProductInput"}, + "output":{"shape":"TerminateProvisionedProductOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"} + ] + }, + "UpdateProvisionedProduct":{ + "name":"UpdateProvisionedProduct", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateProvisionedProductInput"}, + "output":{"shape":"UpdateProvisionedProductOutput"}, + "errors":[ + {"shape":"InvalidParametersException"}, + {"shape":"ResourceNotFoundException"} + ] + } + }, + "shapes":{ + "AcceptLanguage":{"type":"string"}, + "AllowedValue":{"type":"string"}, + "AllowedValues":{ + "type":"list", + "member":{"shape":"AllowedValue"} + }, + "ApproximateCount":{"type":"integer"}, + "AttributeValue":{"type":"string"}, + "ConstraintDescription":{"type":"string"}, + "ConstraintSummaries":{ + "type":"list", + "member":{"shape":"ConstraintSummary"} + }, + "ConstraintSummary":{ + "type":"structure", + "members":{ + "Type":{"shape":"ConstraintType"}, + "Description":{"shape":"ConstraintDescription"} + } + }, + "ConstraintType":{"type":"string"}, + "CreatedTime":{"type":"timestamp"}, + "DefaultValue":{"type":"string"}, + "DescribeProductInput":{ + "type":"structure", + "required":["Id"], + "members":{ + "AcceptLanguage":{"shape":"AcceptLanguage"}, + "Id":{"shape":"Id"} + } + }, + "DescribeProductOutput":{ + "type":"structure", + "members":{ + "ProductViewSummary":{"shape":"ProductViewSummary"}, + "ProvisioningArtifacts":{"shape":"ProvisioningArtifacts"} + } + }, + "DescribeProductViewInput":{ + "type":"structure", + "required":["Id"], + "members":{ + "AcceptLanguage":{"shape":"AcceptLanguage"}, + "Id":{"shape":"Id"} + } + }, + "DescribeProductViewOutput":{ + "type":"structure", + "members":{ + "ProductViewSummary":{"shape":"ProductViewSummary"}, + "ProvisioningArtifacts":{"shape":"ProvisioningArtifacts"} + } + }, + "DescribeProvisioningParametersInput":{ + "type":"structure", + "required":[ + "ProductId", + "ProvisioningArtifactId" + ], + "members":{ + "AcceptLanguage":{"shape":"AcceptLanguage"}, + "ProductId":{"shape":"Id"}, + "ProvisioningArtifactId":{"shape":"Id"}, + "PathId":{"shape":"Id"} + } + }, + "DescribeProvisioningParametersOutput":{ + "type":"structure", + "members":{ + "ProvisioningArtifactParameters":{"shape":"ProvisioningArtifactParameters"}, + "ConstraintSummaries":{"shape":"ConstraintSummaries"}, + "UsageInstructions":{"shape":"UsageInstructions"} + } + }, + "DescribeRecordInput":{ + "type":"structure", + "required":["Id"], + "members":{ + "AcceptLanguage":{"shape":"AcceptLanguage"}, + "Id":{"shape":"Id"}, + "PageToken":{"shape":"PageToken"}, + "PageSize":{"shape":"PageSize"} + } + }, + "DescribeRecordOutput":{ + "type":"structure", + "members":{ + "RecordDetail":{"shape":"RecordDetail"}, + "RecordOutputs":{"shape":"RecordOutputs"}, + "NextPageToken":{"shape":"PageToken"} + } + }, + "Description":{"type":"string"}, + "DuplicateResourceException":{ + "type":"structure", + "members":{ + }, + "exception":true + }, + "ErrorCode":{"type":"string"}, + "ErrorDescription":{"type":"string"}, + "HasDefaultPath":{"type":"boolean"}, + "Id":{"type":"string"}, + "IdempotencyToken":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[a-zA-Z0-9][a-zA-Z0-9_-]*" + }, + "IgnoreErrors":{"type":"boolean"}, + "InstructionType":{"type":"string"}, + "InstructionValue":{"type":"string"}, + "InvalidParametersException":{ + "type":"structure", + "members":{ + }, + "exception":true + }, + "LastRequestId":{"type":"string"}, + "LaunchPathSummaries":{ + "type":"list", + "member":{"shape":"LaunchPathSummary"} + }, + "LaunchPathSummary":{ + "type":"structure", + "members":{ + "Id":{"shape":"Id"}, + "ConstraintSummaries":{"shape":"ConstraintSummaries"}, + "Tags":{"shape":"Tags"}, + "Name":{"shape":"PortfolioName"} + } + }, + "ListLaunchPathsInput":{ + "type":"structure", + "required":["ProductId"], + "members":{ + "AcceptLanguage":{"shape":"AcceptLanguage"}, + "ProductId":{"shape":"Id"}, + "PageSize":{"shape":"PageSize"}, + "PageToken":{"shape":"PageToken"} + } + }, + "ListLaunchPathsOutput":{ + "type":"structure", + "members":{ + "LaunchPathSummaries":{"shape":"LaunchPathSummaries"}, + "NextPageToken":{"shape":"PageToken"} + } + }, + "ListRecordHistoryInput":{ + "type":"structure", + "members":{ + "AcceptLanguage":{"shape":"AcceptLanguage"}, + "SearchFilter":{"shape":"ListRecordHistorySearchFilter"}, + "PageSize":{"shape":"PageSize"}, + "PageToken":{"shape":"PageToken"} + } + }, + "ListRecordHistoryOutput":{ + "type":"structure", + "members":{ + "RecordDetails":{"shape":"RecordDetails"}, + "NextPageToken":{"shape":"PageToken"} + } + }, + "ListRecordHistorySearchFilter":{ + "type":"structure", + "members":{ + "Key":{"shape":"SearchFilterKey"}, + "Value":{"shape":"SearchFilterValue"} + } + }, + "NoEcho":{"type":"boolean"}, + "NotificationArn":{ + "type":"string", + "max":1224, + "min":1, + "pattern":"arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}" + }, + "NotificationArns":{ + "type":"list", + "member":{"shape":"NotificationArn"}, + "max":5 + }, + "OutputKey":{"type":"string"}, + "OutputValue":{"type":"string"}, + "PageSize":{ + "type":"integer", + "max":20, + "min":0 + }, + "PageToken":{ + "type":"string", + "pattern":"[\\u0009\\u000a\\u000d\\u0020-\\uD7FF\\uE000-\\uFFFD]*" + }, + "ParameterConstraints":{ + "type":"structure", + "members":{ + "AllowedValues":{"shape":"AllowedValues"} + } + }, + "ParameterKey":{"type":"string"}, + "ParameterType":{"type":"string"}, + "ParameterValue":{"type":"string"}, + "PortfolioName":{"type":"string"}, + "ProductType":{"type":"string"}, + "ProductViewAggregationType":{"type":"string"}, + "ProductViewAggregationValue":{ + "type":"structure", + "members":{ + "Value":{"shape":"AttributeValue"}, + "ApproximateCount":{"shape":"ApproximateCount"} + } + }, + "ProductViewAggregationValues":{ + "type":"list", + "member":{"shape":"ProductViewAggregationValue"} + }, + "ProductViewAggregations":{ + "type":"map", + "key":{"shape":"ProductViewAggregationType"}, + "value":{"shape":"ProductViewAggregationValues"} + }, + "ProductViewDistributor":{"type":"string"}, + "ProductViewFilterBy":{ + "type":"string", + "enum":[ + "FullTextSearch", + "Owner", + "ProductType" + ] + }, + "ProductViewFilterValue":{"type":"string"}, + "ProductViewFilterValues":{ + "type":"list", + "member":{"shape":"ProductViewFilterValue"} + }, + "ProductViewFilters":{ + "type":"map", + "key":{"shape":"ProductViewFilterBy"}, + "value":{"shape":"ProductViewFilterValues"} + }, + "ProductViewName":{"type":"string"}, + "ProductViewOwner":{"type":"string"}, + "ProductViewShortDescription":{"type":"string"}, + "ProductViewSortBy":{ + "type":"string", + "enum":[ + "Title", + "VersionCount", + "CreationDate" + ] + }, + "ProductViewSummaries":{ + "type":"list", + "member":{"shape":"ProductViewSummary"} + }, + "ProductViewSummary":{ + "type":"structure", + "members":{ + "Id":{"shape":"Id"}, + "ProductId":{"shape":"Id"}, + "Name":{"shape":"ProductViewName"}, + "Owner":{"shape":"ProductViewOwner"}, + "ShortDescription":{"shape":"ProductViewShortDescription"}, + "Type":{"shape":"ProductType"}, + "Distributor":{"shape":"ProductViewDistributor"}, + "HasDefaultPath":{"shape":"HasDefaultPath"}, + "SupportEmail":{"shape":"SupportEmail"}, + "SupportDescription":{"shape":"SupportDescription"}, + "SupportUrl":{"shape":"SupportUrl"} + } + }, + "ProvisionProductInput":{ + "type":"structure", + "required":[ + "ProductId", + "ProvisioningArtifactId", + "ProvisionedProductName", + "ProvisionToken" + ], + "members":{ + "AcceptLanguage":{"shape":"AcceptLanguage"}, + "ProductId":{"shape":"Id"}, + "ProvisioningArtifactId":{"shape":"Id"}, + "PathId":{"shape":"Id"}, + "ProvisionedProductName":{"shape":"ProvisionedProductName"}, + "ProvisioningParameters":{"shape":"ProvisioningParameters"}, + "Tags":{"shape":"Tags"}, + "NotificationArns":{"shape":"NotificationArns"}, + "ProvisionToken":{ + "shape":"IdempotencyToken", + "idempotencyToken":true + } + } + }, + "ProvisionProductOutput":{ + "type":"structure", + "members":{ + "RecordDetail":{"shape":"RecordDetail"} + } + }, + "ProvisionedProductDetail":{ + "type":"structure", + "members":{ + "Name":{"shape":"ProvisionedProductNameOrArn"}, + "Arn":{"shape":"ProvisionedProductNameOrArn"}, + "Type":{"shape":"ProvisionedProductType"}, + "Id":{"shape":"ProvisionedProductId"}, + "Status":{"shape":"RecordStatus"}, + "StatusMessage":{"shape":"ProvisionedProductStatusMessage"}, + "CreatedTime":{"shape":"CreatedTime"}, + "IdempotencyToken":{"shape":"IdempotencyToken"}, + "LastRecordId":{"shape":"LastRequestId"} + } + }, + "ProvisionedProductDetails":{ + "type":"list", + "member":{"shape":"ProvisionedProductDetail"} + }, + "ProvisionedProductId":{"type":"string"}, + "ProvisionedProductName":{"type":"string"}, + "ProvisionedProductNameOrArn":{ + "type":"string", + "max":1224, + "min":1, + "pattern":"[a-zA-Z0-9][a-zA-Z0-9_-]{0,127}|arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}" + }, + "ProvisionedProductStatusMessage":{"type":"string"}, + "ProvisionedProductType":{"type":"string"}, + "ProvisioningArtifact":{ + "type":"structure", + "members":{ + "Id":{"shape":"Id"}, + "Name":{"shape":"ProvisioningArtifactName"}, + "Description":{"shape":"ProvisioningArtifactDescription"}, + "CreatedTime":{"shape":"ProvisioningArtifactCreatedTime"} + } + }, + "ProvisioningArtifactCreatedTime":{"type":"timestamp"}, + "ProvisioningArtifactDescription":{"type":"string"}, + "ProvisioningArtifactName":{"type":"string"}, + "ProvisioningArtifactParameter":{ + "type":"structure", + "members":{ + "ParameterKey":{"shape":"ParameterKey"}, + "DefaultValue":{"shape":"DefaultValue"}, + "ParameterType":{"shape":"ParameterType"}, + "IsNoEcho":{"shape":"NoEcho"}, + "Description":{"shape":"Description"}, + "ParameterConstraints":{"shape":"ParameterConstraints"} + } + }, + "ProvisioningArtifactParameters":{ + "type":"list", + "member":{"shape":"ProvisioningArtifactParameter"} + }, + "ProvisioningArtifacts":{ + "type":"list", + "member":{"shape":"ProvisioningArtifact"} + }, + "ProvisioningParameter":{ + "type":"structure", + "members":{ + "Key":{"shape":"ParameterKey"}, + "Value":{"shape":"ParameterValue"} + } + }, + "ProvisioningParameters":{ + "type":"list", + "member":{"shape":"ProvisioningParameter"} + }, + "RecordDetail":{ + "type":"structure", + "members":{ + "RecordId":{"shape":"Id"}, + "ProvisionedProductName":{"shape":"ProvisionedProductName"}, + "Status":{"shape":"RecordStatus"}, + "CreatedTime":{"shape":"CreatedTime"}, + "UpdatedTime":{"shape":"UpdatedTime"}, + "ProvisionedProductType":{"shape":"ProvisionedProductType"}, + "RecordType":{"shape":"RecordType"}, + "ProvisionedProductId":{"shape":"Id"}, + "ProductId":{"shape":"Id"}, + "ProvisioningArtifactId":{"shape":"Id"}, + "PathId":{"shape":"Id"}, + "RecordErrors":{"shape":"RecordErrors"}, + "RecordTags":{"shape":"RecordTags"} + } + }, + "RecordDetails":{ + "type":"list", + "member":{"shape":"RecordDetail"} + }, + "RecordError":{ + "type":"structure", + "members":{ + "Code":{"shape":"ErrorCode"}, + "Description":{"shape":"ErrorDescription"} + } + }, + "RecordErrors":{ + "type":"list", + "member":{"shape":"RecordError"} + }, + "RecordOutput":{ + "type":"structure", + "members":{ + "OutputKey":{"shape":"OutputKey"}, + "OutputValue":{"shape":"OutputValue"}, + "Description":{"shape":"Description"} + } + }, + "RecordOutputs":{ + "type":"list", + "member":{"shape":"RecordOutput"} + }, + "RecordStatus":{ + "type":"string", + "enum":[ + "IN_PROGRESS", + "SUCCEEDED", + "ERROR" + ] + }, + "RecordTag":{ + "type":"structure", + "members":{ + "Key":{"shape":"RecordTagKey"}, + "Value":{"shape":"RecordTagValue"} + } + }, + "RecordTagKey":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-%@]*)$" + }, + "RecordTagValue":{ + "type":"string", + "max":256, + "min":1, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-%@]*)$" + }, + "RecordTags":{ + "type":"list", + "member":{"shape":"RecordTag"}, + "max":10 + }, + "RecordType":{"type":"string"}, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + }, + "exception":true + }, + "ScanProvisionedProductsInput":{ + "type":"structure", + "members":{ + "AcceptLanguage":{"shape":"AcceptLanguage"}, + "PageSize":{"shape":"PageSize"}, + "PageToken":{"shape":"PageToken"} + } + }, + "ScanProvisionedProductsOutput":{ + "type":"structure", + "members":{ + "ProvisionedProducts":{"shape":"ProvisionedProductDetails"}, + "NextPageToken":{"shape":"PageToken"} + } + }, + "SearchFilterKey":{"type":"string"}, + "SearchFilterValue":{"type":"string"}, + "SearchProductsInput":{ + "type":"structure", + "members":{ + "AcceptLanguage":{"shape":"AcceptLanguage"}, + "Filters":{"shape":"ProductViewFilters"}, + "PageSize":{"shape":"PageSize"}, + "SortBy":{"shape":"ProductViewSortBy"}, + "SortOrder":{"shape":"SortOrder"}, + "PageToken":{"shape":"PageToken"} + } + }, + "SearchProductsOutput":{ + "type":"structure", + "members":{ + "ProductViewSummaries":{"shape":"ProductViewSummaries"}, + "ProductViewAggregations":{"shape":"ProductViewAggregations"}, + "NextPageToken":{"shape":"PageToken"} + } + }, + "SortOrder":{ + "type":"string", + "enum":[ + "ASCENDING", + "DESCENDING" + ] + }, + "SupportDescription":{"type":"string"}, + "SupportEmail":{"type":"string"}, + "SupportUrl":{"type":"string"}, + "Tag":{ + "type":"structure", + "members":{ + "Key":{"shape":"TagKey"}, + "Value":{"shape":"TagValue"} + } + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-%@]*)$" + }, + "TagValue":{ + "type":"string", + "max":256, + "min":1, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-%@]*)$" + }, + "Tags":{ + "type":"list", + "member":{"shape":"Tag"}, + "max":10 + }, + "TerminateProvisionedProductInput":{ + "type":"structure", + "required":["TerminateToken"], + "members":{ + "ProvisionedProductName":{"shape":"ProvisionedProductNameOrArn"}, + "ProvisionedProductId":{"shape":"Id"}, + "TerminateToken":{ + "shape":"IdempotencyToken", + "idempotencyToken":true + }, + "IgnoreErrors":{"shape":"IgnoreErrors"}, + "AcceptLanguage":{"shape":"AcceptLanguage"} + } + }, + "TerminateProvisionedProductOutput":{ + "type":"structure", + "members":{ + "RecordDetail":{"shape":"RecordDetail"} + } + }, + "UpdateProvisionedProductInput":{ + "type":"structure", + "required":["UpdateToken"], + "members":{ + "AcceptLanguage":{"shape":"AcceptLanguage"}, + "ProvisionedProductName":{"shape":"ProvisionedProductNameOrArn"}, + "ProvisionedProductId":{"shape":"Id"}, + "ProductId":{"shape":"Id"}, + "ProvisioningArtifactId":{"shape":"Id"}, + "PathId":{"shape":"Id"}, + "ProvisioningParameters":{"shape":"UpdateProvisioningParameters"}, + "UpdateToken":{ + "shape":"IdempotencyToken", + "idempotencyToken":true + } + } + }, + "UpdateProvisionedProductOutput":{ + "type":"structure", + "members":{ + "RecordDetail":{"shape":"RecordDetail"} + } + }, + "UpdateProvisioningParameter":{ + "type":"structure", + "members":{ + "Key":{"shape":"ParameterKey"}, + "Value":{"shape":"ParameterValue"}, + "UsePreviousValue":{"shape":"UsePreviousValue"} + } + }, + "UpdateProvisioningParameters":{ + "type":"list", + "member":{"shape":"UpdateProvisioningParameter"} + }, + "UpdatedTime":{"type":"timestamp"}, + "UsageInstruction":{ + "type":"structure", + "members":{ + "Type":{"shape":"InstructionType"}, + "Value":{"shape":"InstructionValue"} + } + }, + "UsageInstructions":{ + "type":"list", + "member":{"shape":"UsageInstruction"} + }, + "UsePreviousValue":{"type":"boolean"} + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/servicecatalog/2015-12-10/docs-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/servicecatalog/2015-12-10/docs-2.json new file mode 100644 index 000000000..9fd6e0e40 --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/servicecatalog/2015-12-10/docs-2.json @@ -0,0 +1,789 @@ +{ + "version": "2.0", + "service": "Overview
AWS Service Catalog allows organizations to create and manage catalogs of IT services that are approved for use on AWS. This documentation provides reference material for the AWS Service Catalog end user API. To get the most out of this documentation, you need to be familiar with the terminology discussed in AWS Service Catalog Concepts.
Additional Resources
", + "operations": { + "DescribeProduct": "Retrieves information about a specified product.
This operation is functionally identical to DescribeProductView except that it takes as input ProductId instead of ProductViewId.
Retrieves information about a specified product.
This operation is functionally identical to DescribeProduct except that it takes as input ProductViewId instead of ProductId.
Provides information about parameters required to provision a specified product in a specified manner. Use this operation to obtain the list of ProvisioningArtifactParameters parameters available to call the ProvisionProduct operation for the specified product.
Retrieves a paginated list of the full details of a specific request. Use this operation after calling a request operation (ProvisionProduct, TerminateProvisionedProduct, or UpdateProvisionedProduct).
", + "ListLaunchPaths": "Returns a paginated list of all paths to a specified product. A path is how the user has access to a specified product, and is necessary when provisioning a product. A path also determines the constraints put on the product.
", + "ListRecordHistory": "Returns a paginated list of all performed requests, in the form of RecordDetails objects that are filtered as specified.
", + "ProvisionProduct": "Requests a Provision of a specified product. A ProvisionedProduct is a resourced instance for a product. For example, provisioning a CloudFormation-template-backed product results in launching a CloudFormation stack and all the underlying resources that come with it.
You can check the status of this request using the DescribeRecord operation.
", + "ScanProvisionedProducts": "Returns a paginated list of all the ProvisionedProduct objects that are currently available (not terminated).
", + "SearchProducts": "Returns a paginated list all of the Products objects to which the caller has access.
The output of this operation can be used as input for other operations, such as DescribeProductView.
", + "TerminateProvisionedProduct": "Requests termination of an existing ProvisionedProduct object. If there are Tags associated with the object, they are terminated when the ProvisionedProduct object is terminated.
This operation does not delete any records associated with the ProvisionedProduct object.
You can check the status of this request using the DescribeRecord operation.
", + "UpdateProvisionedProduct": "Requests updates to the configuration of an existing ProvisionedProduct object. If there are tags associated with the object, they cannot be updated or added with this operation. Depending on the specific updates requested, this operation may update with no interruption, with some interruption, or replace the ProvisionedProduct object entirely.
You can check the status of this request using the DescribeRecord operation.
" + }, + "shapes": { + "AcceptLanguage": { + "base": null, + "refs": { + "DescribeProductInput$AcceptLanguage": "Optional language code. Supported language codes are as follows:
\"en\" (English)
\"jp\" (Japanese)
\"zh\" (Chinese)
If no code is specified, \"en\" is used as the default.
", + "DescribeProductViewInput$AcceptLanguage": "Optional language code. Supported language codes are as follows:
\"en\" (English)
\"jp\" (Japanese)
\"zh\" (Chinese)
If no code is specified, \"en\" is used as the default.
", + "DescribeProvisioningParametersInput$AcceptLanguage": "Optional language code. Supported language codes are as follows:
\"en\" (English)
\"jp\" (Japanese)
\"zh\" (Chinese)
If no code is specified, \"en\" is used as the default.
", + "DescribeRecordInput$AcceptLanguage": "Optional language code. Supported language codes are as follows:
\"en\" (English)
\"jp\" (Japanese)
\"zh\" (Chinese)
If no code is specified, \"en\" is used as the default.
", + "ListLaunchPathsInput$AcceptLanguage": "Optional language code. Supported language codes are as follows:
\"en\" (English)
\"jp\" (Japanese)
\"zh\" (Chinese)
If no code is specified, \"en\" is used as the default.
", + "ListRecordHistoryInput$AcceptLanguage": "Optional language code. Supported language codes are as follows:
\"en\" (English)
\"jp\" (Japanese)
\"zh\" (Chinese)
If no code is specified, \"en\" is used as the default.
", + "ProvisionProductInput$AcceptLanguage": "Optional language code. Supported language codes are as follows:
\"en\" (English)
\"jp\" (Japanese)
\"zh\" (Chinese)
If no code is specified, \"en\" is used as the default.
", + "ScanProvisionedProductsInput$AcceptLanguage": "Optional language code. Supported language codes are as follows:
\"en\" (English)
\"jp\" (Japanese)
\"zh\" (Chinese)
If no code is specified, \"en\" is used as the default.
", + "SearchProductsInput$AcceptLanguage": "Optional language code. Supported language codes are as follows:
\"en\" (English)
\"jp\" (Japanese)
\"zh\" (Chinese)
If no code is specified, \"en\" is used as the default.
", + "TerminateProvisionedProductInput$AcceptLanguage": "Optional language code. Supported language codes are as follows:
\"en\" (English)
\"jp\" (Japanese)
\"zh\" (Chinese)
If no code is specified, \"en\" is used as the default.
", + "UpdateProvisionedProductInput$AcceptLanguage": "Optional language code. Supported language codes are as follows:
\"en\" (English)
\"jp\" (Japanese)
\"zh\" (Chinese)
If no code is specified, \"en\" is used as the default.
" + } + }, + "AllowedValue": { + "base": null, + "refs": { + "AllowedValues$member": null + } + }, + "AllowedValues": { + "base": null, + "refs": { + "ParameterConstraints$AllowedValues": "The values that the administrator has allowed for the parameter.
" + } + }, + "ApproximateCount": { + "base": null, + "refs": { + "ProductViewAggregationValue$ApproximateCount": "An approximate count of the products that match the value.
" + } + }, + "AttributeValue": { + "base": null, + "refs": { + "ProductViewAggregationValue$Value": "The value of the product view aggregation.
" + } + }, + "ConstraintDescription": { + "base": null, + "refs": { + "ConstraintSummary$Description": "The text description of the constraint.
" + } + }, + "ConstraintSummaries": { + "base": null, + "refs": { + "DescribeProvisioningParametersOutput$ConstraintSummaries": "The list of constraint summaries that apply to provisioning this product.
", + "LaunchPathSummary$ConstraintSummaries": "List of constraints on the portfolio-product relationship.
" + } + }, + "ConstraintSummary": { + "base": "An administrator-specified constraint to apply when provisioning a product.
", + "refs": { + "ConstraintSummaries$member": null + } + }, + "ConstraintType": { + "base": null, + "refs": { + "ConstraintSummary$Type": "The type of the constraint.
" + } + }, + "CreatedTime": { + "base": null, + "refs": { + "ProvisionedProductDetail$CreatedTime": "The time the ProvisionedProduct was created.
", + "RecordDetail$CreatedTime": "The time when the record for the ProvisionedProduct object was created.
" + } + }, + "DefaultValue": { + "base": null, + "refs": { + "ProvisioningArtifactParameter$DefaultValue": "The default value for this parameter.
" + } + }, + "DescribeProductInput": { + "base": null, + "refs": { + } + }, + "DescribeProductOutput": { + "base": null, + "refs": { + } + }, + "DescribeProductViewInput": { + "base": null, + "refs": { + } + }, + "DescribeProductViewOutput": { + "base": null, + "refs": { + } + }, + "DescribeProvisioningParametersInput": { + "base": null, + "refs": { + } + }, + "DescribeProvisioningParametersOutput": { + "base": null, + "refs": { + } + }, + "DescribeRecordInput": { + "base": null, + "refs": { + } + }, + "DescribeRecordOutput": { + "base": null, + "refs": { + } + }, + "Description": { + "base": null, + "refs": { + "ProvisioningArtifactParameter$Description": "The text description of the parameter.
", + "RecordOutput$Description": "The text description of the output.
" + } + }, + "DuplicateResourceException": { + "base": "The specified resource is a duplicate.
", + "refs": { + } + }, + "ErrorCode": { + "base": null, + "refs": { + "RecordError$Code": "The numeric value of the error.
" + } + }, + "ErrorDescription": { + "base": null, + "refs": { + "RecordError$Description": "The text description of the error.
" + } + }, + "HasDefaultPath": { + "base": null, + "refs": { + "ProductViewSummary$HasDefaultPath": "A value of false indicates that the product does not have a default path, while a value of true indicates that it does. If it's false, call ListLaunchPaths to disambiguate between paths. If true, ListLaunchPaths is not required, and the output of the ProductViewSummary operation can be used directly with DescribeProvisioningParameters.
The ProductId of the product to describe.
The ProductViewId of the product to describe.
The identifier of the product.
", + "DescribeProvisioningParametersInput$ProvisioningArtifactId": "The provisioning artifact identifier for this product.
", + "DescribeProvisioningParametersInput$PathId": "The identifier of the path for this product's provisioning. This value is optional if the product has a default path, and is required if there is more than one path for the specified product.
", + "DescribeRecordInput$Id": "The record identifier of the ProvisionedProduct object for which to retrieve output information. This is the RecordDetail.RecordId obtained from the request operation's response.
The unique identifier of the product path.
", + "ListLaunchPathsInput$ProductId": "Identifies the product for which to retrieve LaunchPathSummaries information.
The product view identifier.
", + "ProductViewSummary$ProductId": "The product identifier.
", + "ProvisionProductInput$ProductId": "The identifier of the product.
", + "ProvisionProductInput$ProvisioningArtifactId": "The provisioning artifact identifier for this product.
", + "ProvisionProductInput$PathId": "The identifier of the path for this product's provisioning. This value is optional if the product has a default path, and is required if there is more than one path for the specified product.
", + "ProvisioningArtifact$Id": "The identifier for the artifact.
", + "RecordDetail$RecordId": "The identifier of the ProvisionedProduct object record.
", + "RecordDetail$ProvisionedProductId": "The identifier of the ProvisionedProduct object.
", + "RecordDetail$ProductId": "The identifier of the product.
", + "RecordDetail$ProvisioningArtifactId": "The provisioning artifact identifier for this product.
", + "RecordDetail$PathId": "The identifier of the path for this product's provisioning.
", + "TerminateProvisionedProductInput$ProvisionedProductId": "The identifier of the ProvisionedProduct object to terminate. You must specify either ProvisionedProductName or ProvisionedProductId, but not both.
The identifier of the ProvisionedProduct object to update. You must specify either ProvisionedProductName or ProvisionedProductId, but not both.
The identifier of the ProvisionedProduct object.
", + "UpdateProvisionedProductInput$ProvisioningArtifactId": "The provisioning artifact identifier for this product.
", + "UpdateProvisionedProductInput$PathId": "The identifier of the path to use in the updated ProvisionedProduct object. This value is optional if the product has a default path, and is required if there is more than one path for the specified product.
" + } + }, + "IdempotencyToken": { + "base": null, + "refs": { + "ProvisionProductInput$ProvisionToken": "An idempotency token that uniquely identifies the provisioning request.
", + "ProvisionedProductDetail$IdempotencyToken": "An idempotency token that uniquely identifies this ProvisionedProduct.
", + "TerminateProvisionedProductInput$TerminateToken": "An idempotency token that uniquely identifies the termination request. This token is only valid during the termination process. After the ProvisionedProduct object is terminated, further requests to terminate the same ProvisionedProduct object always return ResourceNotFound regardless of the value of TerminateToken.
The idempotency token that uniquely identifies the provisioning update request.
" + } + }, + "IgnoreErrors": { + "base": null, + "refs": { + "TerminateProvisionedProductInput$IgnoreErrors": "Optional Boolean parameter. If set to true, AWS Service Catalog stops managing the specified ProvisionedProduct object even if it cannot delete the underlying resources.
" + } + }, + "InstructionType": { + "base": null, + "refs": { + "UsageInstruction$Type": "The usage instruction type for the value.
" + } + }, + "InstructionValue": { + "base": null, + "refs": { + "UsageInstruction$Value": "The usage instruction value for this type.
" + } + }, + "InvalidParametersException": { + "base": "One or more parameters provided to the operation are invalid.
", + "refs": { + } + }, + "LastRequestId": { + "base": null, + "refs": { + "ProvisionedProductDetail$LastRecordId": "The record identifier of the last request performed on this ProvisionedProduct object.
" + } + }, + "LaunchPathSummaries": { + "base": null, + "refs": { + "ListLaunchPathsOutput$LaunchPathSummaries": "List of launch path information summaries for the specified PageToken.
Summary information about a path for a user to have access to a specified product.
", + "refs": { + "LaunchPathSummaries$member": null + } + }, + "ListLaunchPathsInput": { + "base": null, + "refs": { + } + }, + "ListLaunchPathsOutput": { + "base": null, + "refs": { + } + }, + "ListRecordHistoryInput": { + "base": null, + "refs": { + } + }, + "ListRecordHistoryOutput": { + "base": null, + "refs": { + } + }, + "ListRecordHistorySearchFilter": { + "base": "The search filter to limit results when listing request history records.
", + "refs": { + "ListRecordHistoryInput$SearchFilter": "(Optional) The filter to limit search results.
" + } + }, + "NoEcho": { + "base": null, + "refs": { + "ProvisioningArtifactParameter$IsNoEcho": "If this value is true, the value for this parameter is obfuscated from view when the parameter is retrieved. This parameter is used to hide sensitive information.
" + } + }, + "NotificationArn": { + "base": null, + "refs": { + "NotificationArns$member": null + } + }, + "NotificationArns": { + "base": null, + "refs": { + "ProvisionProductInput$NotificationArns": "Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.
" + } + }, + "OutputKey": { + "base": null, + "refs": { + "RecordOutput$OutputKey": "The output key.
" + } + }, + "OutputValue": { + "base": null, + "refs": { + "RecordOutput$OutputValue": "The output value.
" + } + }, + "PageSize": { + "base": null, + "refs": { + "DescribeRecordInput$PageSize": "The maximum number of items to return in the results. If more results exist than fit in the specified PageSize, the value of NextPageToken in the response is non-null.
The maximum number of items to return in the results. If more results exist than fit in the specified PageSize, the value of NextPageToken in the response is non-null.
The maximum number of items to return in the results. If more results exist than fit in the specified PageSize, the value of NextPageToken in the response is non-null.
The maximum number of items to return in the results. If more results exist than fit in the specified PageSize, the value of NextPageToken in the response is non-null.
The maximum number of items to return in the results. If more results exist than fit in the specified PageSize, the value of NextPageToken in the response is non-null.
The page token of the first page retrieve. If null, this retrieves the first page of size PageSize.
The page token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
", + "ListLaunchPathsInput$PageToken": "The page token of the first page retrieve. If null, this retrieves the first page of size PageSize.
The page token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
", + "ListRecordHistoryInput$PageToken": "The page token of the first page retrieve. If null, this retrieves the first page of size PageSize.
The page token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
", + "ScanProvisionedProductsInput$PageToken": "The page token of the first page retrieve. If null, this retrieves the first page of size PageSize.
The page token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
", + "SearchProductsInput$PageToken": "The page token of the first page retrieve. If null, this retrieves the first page of size PageSize.
The page token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
" + } + }, + "ParameterConstraints": { + "base": "The constraints that the administrator has put on the parameter.
", + "refs": { + "ProvisioningArtifactParameter$ParameterConstraints": "The list of constraints that the administrator has put on the parameter.
" + } + }, + "ParameterKey": { + "base": null, + "refs": { + "ProvisioningArtifactParameter$ParameterKey": "The parameter key.
", + "ProvisioningParameter$Key": "The ProvisioningArtifactParameter.ParameterKey parameter from DescribeProvisioningParameters.
The ProvisioningArtifactParameter.ParameterKey parameter from DescribeProvisioningParameters.
The parameter type.
" + } + }, + "ParameterValue": { + "base": null, + "refs": { + "ProvisioningParameter$Value": "The value to use for provisioning. Any constraints on this value can be found in ProvisioningArtifactParameter for Key.
The value to use for updating the product provisioning. Any constraints on this value can be found in the ProvisioningArtifactParameter parameter for Key.
Corresponds to the name of the portfolio to which the user was assigned.
" + } + }, + "ProductType": { + "base": null, + "refs": { + "ProductViewSummary$Type": "The product type. Contact the product administrator for the significance of this value.
" + } + }, + "ProductViewAggregationType": { + "base": null, + "refs": { + "ProductViewAggregations$key": null + } + }, + "ProductViewAggregationValue": { + "base": "A single product view aggregation value/count pair, containing metadata about each product to which the calling user has access.
", + "refs": { + "ProductViewAggregationValues$member": null + } + }, + "ProductViewAggregationValues": { + "base": null, + "refs": { + "ProductViewAggregations$value": null + } + }, + "ProductViewAggregations": { + "base": null, + "refs": { + "SearchProductsOutput$ProductViewAggregations": "A list of the product view aggregation value objects.
" + } + }, + "ProductViewDistributor": { + "base": null, + "refs": { + "ProductViewSummary$Distributor": "The distributor of the product. Contact the product administrator for the significance of this value.
" + } + }, + "ProductViewFilterBy": { + "base": null, + "refs": { + "ProductViewFilters$key": null + } + }, + "ProductViewFilterValue": { + "base": null, + "refs": { + "ProductViewFilterValues$member": null + } + }, + "ProductViewFilterValues": { + "base": null, + "refs": { + "ProductViewFilters$value": null + } + }, + "ProductViewFilters": { + "base": null, + "refs": { + "SearchProductsInput$Filters": "(Optional) The list of filters with which to limit search results. If no search filters are specified, the output is all the products to which the calling user has access.
" + } + }, + "ProductViewName": { + "base": null, + "refs": { + "ProductViewSummary$Name": "The name of the product.
" + } + }, + "ProductViewOwner": { + "base": null, + "refs": { + "ProductViewSummary$Owner": "The owner of the product. Contact the product administrator for the significance of this value.
" + } + }, + "ProductViewShortDescription": { + "base": null, + "refs": { + "ProductViewSummary$ShortDescription": "Short description of the product.
" + } + }, + "ProductViewSortBy": { + "base": null, + "refs": { + "SearchProductsInput$SortBy": "(Optional) The sort field specifier. If no value is specified, results are not sorted.
" + } + }, + "ProductViewSummaries": { + "base": null, + "refs": { + "SearchProductsOutput$ProductViewSummaries": "A list of the product view summary objects.
" + } + }, + "ProductViewSummary": { + "base": "The summary metadata about the specified product.
", + "refs": { + "DescribeProductOutput$ProductViewSummary": "The summary metadata about the specified product.
", + "DescribeProductViewOutput$ProductViewSummary": "The summary metadata about the specified product.
", + "ProductViewSummaries$member": null + } + }, + "ProvisionProductInput": { + "base": null, + "refs": { + } + }, + "ProvisionProductOutput": { + "base": null, + "refs": { + } + }, + "ProvisionedProductDetail": { + "base": "Detailed information about a ProvisionedProduct object.
", + "refs": { + "ProvisionedProductDetails$member": null + } + }, + "ProvisionedProductDetails": { + "base": null, + "refs": { + "ScanProvisionedProductsOutput$ProvisionedProducts": "A list of ProvisionedProduct detail objects.
" + } + }, + "ProvisionedProductId": { + "base": null, + "refs": { + "ProvisionedProductDetail$Id": "The identifier of the ProvisionedProduct object.
" + } + }, + "ProvisionedProductName": { + "base": null, + "refs": { + "ProvisionProductInput$ProvisionedProductName": "A user-friendly name to identify the ProvisionedProduct object. This value must be unique for the AWS account and cannot be updated after the product is provisioned.
", + "RecordDetail$ProvisionedProductName": "The user-friendly name of the ProvisionedProduct object.
" + } + }, + "ProvisionedProductNameOrArn": { + "base": null, + "refs": { + "ProvisionedProductDetail$Name": "The user-friendly name of the ProvisionedProduct object.
", + "ProvisionedProductDetail$Arn": "The ARN associated with the ProvisionedProduct object.
", + "TerminateProvisionedProductInput$ProvisionedProductName": "The name of the ProvisionedProduct object to terminate. You must specify either ProvisionedProductName or ProvisionedProductId, but not both.
The updated name of the ProvisionedProduct object . You must specify either ProvisionedProductName or ProvisionedProductId, but not both.
The current status message of the ProvisionedProduct.
" + } + }, + "ProvisionedProductType": { + "base": null, + "refs": { + "ProvisionedProductDetail$Type": "The type of the ProvisionedProduct object.
", + "RecordDetail$ProvisionedProductType": "The type of the ProvisionedProduct object.
" + } + }, + "ProvisioningArtifact": { + "base": "Contains information indicating the ways in which a product can be provisioned.
", + "refs": { + "ProvisioningArtifacts$member": null + } + }, + "ProvisioningArtifactCreatedTime": { + "base": null, + "refs": { + "ProvisioningArtifact$CreatedTime": "The time that the artifact was created by the Administrator.
" + } + }, + "ProvisioningArtifactDescription": { + "base": null, + "refs": { + "ProvisioningArtifact$Description": "The text description of the artifact.
" + } + }, + "ProvisioningArtifactName": { + "base": null, + "refs": { + "ProvisioningArtifact$Name": "The name of the artifact.
" + } + }, + "ProvisioningArtifactParameter": { + "base": "A parameter used to successfully provision the product. This value includes a list of allowable values and additional metadata.
", + "refs": { + "ProvisioningArtifactParameters$member": null + } + }, + "ProvisioningArtifactParameters": { + "base": null, + "refs": { + "DescribeProvisioningParametersOutput$ProvisioningArtifactParameters": "The list of parameters used to successfully provision the product. Each parameter includes a list of allowable values and additional metadata about each parameter.
" + } + }, + "ProvisioningArtifacts": { + "base": null, + "refs": { + "DescribeProductOutput$ProvisioningArtifacts": "A list of provisioning artifact objects for the specified product. The ProvisioningArtifacts parameter represent the ways the specified product can be provisioned.
A list of provisioning artifact objects for the specified product. The ProvisioningArtifacts represent the ways in which the specified product can be provisioned.
The arameter key/value pairs used to provision a product.
", + "refs": { + "ProvisioningParameters$member": null + } + }, + "ProvisioningParameters": { + "base": null, + "refs": { + "ProvisionProductInput$ProvisioningParameters": "Parameters specified by the administrator that are required for provisioning the product.
" + } + }, + "RecordDetail": { + "base": "The full details of a specific ProvisionedProduct object.
", + "refs": { + "DescribeRecordOutput$RecordDetail": "Detailed record information for the specified product.
", + "ProvisionProductOutput$RecordDetail": "The detailed result of the ProvisionProduct request, containing the inputs made to that request, the current state of the request, a pointer to the ProvisionedProduct object of the request, and a list of any errors that the request encountered.
", + "RecordDetails$member": null, + "TerminateProvisionedProductOutput$RecordDetail": "The detailed result of the TerminateProvisionedProduct request, containing the inputs made to that request, the current state of the request, a pointer to the ProvisionedProduct object that the request is modifying, and a list of any errors that the request encountered.
", + "UpdateProvisionedProductOutput$RecordDetail": "The detailed result of the UpdateProvisionedProduct request, containing the inputs made to that request, the current state of the request, a pointer to the ProvisionedProduct object that the request is modifying, and a list of any errors that the request encountered.
" + } + }, + "RecordDetails": { + "base": null, + "refs": { + "ListRecordHistoryOutput$RecordDetails": "A list of record detail objects, listed in reverse chronological order.
" + } + }, + "RecordError": { + "base": "The error code and description resulting from an operation.
", + "refs": { + "RecordErrors$member": null + } + }, + "RecordErrors": { + "base": null, + "refs": { + "RecordDetail$RecordErrors": "A list of errors that occurred while processing the request.
" + } + }, + "RecordOutput": { + "base": "An output for the specified Product object created as the result of a request. For example, a CloudFormation-backed product that creates an S3 bucket would have an output for the S3 bucket URL.
", + "refs": { + "RecordOutputs$member": null + } + }, + "RecordOutputs": { + "base": null, + "refs": { + "DescribeRecordOutput$RecordOutputs": "A list of outputs for the specified Product object created as the result of a request. For example, a CloudFormation-backed product that creates an S3 bucket would have an output for the S3 bucket URL.
" + } + }, + "RecordStatus": { + "base": null, + "refs": { + "ProvisionedProductDetail$Status": "The current status of the ProvisionedProduct.
", + "RecordDetail$Status": "The status of the ProvisionedProduct object.
" + } + }, + "RecordTag": { + "base": "A tag associated with the record, stored as a key-value pair.
", + "refs": { + "RecordTags$member": null + } + }, + "RecordTagKey": { + "base": null, + "refs": { + "RecordTag$Key": "The key for this tag.
" + } + }, + "RecordTagValue": { + "base": null, + "refs": { + "RecordTag$Value": "The value for this tag.
" + } + }, + "RecordTags": { + "base": null, + "refs": { + "RecordDetail$RecordTags": "List of tags associated with this record.
" + } + }, + "RecordType": { + "base": null, + "refs": { + "RecordDetail$RecordType": "The record type for this record.
" + } + }, + "ResourceNotFoundException": { + "base": "The specified resource was not found.
", + "refs": { + } + }, + "ScanProvisionedProductsInput": { + "base": null, + "refs": { + } + }, + "ScanProvisionedProductsOutput": { + "base": null, + "refs": { + } + }, + "SearchFilterKey": { + "base": null, + "refs": { + "ListRecordHistorySearchFilter$Key": "The filter key.
" + } + }, + "SearchFilterValue": { + "base": null, + "refs": { + "ListRecordHistorySearchFilter$Value": "The filter value for Key.
(Optional) The sort order specifier. If no value is specified, results are not sorted.
" + } + }, + "SupportDescription": { + "base": null, + "refs": { + "ProductViewSummary$SupportDescription": "The description of the support for this Product.
" + } + }, + "SupportEmail": { + "base": null, + "refs": { + "ProductViewSummary$SupportEmail": "The email contact information to obtain support for this Product.
" + } + }, + "SupportUrl": { + "base": null, + "refs": { + "ProductViewSummary$SupportUrl": "The URL information to obtain support for this Product.
" + } + }, + "Tag": { + "base": "Optional key/value pairs to associate with this provisioning. These tags are propagated to the resources created in the provisioning.
", + "refs": { + "Tags$member": null + } + }, + "TagKey": { + "base": null, + "refs": { + "Tag$Key": "The ProvisioningArtifactParameter.TagKey parameter from DescribeProvisioningParameters.
The esired value for this key.
" + } + }, + "Tags": { + "base": null, + "refs": { + "LaunchPathSummary$Tags": "List of tags used by this launch path.
", + "ProvisionProductInput$Tags": "(Optional) A list of tags to use as provisioning options.
" + } + }, + "TerminateProvisionedProductInput": { + "base": null, + "refs": { + } + }, + "TerminateProvisionedProductOutput": { + "base": null, + "refs": { + } + }, + "UpdateProvisionedProductInput": { + "base": null, + "refs": { + } + }, + "UpdateProvisionedProductOutput": { + "base": null, + "refs": { + } + }, + "UpdateProvisioningParameter": { + "base": "The parameter key/value pair used to update a ProvisionedProduct object. If UsePreviousValue is set to true, Value is ignored and the value for Key is kept as previously set (current value).
A list of ProvisioningParameter objects used to update the ProvisionedProduct object.
The time when the record for the ProvisionedProduct object was last updated.
" + } + }, + "UsageInstruction": { + "base": "Additional information provided by the administrator.
", + "refs": { + "UsageInstructions$member": null + } + }, + "UsageInstructions": { + "base": null, + "refs": { + "DescribeProvisioningParametersOutput$UsageInstructions": "Any additional metadata specifically related to the provisioning of the product. For example, see the Version field of the CloudFormation template.
If true, uses the currently set value for Key, ignoring UpdateProvisioningParameter.Value.
Amazon Simple Notification Service (Amazon SNS) is a web service that enables you to build distributed web-enabled applications. Applications can use Amazon SNS to easily push real-time notification messages to interested subscribers over multiple delivery protocols. For more information about this product see http://aws.amazon.com/sns. For detailed information about Amazon SNS features and their associated API calls, see the Amazon SNS Developer Guide.
We also provide SDKs that enable you to access Amazon SNS from your preferred programming language. The SDKs contain functionality that automatically takes care of tasks such as: cryptographically signing your service requests, retrying requests, and handling error responses. For a list of available SDKs, go to Tools for Amazon Web Services.
", + "operations": { + "AddPermission": "Adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions.
", + "CheckIfPhoneNumberIsOptedOut": "Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your account. You cannot send SMS messages to a number that is opted out.
To resume sending messages, you can opt in the number by using the OptInPhoneNumber action.
Verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an earlier Subscribe action. If the token is valid, the action creates a new subscription and returns its Amazon Resource Name (ARN). This call requires an AWS signature only when the AuthenticateOnUnsubscribe flag is set to \"true\".
Creates a platform application object for one of the supported push notification services, such as APNS and GCM, to which devices and mobile apps may register. You must specify PlatformPrincipal and PlatformCredential attributes when using the CreatePlatformApplication action. The PlatformPrincipal is received from the notification service. For APNS/APNS_SANDBOX, PlatformPrincipal is \"SSL certificate\". For GCM, PlatformPrincipal is not applicable. For ADM, PlatformPrincipal is \"client id\". The PlatformCredential is also received from the notification service. For WNS, PlatformPrincipal is \"Package Security Identifier\". For MPNS, PlatformPrincipal is \"TLS certificate\". For Baidu, PlatformPrincipal is \"API key\".
For APNS/APNS_SANDBOX, PlatformCredential is \"private key\". For GCM, PlatformCredential is \"API key\". For ADM, PlatformCredential is \"client secret\". For WNS, PlatformCredential is \"secret key\". For MPNS, PlatformCredential is \"private key\". For Baidu, PlatformCredential is \"secret key\". The PlatformApplicationArn that is returned when using CreatePlatformApplication is then used as an attribute for the CreatePlatformEndpoint action. For more information, see Using Amazon SNS Mobile Push Notifications. For more information about obtaining the PlatformPrincipal and PlatformCredential for each of the supported push notification services, see Getting Started with Apple Push Notification Service, Getting Started with Amazon Device Messaging, Getting Started with Baidu Cloud Push, Getting Started with Google Cloud Messaging for Android, Getting Started with MPNS, or Getting Started with WNS.
Creates an endpoint for a device and mobile app on one of the supported push notification services, such as GCM and APNS. CreatePlatformEndpoint requires the PlatformApplicationArn that is returned from CreatePlatformApplication. The EndpointArn that is returned when using CreatePlatformEndpoint can then be used by the Publish action to send a message to a mobile app or by the Subscribe action for subscription to a topic. The CreatePlatformEndpoint action is idempotent, so if the requester already owns an endpoint with the same device token and attributes, that endpoint's ARN is returned without creating a new endpoint. For more information, see Using Amazon SNS Mobile Push Notifications.
When using CreatePlatformEndpoint with Baidu, two attributes must be provided: ChannelId and UserId. The token field must also contain the ChannelId. For more information, see Creating an Amazon SNS Endpoint for Baidu.
Creates a topic to which notifications can be published. Users can create at most 100,000 topics. For more information, see http://aws.amazon.com/sns. This action is idempotent, so if the requester already owns a topic with the specified name, that topic's ARN is returned without creating a new topic.
", + "DeleteEndpoint": "Deletes the endpoint for a device and mobile app from Amazon SNS. This action is idempotent. For more information, see Using Amazon SNS Mobile Push Notifications.
When you delete an endpoint that is also subscribed to a topic, then you must also unsubscribe the endpoint from the topic.
", + "DeletePlatformApplication": "Deletes a platform application object for one of the supported push notification services, such as APNS and GCM. For more information, see Using Amazon SNS Mobile Push Notifications.
", + "DeleteTopic": "Deletes a topic and all its subscriptions. Deleting a topic might prevent some messages previously sent to the topic from being delivered to subscribers. This action is idempotent, so deleting a topic that does not exist does not result in an error.
", + "GetEndpointAttributes": "Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM and APNS. For more information, see Using Amazon SNS Mobile Push Notifications.
", + "GetPlatformApplicationAttributes": "Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and GCM. For more information, see Using Amazon SNS Mobile Push Notifications.
", + "GetSMSAttributes": "Returns the settings for sending SMS messages from your account.
These settings are set with the SetSMSAttributes action.
Returns all of the properties of a subscription.
", + "GetTopicAttributes": "Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user.
", + "ListEndpointsByPlatformApplication": "Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM and APNS. The results for ListEndpointsByPlatformApplication are paginated and return a limited list of endpoints, up to 100. If additional records are available after the first page results, then a NextToken string will be returned. To receive the next page, you call ListEndpointsByPlatformApplication again using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null. For more information, see Using Amazon SNS Mobile Push Notifications.
Returns a list of phone numbers that are opted out, meaning you cannot send SMS messages to them.
The results for ListPhoneNumbersOptedOut are paginated, and each page returns up to 100 phone numbers. If additional phone numbers are available after the first page of results, then a NextToken string will be returned. To receive the next page, you call ListPhoneNumbersOptedOut again using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null.
Lists the platform application objects for the supported push notification services, such as APNS and GCM. The results for ListPlatformApplications are paginated and return a limited list of applications, up to 100. If additional records are available after the first page results, then a NextToken string will be returned. To receive the next page, you call ListPlatformApplications using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null. For more information, see Using Amazon SNS Mobile Push Notifications.
Returns a list of the requester's subscriptions. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a NextToken is also returned. Use the NextToken parameter in a new ListSubscriptions call to get further results.
Returns a list of the subscriptions to a specific topic. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a NextToken is also returned. Use the NextToken parameter in a new ListSubscriptionsByTopic call to get further results.
Returns a list of the requester's topics. Each call returns a limited list of topics, up to 100. If there are more topics, a NextToken is also returned. Use the NextToken parameter in a new ListTopics call to get further results.
Use this request to opt in a phone number that is opted out, which enables you to resume sending SMS messages to the number.
You can opt in a phone number only once every 30 days.
", + "Publish": "Sends a message to all of a topic's subscribed endpoints. When a messageId is returned, the message has been saved and Amazon SNS will attempt to deliver it to the topic's subscribers shortly. The format of the outgoing message to each subscribed endpoint depends on the notification protocol.
To use the Publish action for sending a message to a mobile endpoint, such as an app on a Kindle device or mobile phone, you must specify the EndpointArn for the TargetArn parameter. The EndpointArn is returned when making a call with the CreatePlatformEndpoint action. The second example below shows a request and response for publishing to a mobile endpoint.
For more information about formatting messages, see Send Custom Platform-Specific Payloads in Messages to Mobile Devices.
", + "RemovePermission": "Removes a statement from a topic's access control policy.
", + "SetEndpointAttributes": "Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM and APNS. For more information, see Using Amazon SNS Mobile Push Notifications.
", + "SetPlatformApplicationAttributes": "Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM. For more information, see Using Amazon SNS Mobile Push Notifications. For information on configuring attributes for message delivery status, see Using Amazon SNS Application Attributes for Message Delivery Status.
", + "SetSMSAttributes": "Use this request to set the default settings for sending SMS messages and receiving daily SMS usage reports.
You can override some of these settings for a single message when you use the Publish action with the MessageAttributes.entry.N parameter. For more information, see Sending an SMS Message in the Amazon SNS Developer Guide.
Allows a subscription owner to set an attribute of the topic to a new value.
", + "SetTopicAttributes": "Allows a topic owner to set an attribute of the topic to a new value.
", + "Subscribe": "Prepares to subscribe an endpoint by sending the endpoint a confirmation message. To actually create a subscription, the endpoint owner must call the ConfirmSubscription action with the token from the confirmation message. Confirmation tokens are valid for three days.
Deletes a subscription. If the subscription requires authentication for deletion, only the owner of the subscription or the topic's owner can unsubscribe, and an AWS signature is required. If the Unsubscribe call does not require authentication and the requester is not the subscription owner, a final cancellation message is delivered to the endpoint, so that the endpoint owner can easily resubscribe to the topic if the Unsubscribe request was unintended.
The action you want to allow for the specified principal(s).
Valid values: any Amazon SNS action name.
" + } + }, + "AddPermissionInput": { + "base": null, + "refs": { + } + }, + "AuthorizationErrorException": { + "base": "Indicates that the user has been denied access to the requested resource.
", + "refs": { + } + }, + "Binary": { + "base": null, + "refs": { + "MessageAttributeValue$BinaryValue": "Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images.
" + } + }, + "CheckIfPhoneNumberIsOptedOutInput": { + "base": "The input for the CheckIfPhoneNumberIsOptedOut action.
The response from the CheckIfPhoneNumberIsOptedOut action.
Input for ConfirmSubscription action.
", + "refs": { + } + }, + "ConfirmSubscriptionResponse": { + "base": "Response for ConfirmSubscriptions action.
", + "refs": { + } + }, + "CreateEndpointResponse": { + "base": "Response from CreateEndpoint action.
", + "refs": { + } + }, + "CreatePlatformApplicationInput": { + "base": "Input for CreatePlatformApplication action.
", + "refs": { + } + }, + "CreatePlatformApplicationResponse": { + "base": "Response from CreatePlatformApplication action.
", + "refs": { + } + }, + "CreatePlatformEndpointInput": { + "base": "Input for CreatePlatformEndpoint action.
", + "refs": { + } + }, + "CreateTopicInput": { + "base": "Input for CreateTopic action.
", + "refs": { + } + }, + "CreateTopicResponse": { + "base": "Response from CreateTopic action.
", + "refs": { + } + }, + "DelegatesList": { + "base": null, + "refs": { + "AddPermissionInput$AWSAccountId": "The AWS account IDs of the users (principals) who will be given access to the specified actions. The users must have AWS accounts, but do not need to be signed up for this service.
" + } + }, + "DeleteEndpointInput": { + "base": "Input for DeleteEndpoint action.
", + "refs": { + } + }, + "DeletePlatformApplicationInput": { + "base": "Input for DeletePlatformApplication action.
", + "refs": { + } + }, + "DeleteTopicInput": { + "base": null, + "refs": { + } + }, + "Endpoint": { + "base": "Endpoint for mobile app and device.
", + "refs": { + "ListOfEndpoints$member": null + } + }, + "EndpointDisabledException": { + "base": "Exception error indicating endpoint disabled.
", + "refs": { + } + }, + "GetEndpointAttributesInput": { + "base": "Input for GetEndpointAttributes action.
", + "refs": { + } + }, + "GetEndpointAttributesResponse": { + "base": "Response from GetEndpointAttributes of the EndpointArn.
", + "refs": { + } + }, + "GetPlatformApplicationAttributesInput": { + "base": "Input for GetPlatformApplicationAttributes action.
", + "refs": { + } + }, + "GetPlatformApplicationAttributesResponse": { + "base": "Response for GetPlatformApplicationAttributes action.
", + "refs": { + } + }, + "GetSMSAttributesInput": { + "base": "The input for the GetSMSAttributes request.
The response from the GetSMSAttributes request.
Input for GetSubscriptionAttributes.
", + "refs": { + } + }, + "GetSubscriptionAttributesResponse": { + "base": "Response for GetSubscriptionAttributes action.
", + "refs": { + } + }, + "GetTopicAttributesInput": { + "base": "Input for GetTopicAttributes action.
", + "refs": { + } + }, + "GetTopicAttributesResponse": { + "base": "Response for GetTopicAttributes action.
", + "refs": { + } + }, + "InternalErrorException": { + "base": "Indicates an internal service error.
", + "refs": { + } + }, + "InvalidParameterException": { + "base": "Indicates that a request parameter does not comply with the associated constraints.
", + "refs": { + } + }, + "InvalidParameterValueException": { + "base": "Indicates that a request parameter does not comply with the associated constraints.
", + "refs": { + } + }, + "ListEndpointsByPlatformApplicationInput": { + "base": "Input for ListEndpointsByPlatformApplication action.
", + "refs": { + } + }, + "ListEndpointsByPlatformApplicationResponse": { + "base": "Response for ListEndpointsByPlatformApplication action.
", + "refs": { + } + }, + "ListOfEndpoints": { + "base": null, + "refs": { + "ListEndpointsByPlatformApplicationResponse$Endpoints": "Endpoints returned for ListEndpointsByPlatformApplication action.
" + } + }, + "ListOfPlatformApplications": { + "base": null, + "refs": { + "ListPlatformApplicationsResponse$PlatformApplications": "Platform applications returned when calling ListPlatformApplications action.
" + } + }, + "ListPhoneNumbersOptedOutInput": { + "base": "The input for the ListPhoneNumbersOptedOut action.
The response from the ListPhoneNumbersOptedOut action.
Input for ListPlatformApplications action.
", + "refs": { + } + }, + "ListPlatformApplicationsResponse": { + "base": "Response for ListPlatformApplications action.
", + "refs": { + } + }, + "ListString": { + "base": null, + "refs": { + "GetSMSAttributesInput$attributes": "A list of the individual attribute names, such as MonthlySpendLimit, for which you want values.
For all attribute names, see SetSMSAttributes.
If you don't use this parameter, Amazon SNS returns all SMS attributes.
" + } + }, + "ListSubscriptionsByTopicInput": { + "base": "Input for ListSubscriptionsByTopic action.
", + "refs": { + } + }, + "ListSubscriptionsByTopicResponse": { + "base": "Response for ListSubscriptionsByTopic action.
", + "refs": { + } + }, + "ListSubscriptionsInput": { + "base": "Input for ListSubscriptions action.
", + "refs": { + } + }, + "ListSubscriptionsResponse": { + "base": "Response for ListSubscriptions action
", + "refs": { + } + }, + "ListTopicsInput": { + "base": null, + "refs": { + } + }, + "ListTopicsResponse": { + "base": "Response for ListTopics action.
", + "refs": { + } + }, + "MapStringToString": { + "base": null, + "refs": { + "CreatePlatformApplicationInput$Attributes": "For a list of attributes, see SetPlatformApplicationAttributes
", + "CreatePlatformEndpointInput$Attributes": "For a list of attributes, see SetEndpointAttributes.
", + "Endpoint$Attributes": "Attributes for endpoint.
", + "GetEndpointAttributesResponse$Attributes": "Attributes include the following:
CustomUserData -- arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.
Enabled -- flag that enables/disables delivery to the endpoint. Amazon SNS will set this to false when a notification service indicates to Amazon SNS that the endpoint is invalid. Users can set it back to true, typically after updating Token.
Token -- device token, also referred to as a registration id, for an app and mobile device. This is returned from the notification service when an app and mobile device are registered with the notification service.
Attributes include the following:
EventEndpointCreated -- Topic ARN to which EndpointCreated event notifications should be sent.
EventEndpointDeleted -- Topic ARN to which EndpointDeleted event notifications should be sent.
EventEndpointUpdated -- Topic ARN to which EndpointUpdate event notifications should be sent.
EventDeliveryFailure -- Topic ARN to which DeliveryFailure event notifications should be sent upon Direct Publish delivery failure (permanent) to one of the application's endpoints.
The SMS attribute names and their values.
", + "PlatformApplication$Attributes": "Attributes for platform application object.
", + "SetEndpointAttributesInput$Attributes": "A map of the endpoint attributes. Attributes in this map include the following:
CustomUserData -- arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.
Enabled -- flag that enables/disables delivery to the endpoint. Amazon SNS will set this to false when a notification service indicates to Amazon SNS that the endpoint is invalid. Users can set it back to true, typically after updating Token.
Token -- device token, also referred to as a registration id, for an app and mobile device. This is returned from the notification service when an app and mobile device are registered with the notification service.
A map of the platform application attributes. Attributes in this map include the following:
PlatformCredential -- The credential received from the notification service. For APNS/APNS_SANDBOX, PlatformCredential is private key. For GCM, PlatformCredential is \"API key\". For ADM, PlatformCredential is \"client secret\".
PlatformPrincipal -- The principal received from the notification service. For APNS/APNS_SANDBOX, PlatformPrincipal is SSL certificate. For GCM, PlatformPrincipal is not applicable. For ADM, PlatformPrincipal is \"client id\".
EventEndpointCreated -- Topic ARN to which EndpointCreated event notifications should be sent.
EventEndpointDeleted -- Topic ARN to which EndpointDeleted event notifications should be sent.
EventEndpointUpdated -- Topic ARN to which EndpointUpdate event notifications should be sent.
EventDeliveryFailure -- Topic ARN to which DeliveryFailure event notifications should be sent upon Direct Publish delivery failure (permanent) to one of the application's endpoints.
SuccessFeedbackRoleArn -- IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf.
FailureFeedbackRoleArn -- IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf.
SuccessFeedbackSampleRate -- Sample rate percentage (0-100) of successfully delivered messages.
The default settings for sending SMS messages from your account. You can set values for the following attribute names:
MonthlySpendLimit – The maximum amount in USD that you are willing to spend each month to send SMS messages. When Amazon SNS determines that sending an SMS message would incur a cost that exceeds this limit, it stops sending SMS messages within minutes.
Amazon SNS stops sending SMS messages within minutes of the limit being crossed. During that interval, if you continue to send SMS messages, you will incur costs that exceed your limit.
DeliveryStatusIAMRole – The ARN of the IAM role that allows Amazon SNS to write logs about SMS deliveries in CloudWatch Logs. For each SMS message that you send, Amazon SNS writes a log that includes the message price, the success or failure status, the reason for failure (if the message failed), the message dwell time, and other information.
DeliveryStatusSuccessSamplingRate – The percentage of successful SMS deliveries for which Amazon SNS will write logs in CloudWatch Logs. The value can be an integer from 0 - 100. For example, to write logs only for failed deliveries, set this value to 0. To write logs for 10% of your successful deliveries, set it to 10.
DefaultSenderID – A string, such as your business brand, that is displayed as the sender on the receiving device. Support for sender IDs varies by country. The sender ID can be 1 - 11 alphanumeric characters, and it must contain at least one letter.
DefaultSMSType – The type of SMS message that you will send by default. You can assign the following values:
Promotional – Noncritical messages, such as marketing messages. Amazon SNS optimizes the message delivery to incur the lowest cost.
Transactional – (Default) Critical messages that support customer transactions, such as one-time passcodes for multi-factor authentication. Amazon SNS optimizes the message delivery to achieve the highest reliability.
UsageReportS3Bucket – The name of the Amazon S3 bucket to receive daily SMS usage reports from Amazon SNS. Each day, Amazon SNS will deliver a usage report as a CSV file to the bucket. The report includes the following information for each SMS message that was successfully delivered by your account:
Time that the message was published (in UTC)
Message ID
Destination phone number
Message type
Delivery status
Message price (in USD)
Part number (a message is split into multiple parts if it is too long for a single message)
Total number of parts
To receive the report, the bucket must have a policy that allows the Amazon SNS service principle to perform the s3:PutObject and s3:GetBucketLocation actions.
For an example bucket policy and usage report, see Viewing Statistics About SMS Message Delivery in the Amazon SNS Developer Guide.
" + } + }, + "MessageAttributeMap": { + "base": null, + "refs": { + "PublishInput$MessageAttributes": "Message attributes for Publish action.
" + } + }, + "MessageAttributeValue": { + "base": "The user-specified message attribute value. For string data types, the value attribute has the same restrictions on the content as the message body. For more information, see Publish.
Name, type, and value must not be empty or null. In addition, the message body should not be empty or null. All parts of the message attribute, including name, type, and value, are included in the message size restriction, which is currently 256 KB (262,144 bytes). For more information, see Using Amazon SNS Message Attributes.
", + "refs": { + "MessageAttributeMap$value": null + } + }, + "NotFoundException": { + "base": "Indicates that the requested resource does not exist.
", + "refs": { + } + }, + "OptInPhoneNumberInput": { + "base": "Input for the OptInPhoneNumber action.
", + "refs": { + } + }, + "OptInPhoneNumberResponse": { + "base": "The response for the OptInPhoneNumber action.
", + "refs": { + } + }, + "PhoneNumber": { + "base": null, + "refs": { + "CheckIfPhoneNumberIsOptedOutInput$phoneNumber": "The phone number for which you want to check the opt out status.
", + "OptInPhoneNumberInput$phoneNumber": "The phone number to opt in.
", + "PhoneNumberList$member": null + } + }, + "PhoneNumberList": { + "base": null, + "refs": { + "ListPhoneNumbersOptedOutResponse$phoneNumbers": "A list of phone numbers that are opted out of receiving SMS messages. The list is paginated, and each page can contain up to 100 phone numbers.
" + } + }, + "PlatformApplication": { + "base": "Platform application object.
", + "refs": { + "ListOfPlatformApplications$member": null + } + }, + "PlatformApplicationDisabledException": { + "base": "Exception error indicating platform application disabled.
", + "refs": { + } + }, + "PublishInput": { + "base": "Input for Publish action.
", + "refs": { + } + }, + "PublishResponse": { + "base": "Response for Publish action.
", + "refs": { + } + }, + "RemovePermissionInput": { + "base": "Input for RemovePermission action.
", + "refs": { + } + }, + "SetEndpointAttributesInput": { + "base": "Input for SetEndpointAttributes action.
", + "refs": { + } + }, + "SetPlatformApplicationAttributesInput": { + "base": "Input for SetPlatformApplicationAttributes action.
", + "refs": { + } + }, + "SetSMSAttributesInput": { + "base": "The input for the SetSMSAttributes action.
", + "refs": { + } + }, + "SetSMSAttributesResponse": { + "base": "The response for the SetSMSAttributes action.
", + "refs": { + } + }, + "SetSubscriptionAttributesInput": { + "base": "Input for SetSubscriptionAttributes action.
", + "refs": { + } + }, + "SetTopicAttributesInput": { + "base": "Input for SetTopicAttributes action.
", + "refs": { + } + }, + "String": { + "base": null, + "refs": { + "CreateEndpointResponse$EndpointArn": "EndpointArn returned from CreateEndpoint action.
", + "CreatePlatformApplicationInput$Name": "Application names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, hyphens, and periods, and must be between 1 and 256 characters long.
", + "CreatePlatformApplicationInput$Platform": "The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and GCM (Google Cloud Messaging).
", + "CreatePlatformApplicationResponse$PlatformApplicationArn": "PlatformApplicationArn is returned.
", + "CreatePlatformEndpointInput$PlatformApplicationArn": "PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.
", + "CreatePlatformEndpointInput$Token": "Unique identifier created by the notification service for an app on a device. The specific name for Token will vary, depending on which notification service is being used. For example, when using APNS as the notification service, you need the device token. Alternatively, when using GCM or ADM, the device token equivalent is called the registration ID.
", + "CreatePlatformEndpointInput$CustomUserData": "Arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.
", + "DeleteEndpointInput$EndpointArn": "EndpointArn of endpoint to delete.
", + "DeletePlatformApplicationInput$PlatformApplicationArn": "PlatformApplicationArn of platform application object to delete.
", + "Endpoint$EndpointArn": "EndpointArn for mobile app and device.
", + "GetEndpointAttributesInput$EndpointArn": "EndpointArn for GetEndpointAttributes input.
", + "GetPlatformApplicationAttributesInput$PlatformApplicationArn": "PlatformApplicationArn for GetPlatformApplicationAttributesInput.
", + "ListEndpointsByPlatformApplicationInput$PlatformApplicationArn": "PlatformApplicationArn for ListEndpointsByPlatformApplicationInput action.
", + "ListEndpointsByPlatformApplicationInput$NextToken": "NextToken string is used when calling ListEndpointsByPlatformApplication action to retrieve additional records that are available after the first page results.
", + "ListEndpointsByPlatformApplicationResponse$NextToken": "NextToken string is returned when calling ListEndpointsByPlatformApplication action if additional records are available after the first page results.
", + "ListPlatformApplicationsInput$NextToken": "NextToken string is used when calling ListPlatformApplications action to retrieve additional records that are available after the first page results.
", + "ListPlatformApplicationsResponse$NextToken": "NextToken string is returned when calling ListPlatformApplications action if additional records are available after the first page results.
", + "ListString$member": null, + "MapStringToString$key": null, + "MapStringToString$value": null, + "MessageAttributeMap$key": null, + "MessageAttributeValue$DataType": "Amazon SNS supports the following logical data types: String, Number, and Binary. For more information, see Message Attribute Data Types.
", + "MessageAttributeValue$StringValue": "Strings are Unicode with UTF8 binary encoding. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
", + "PlatformApplication$PlatformApplicationArn": "PlatformApplicationArn for platform application object.
", + "PublishInput$TargetArn": "Either TopicArn or EndpointArn, but not both.
If you don't specify a value for the TargetArn parameter, you must specify a value for the PhoneNumber or TopicArn parameters.
The phone number to which you want to deliver an SMS message. Use E.164 format.
If you don't specify a value for the PhoneNumber parameter, you must specify a value for the TargetArn or TopicArn parameters.
EndpointArn used for SetEndpointAttributes action.
", + "SetPlatformApplicationAttributesInput$PlatformApplicationArn": "PlatformApplicationArn for SetPlatformApplicationAttributes action.
" + } + }, + "SubscribeInput": { + "base": "Input for Subscribe action.
", + "refs": { + } + }, + "SubscribeResponse": { + "base": "Response for Subscribe action.
", + "refs": { + } + }, + "Subscription": { + "base": "A wrapper type for the attributes of an Amazon SNS subscription.
", + "refs": { + "SubscriptionsList$member": null + } + }, + "SubscriptionAttributesMap": { + "base": null, + "refs": { + "GetSubscriptionAttributesResponse$Attributes": "A map of the subscription's attributes. Attributes in this map include the following:
SubscriptionArn -- the subscription's ARN
TopicArn -- the topic ARN that the subscription is associated with
Owner -- the AWS account ID of the subscription's owner
ConfirmationWasAuthenticated -- true if the subscription confirmation request was authenticated
DeliveryPolicy -- the JSON serialization of the subscription's delivery policy
EffectiveDeliveryPolicy -- the JSON serialization of the effective delivery policy that takes into account the topic delivery policy and account system defaults
Indicates that the customer already owns the maximum allowed number of subscriptions.
", + "refs": { + } + }, + "SubscriptionsList": { + "base": null, + "refs": { + "ListSubscriptionsByTopicResponse$Subscriptions": "A list of subscriptions.
", + "ListSubscriptionsResponse$Subscriptions": "A list of subscriptions.
" + } + }, + "ThrottledException": { + "base": "Indicates that the rate at which requests have been submitted for this action exceeds the limit for your account.
", + "refs": { + } + }, + "Topic": { + "base": "A wrapper type for the topic's Amazon Resource Name (ARN). To retrieve a topic's attributes, use GetTopicAttributes.
A map of the topic's attributes. Attributes in this map include the following:
TopicArn -- the topic's ARN
Owner -- the AWS account ID of the topic's owner
Policy -- the JSON serialization of the topic's access control policy
DisplayName -- the human-readable name used in the \"From\" field for notifications to email and email-json endpoints
SubscriptionsPending -- the number of subscriptions pending confirmation on this topic
SubscriptionsConfirmed -- the number of confirmed subscriptions on this topic
SubscriptionsDeleted -- the number of deleted subscriptions on this topic
DeliveryPolicy -- the JSON serialization of the topic's delivery policy
EffectiveDeliveryPolicy -- the JSON serialization of the effective delivery policy that takes into account system defaults
Indicates that the customer already owns the maximum allowed number of topics.
", + "refs": { + } + }, + "TopicsList": { + "base": null, + "refs": { + "ListTopicsResponse$Topics": "A list of topic ARNs.
" + } + }, + "UnsubscribeInput": { + "base": "Input for Unsubscribe action.
", + "refs": { + } + }, + "account": { + "base": null, + "refs": { + "Subscription$Owner": "The subscription's owner.
" + } + }, + "action": { + "base": null, + "refs": { + "ActionsList$member": null + } + }, + "attributeName": { + "base": null, + "refs": { + "SetSubscriptionAttributesInput$AttributeName": "The name of the attribute you want to set. Only a subset of the subscriptions attributes are mutable.
Valid values: DeliveryPolicy | RawMessageDelivery
The name of the attribute you want to set. Only a subset of the topic's attributes are mutable.
Valid values: Policy | DisplayName | DeliveryPolicy
The new value for the attribute in JSON format.
", + "SetTopicAttributesInput$AttributeValue": "The new value for the attribute.
", + "SubscriptionAttributesMap$value": null, + "TopicAttributesMap$value": null + } + }, + "authenticateOnUnsubscribe": { + "base": null, + "refs": { + "ConfirmSubscriptionInput$AuthenticateOnUnsubscribe": "Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is true and the request has an AWS signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires AWS authentication.
Indicates whether the phone number is opted out:
true – The phone number is opted out, meaning you cannot publish SMS messages to it.
false – The phone number is opted in, meaning you can publish SMS messages to it.
The endpoint that you want to receive notifications. Endpoints vary by protocol:
For the http protocol, the endpoint is an URL beginning with \"http://\"
For the https protocol, the endpoint is a URL beginning with \"https://\"
For the email protocol, the endpoint is an email address
For the email-json protocol, the endpoint is an email address
For the sms protocol, the endpoint is a phone number of an SMS-enabled device
For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue
For the application protocol, the endpoint is the EndpointArn of a mobile app and device.
For the lambda protocol, the endpoint is the ARN of an AWS Lambda function.
The subscription's endpoint (format depends on the protocol).
" + } + }, + "label": { + "base": null, + "refs": { + "AddPermissionInput$Label": "A unique identifier for the new policy statement.
", + "RemovePermissionInput$Label": "The unique label of the statement you want to remove.
" + } + }, + "message": { + "base": null, + "refs": { + "PublishInput$Message": "The message you want to send to the topic.
If you want to send the same message to all transport protocols, include the text of the message as a String value.
If you want to send different messages for each transport protocol, set the value of the MessageStructure parameter to json and use a JSON object for the Message parameter. See the Examples section for the format of the JSON object.
Constraints: Messages must be UTF-8 encoded strings at most 256 KB in size (262144 bytes, not 262144 characters).
JSON-specific constraints:
Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values.
The values will be parsed (unescaped) before they are used in outgoing messages.
Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending).
Values have a minimum length of 0 (the empty string, \"\", is allowed).
Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit message sizes).
Non-string values will cause the key to be ignored.
Keys that do not correspond to supported transport protocols are ignored.
Duplicate keys are not allowed.
Failure to parse or validate any key or value in the message will cause the Publish call to return an error (no partial delivery).
Unique identifier assigned to the published message.
Length Constraint: Maximum 100 characters
" + } + }, + "messageStructure": { + "base": null, + "refs": { + "PublishInput$MessageStructure": "Set MessageStructure to json if you want to send a different message for each protocol. For example, using one publish action, you can send a short message to your SMS subscribers and a longer message to your email subscribers. If you set MessageStructure to json, the value of the Message parameter must:
be a syntactically valid JSON object; and
contain at least a top-level JSON key of \"default\" with a value that is a string.
You can define other top-level keys that define the message you want to send to a specific transport protocol (e.g., \"http\").
For information about sending different messages for each protocol using the AWS Management Console, go to Create Different Messages for Each Protocol in the Amazon Simple Notification Service Getting Started Guide.
Valid value: json
Token returned by the previous ListSubscriptionsByTopic request.
Token to pass along to the next ListSubscriptionsByTopic request. This element is returned if there are more subscriptions to retrieve.
Token returned by the previous ListSubscriptions request.
Token to pass along to the next ListSubscriptions request. This element is returned if there are more subscriptions to retrieve.
Token returned by the previous ListTopics request.
Token to pass along to the next ListTopics request. This element is returned if there are additional topics to retrieve.
The protocol you want to use. Supported protocols include:
http -- delivery of JSON-encoded message via HTTP POST
https -- delivery of JSON-encoded message via HTTPS POST
email -- delivery of message via SMTP
email-json -- delivery of JSON-encoded message via SMTP
sms -- delivery of message via SMS
sqs -- delivery of JSON-encoded message to an Amazon SQS queue
application -- delivery of JSON-encoded message to an EndpointArn for a mobile app and device.
lambda -- delivery of JSON-encoded message to an AWS Lambda function.
The subscription's protocol.
" + } + }, + "string": { + "base": null, + "refs": { + "AuthorizationErrorException$message": null, + "EndpointDisabledException$message": "Message for endpoint disabled.
", + "InternalErrorException$message": null, + "InvalidParameterException$message": null, + "InvalidParameterValueException$message": null, + "ListPhoneNumbersOptedOutInput$nextToken": "A NextToken string is used when you call the ListPhoneNumbersOptedOut action to retrieve additional records that are available after the first page of results.
A NextToken string is returned when you call the ListPhoneNumbersOptedOut action if additional records are available after the first page of results.
Message for platform application disabled.
", + "SubscriptionLimitExceededException$message": null, + "ThrottledException$message": null, + "TopicLimitExceededException$message": null + } + }, + "subject": { + "base": null, + "refs": { + "PublishInput$Subject": "Optional parameter to be used as the \"Subject\" line when the message is delivered to email endpoints. This field will also be included, if present, in the standard JSON messages delivered to other endpoints.
Constraints: Subjects must be ASCII text that begins with a letter, number, or punctuation mark; must not include line breaks or control characters; and must be less than 100 characters long.
" + } + }, + "subscriptionARN": { + "base": null, + "refs": { + "ConfirmSubscriptionResponse$SubscriptionArn": "The ARN of the created subscription.
", + "GetSubscriptionAttributesInput$SubscriptionArn": "The ARN of the subscription whose properties you want to get.
", + "SetSubscriptionAttributesInput$SubscriptionArn": "The ARN of the subscription to modify.
", + "SubscribeResponse$SubscriptionArn": "The ARN of the subscription, if the service was able to create a subscription immediately (without requiring endpoint owner confirmation).
", + "Subscription$SubscriptionArn": "The subscription's ARN.
", + "UnsubscribeInput$SubscriptionArn": "The ARN of the subscription to be deleted.
" + } + }, + "token": { + "base": null, + "refs": { + "ConfirmSubscriptionInput$Token": "Short-lived token sent to an endpoint during the Subscribe action.
The ARN of the topic whose access control policy you wish to modify.
", + "ConfirmSubscriptionInput$TopicArn": "The ARN of the topic for which you wish to confirm a subscription.
", + "CreateTopicResponse$TopicArn": "The Amazon Resource Name (ARN) assigned to the created topic.
", + "DeleteTopicInput$TopicArn": "The ARN of the topic you want to delete.
", + "GetTopicAttributesInput$TopicArn": "The ARN of the topic whose properties you want to get.
", + "ListSubscriptionsByTopicInput$TopicArn": "The ARN of the topic for which you wish to find subscriptions.
", + "PublishInput$TopicArn": "The topic you want to publish to.
If you don't specify a value for the TopicArn parameter, you must specify a value for the PhoneNumber or TargetArn parameters.
The ARN of the topic whose access control policy you wish to modify.
", + "SetTopicAttributesInput$TopicArn": "The ARN of the topic to modify.
", + "SubscribeInput$TopicArn": "The ARN of the topic you want to subscribe to.
", + "Subscription$TopicArn": "The ARN of the subscription's topic.
", + "Topic$TopicArn": "The topic's ARN.
" + } + }, + "topicName": { + "base": null, + "refs": { + "CreateTopicInput$Name": "The name of the topic you want to create.
Constraints: Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long.
" + } + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/sns/2010-03-31/paginators-1.json b/vendor/github.com/aws/aws-sdk-go/models/apis/sns/2010-03-31/paginators-1.json new file mode 100644 index 000000000..455e4708e --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/sns/2010-03-31/paginators-1.json @@ -0,0 +1,29 @@ +{ + "pagination": { + "ListEndpointsByPlatformApplication": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "Endpoints" + }, + "ListPlatformApplications": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "PlatformApplications" + }, + "ListSubscriptions": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "Subscriptions" + }, + "ListSubscriptionsByTopic": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "Subscriptions" + }, + "ListTopics": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "Topics" + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/sqs/2012-11-05/api-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/sqs/2012-11-05/api-2.json new file mode 100644 index 000000000..b30100f88 --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/sqs/2012-11-05/api-2.json @@ -0,0 +1,950 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2012-11-05", + "endpointPrefix":"sqs", + "protocol":"query", + "serviceAbbreviation":"Amazon SQS", + "serviceFullName":"Amazon Simple Queue Service", + "signatureVersion":"v4", + "xmlNamespace":"http://queue.amazonaws.com/doc/2012-11-05/" + }, + "operations":{ + "AddPermission":{ + "name":"AddPermission", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddPermissionRequest"}, + "errors":[ + {"shape":"OverLimit"} + ] + }, + "ChangeMessageVisibility":{ + "name":"ChangeMessageVisibility", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ChangeMessageVisibilityRequest"}, + "errors":[ + {"shape":"MessageNotInflight"}, + {"shape":"ReceiptHandleIsInvalid"} + ] + }, + "ChangeMessageVisibilityBatch":{ + "name":"ChangeMessageVisibilityBatch", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ChangeMessageVisibilityBatchRequest"}, + "output":{ + "shape":"ChangeMessageVisibilityBatchResult", + "resultWrapper":"ChangeMessageVisibilityBatchResult" + }, + "errors":[ + {"shape":"TooManyEntriesInBatchRequest"}, + {"shape":"EmptyBatchRequest"}, + {"shape":"BatchEntryIdsNotDistinct"}, + {"shape":"InvalidBatchEntryId"} + ] + }, + "CreateQueue":{ + "name":"CreateQueue", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateQueueRequest"}, + "output":{ + "shape":"CreateQueueResult", + "resultWrapper":"CreateQueueResult" + }, + "errors":[ + {"shape":"QueueDeletedRecently"}, + {"shape":"QueueNameExists"} + ] + }, + "DeleteMessage":{ + "name":"DeleteMessage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteMessageRequest"}, + "errors":[ + {"shape":"InvalidIdFormat"}, + {"shape":"ReceiptHandleIsInvalid"} + ] + }, + "DeleteMessageBatch":{ + "name":"DeleteMessageBatch", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteMessageBatchRequest"}, + "output":{ + "shape":"DeleteMessageBatchResult", + "resultWrapper":"DeleteMessageBatchResult" + }, + "errors":[ + {"shape":"TooManyEntriesInBatchRequest"}, + {"shape":"EmptyBatchRequest"}, + {"shape":"BatchEntryIdsNotDistinct"}, + {"shape":"InvalidBatchEntryId"} + ] + }, + "DeleteQueue":{ + "name":"DeleteQueue", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteQueueRequest"} + }, + "GetQueueAttributes":{ + "name":"GetQueueAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetQueueAttributesRequest"}, + "output":{ + "shape":"GetQueueAttributesResult", + "resultWrapper":"GetQueueAttributesResult" + }, + "errors":[ + {"shape":"InvalidAttributeName"} + ] + }, + "GetQueueUrl":{ + "name":"GetQueueUrl", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetQueueUrlRequest"}, + "output":{ + "shape":"GetQueueUrlResult", + "resultWrapper":"GetQueueUrlResult" + }, + "errors":[ + {"shape":"QueueDoesNotExist"} + ] + }, + "ListDeadLetterSourceQueues":{ + "name":"ListDeadLetterSourceQueues", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListDeadLetterSourceQueuesRequest"}, + "output":{ + "shape":"ListDeadLetterSourceQueuesResult", + "resultWrapper":"ListDeadLetterSourceQueuesResult" + }, + "errors":[ + {"shape":"QueueDoesNotExist"} + ] + }, + "ListQueues":{ + "name":"ListQueues", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListQueuesRequest"}, + "output":{ + "shape":"ListQueuesResult", + "resultWrapper":"ListQueuesResult" + } + }, + "PurgeQueue":{ + "name":"PurgeQueue", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PurgeQueueRequest"}, + "errors":[ + {"shape":"QueueDoesNotExist"}, + {"shape":"PurgeQueueInProgress"} + ] + }, + "ReceiveMessage":{ + "name":"ReceiveMessage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ReceiveMessageRequest"}, + "output":{ + "shape":"ReceiveMessageResult", + "resultWrapper":"ReceiveMessageResult" + }, + "errors":[ + {"shape":"OverLimit"} + ] + }, + "RemovePermission":{ + "name":"RemovePermission", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RemovePermissionRequest"} + }, + "SendMessage":{ + "name":"SendMessage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SendMessageRequest"}, + "output":{ + "shape":"SendMessageResult", + "resultWrapper":"SendMessageResult" + }, + "errors":[ + {"shape":"InvalidMessageContents"}, + {"shape":"UnsupportedOperation"} + ] + }, + "SendMessageBatch":{ + "name":"SendMessageBatch", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SendMessageBatchRequest"}, + "output":{ + "shape":"SendMessageBatchResult", + "resultWrapper":"SendMessageBatchResult" + }, + "errors":[ + {"shape":"TooManyEntriesInBatchRequest"}, + {"shape":"EmptyBatchRequest"}, + {"shape":"BatchEntryIdsNotDistinct"}, + {"shape":"BatchRequestTooLong"}, + {"shape":"InvalidBatchEntryId"}, + {"shape":"UnsupportedOperation"} + ] + }, + "SetQueueAttributes":{ + "name":"SetQueueAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SetQueueAttributesRequest"}, + "errors":[ + {"shape":"InvalidAttributeName"} + ] + } + }, + "shapes":{ + "AWSAccountIdList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"AWSAccountId" + }, + "flattened":true + }, + "ActionNameList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ActionName" + }, + "flattened":true + }, + "AddPermissionRequest":{ + "type":"structure", + "required":[ + "QueueUrl", + "Label", + "AWSAccountIds", + "Actions" + ], + "members":{ + "QueueUrl":{"shape":"String"}, + "Label":{"shape":"String"}, + "AWSAccountIds":{"shape":"AWSAccountIdList"}, + "Actions":{"shape":"ActionNameList"} + } + }, + "AttributeMap":{ + "type":"map", + "key":{ + "shape":"QueueAttributeName", + "locationName":"Name" + }, + "value":{ + "shape":"String", + "locationName":"Value" + }, + "flattened":true, + "locationName":"Attribute" + }, + "AttributeNameList":{ + "type":"list", + "member":{ + "shape":"QueueAttributeName", + "locationName":"AttributeName" + }, + "flattened":true + }, + "BatchEntryIdsNotDistinct":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"AWS.SimpleQueueService.BatchEntryIdsNotDistinct", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "BatchRequestTooLong":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"AWS.SimpleQueueService.BatchRequestTooLong", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "BatchResultErrorEntry":{ + "type":"structure", + "required":[ + "Id", + "SenderFault", + "Code" + ], + "members":{ + "Id":{"shape":"String"}, + "SenderFault":{"shape":"Boolean"}, + "Code":{"shape":"String"}, + "Message":{"shape":"String"} + } + }, + "BatchResultErrorEntryList":{ + "type":"list", + "member":{ + "shape":"BatchResultErrorEntry", + "locationName":"BatchResultErrorEntry" + }, + "flattened":true + }, + "Binary":{"type":"blob"}, + "BinaryList":{ + "type":"list", + "member":{ + "shape":"Binary", + "locationName":"BinaryListValue" + } + }, + "Boolean":{"type":"boolean"}, + "ChangeMessageVisibilityBatchRequest":{ + "type":"structure", + "required":[ + "QueueUrl", + "Entries" + ], + "members":{ + "QueueUrl":{"shape":"String"}, + "Entries":{"shape":"ChangeMessageVisibilityBatchRequestEntryList"} + } + }, + "ChangeMessageVisibilityBatchRequestEntry":{ + "type":"structure", + "required":[ + "Id", + "ReceiptHandle" + ], + "members":{ + "Id":{"shape":"String"}, + "ReceiptHandle":{"shape":"String"}, + "VisibilityTimeout":{"shape":"Integer"} + } + }, + "ChangeMessageVisibilityBatchRequestEntryList":{ + "type":"list", + "member":{ + "shape":"ChangeMessageVisibilityBatchRequestEntry", + "locationName":"ChangeMessageVisibilityBatchRequestEntry" + }, + "flattened":true + }, + "ChangeMessageVisibilityBatchResult":{ + "type":"structure", + "required":[ + "Successful", + "Failed" + ], + "members":{ + "Successful":{"shape":"ChangeMessageVisibilityBatchResultEntryList"}, + "Failed":{"shape":"BatchResultErrorEntryList"} + } + }, + "ChangeMessageVisibilityBatchResultEntry":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{"shape":"String"} + } + }, + "ChangeMessageVisibilityBatchResultEntryList":{ + "type":"list", + "member":{ + "shape":"ChangeMessageVisibilityBatchResultEntry", + "locationName":"ChangeMessageVisibilityBatchResultEntry" + }, + "flattened":true + }, + "ChangeMessageVisibilityRequest":{ + "type":"structure", + "required":[ + "QueueUrl", + "ReceiptHandle", + "VisibilityTimeout" + ], + "members":{ + "QueueUrl":{"shape":"String"}, + "ReceiptHandle":{"shape":"String"}, + "VisibilityTimeout":{"shape":"Integer"} + } + }, + "CreateQueueRequest":{ + "type":"structure", + "required":["QueueName"], + "members":{ + "QueueName":{"shape":"String"}, + "Attributes":{ + "shape":"AttributeMap", + "locationName":"Attribute" + } + } + }, + "CreateQueueResult":{ + "type":"structure", + "members":{ + "QueueUrl":{"shape":"String"} + } + }, + "DeleteMessageBatchRequest":{ + "type":"structure", + "required":[ + "QueueUrl", + "Entries" + ], + "members":{ + "QueueUrl":{"shape":"String"}, + "Entries":{"shape":"DeleteMessageBatchRequestEntryList"} + } + }, + "DeleteMessageBatchRequestEntry":{ + "type":"structure", + "required":[ + "Id", + "ReceiptHandle" + ], + "members":{ + "Id":{"shape":"String"}, + "ReceiptHandle":{"shape":"String"} + } + }, + "DeleteMessageBatchRequestEntryList":{ + "type":"list", + "member":{ + "shape":"DeleteMessageBatchRequestEntry", + "locationName":"DeleteMessageBatchRequestEntry" + }, + "flattened":true + }, + "DeleteMessageBatchResult":{ + "type":"structure", + "required":[ + "Successful", + "Failed" + ], + "members":{ + "Successful":{"shape":"DeleteMessageBatchResultEntryList"}, + "Failed":{"shape":"BatchResultErrorEntryList"} + } + }, + "DeleteMessageBatchResultEntry":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{"shape":"String"} + } + }, + "DeleteMessageBatchResultEntryList":{ + "type":"list", + "member":{ + "shape":"DeleteMessageBatchResultEntry", + "locationName":"DeleteMessageBatchResultEntry" + }, + "flattened":true + }, + "DeleteMessageRequest":{ + "type":"structure", + "required":[ + "QueueUrl", + "ReceiptHandle" + ], + "members":{ + "QueueUrl":{"shape":"String"}, + "ReceiptHandle":{"shape":"String"} + } + }, + "DeleteQueueRequest":{ + "type":"structure", + "required":["QueueUrl"], + "members":{ + "QueueUrl":{"shape":"String"} + } + }, + "EmptyBatchRequest":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"AWS.SimpleQueueService.EmptyBatchRequest", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "GetQueueAttributesRequest":{ + "type":"structure", + "required":["QueueUrl"], + "members":{ + "QueueUrl":{"shape":"String"}, + "AttributeNames":{"shape":"AttributeNameList"} + } + }, + "GetQueueAttributesResult":{ + "type":"structure", + "members":{ + "Attributes":{ + "shape":"AttributeMap", + "locationName":"Attribute" + } + } + }, + "GetQueueUrlRequest":{ + "type":"structure", + "required":["QueueName"], + "members":{ + "QueueName":{"shape":"String"}, + "QueueOwnerAWSAccountId":{"shape":"String"} + } + }, + "GetQueueUrlResult":{ + "type":"structure", + "members":{ + "QueueUrl":{"shape":"String"} + } + }, + "Integer":{"type":"integer"}, + "InvalidAttributeName":{ + "type":"structure", + "members":{ + }, + "exception":true + }, + "InvalidBatchEntryId":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"AWS.SimpleQueueService.InvalidBatchEntryId", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidIdFormat":{ + "type":"structure", + "members":{ + }, + "exception":true + }, + "InvalidMessageContents":{ + "type":"structure", + "members":{ + }, + "exception":true + }, + "ListDeadLetterSourceQueuesRequest":{ + "type":"structure", + "required":["QueueUrl"], + "members":{ + "QueueUrl":{"shape":"String"} + } + }, + "ListDeadLetterSourceQueuesResult":{ + "type":"structure", + "required":["queueUrls"], + "members":{ + "queueUrls":{"shape":"QueueUrlList"} + } + }, + "ListQueuesRequest":{ + "type":"structure", + "members":{ + "QueueNamePrefix":{"shape":"String"} + } + }, + "ListQueuesResult":{ + "type":"structure", + "members":{ + "QueueUrls":{"shape":"QueueUrlList"} + } + }, + "Message":{ + "type":"structure", + "members":{ + "MessageId":{"shape":"String"}, + "ReceiptHandle":{"shape":"String"}, + "MD5OfBody":{"shape":"String"}, + "Body":{"shape":"String"}, + "Attributes":{ + "shape":"AttributeMap", + "locationName":"Attribute" + }, + "MD5OfMessageAttributes":{"shape":"String"}, + "MessageAttributes":{ + "shape":"MessageAttributeMap", + "locationName":"MessageAttribute" + } + } + }, + "MessageAttributeMap":{ + "type":"map", + "key":{ + "shape":"String", + "locationName":"Name" + }, + "value":{ + "shape":"MessageAttributeValue", + "locationName":"Value" + }, + "flattened":true + }, + "MessageAttributeName":{"type":"string"}, + "MessageAttributeNameList":{ + "type":"list", + "member":{ + "shape":"MessageAttributeName", + "locationName":"MessageAttributeName" + }, + "flattened":true + }, + "MessageAttributeValue":{ + "type":"structure", + "required":["DataType"], + "members":{ + "StringValue":{"shape":"String"}, + "BinaryValue":{"shape":"Binary"}, + "StringListValues":{ + "shape":"StringList", + "flattened":true, + "locationName":"StringListValue" + }, + "BinaryListValues":{ + "shape":"BinaryList", + "flattened":true, + "locationName":"BinaryListValue" + }, + "DataType":{"shape":"String"} + } + }, + "MessageList":{ + "type":"list", + "member":{ + "shape":"Message", + "locationName":"Message" + }, + "flattened":true + }, + "MessageNotInflight":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"AWS.SimpleQueueService.MessageNotInflight", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "OverLimit":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"OverLimit", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "PurgeQueueInProgress":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"AWS.SimpleQueueService.PurgeQueueInProgress", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "PurgeQueueRequest":{ + "type":"structure", + "required":["QueueUrl"], + "members":{ + "QueueUrl":{"shape":"String"} + } + }, + "QueueAttributeName":{ + "type":"string", + "enum":[ + "Policy", + "VisibilityTimeout", + "MaximumMessageSize", + "MessageRetentionPeriod", + "ApproximateNumberOfMessages", + "ApproximateNumberOfMessagesNotVisible", + "CreatedTimestamp", + "LastModifiedTimestamp", + "QueueArn", + "ApproximateNumberOfMessagesDelayed", + "DelaySeconds", + "ReceiveMessageWaitTimeSeconds", + "RedrivePolicy" + ] + }, + "QueueDeletedRecently":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"AWS.SimpleQueueService.QueueDeletedRecently", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "QueueDoesNotExist":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"AWS.SimpleQueueService.NonExistentQueue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "QueueNameExists":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"QueueAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "QueueUrlList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"QueueUrl" + }, + "flattened":true + }, + "ReceiptHandleIsInvalid":{ + "type":"structure", + "members":{ + }, + "exception":true + }, + "ReceiveMessageRequest":{ + "type":"structure", + "required":["QueueUrl"], + "members":{ + "QueueUrl":{"shape":"String"}, + "AttributeNames":{"shape":"AttributeNameList"}, + "MessageAttributeNames":{"shape":"MessageAttributeNameList"}, + "MaxNumberOfMessages":{"shape":"Integer"}, + "VisibilityTimeout":{"shape":"Integer"}, + "WaitTimeSeconds":{"shape":"Integer"} + } + }, + "ReceiveMessageResult":{ + "type":"structure", + "members":{ + "Messages":{"shape":"MessageList"} + } + }, + "RemovePermissionRequest":{ + "type":"structure", + "required":[ + "QueueUrl", + "Label" + ], + "members":{ + "QueueUrl":{"shape":"String"}, + "Label":{"shape":"String"} + } + }, + "SendMessageBatchRequest":{ + "type":"structure", + "required":[ + "QueueUrl", + "Entries" + ], + "members":{ + "QueueUrl":{"shape":"String"}, + "Entries":{"shape":"SendMessageBatchRequestEntryList"} + } + }, + "SendMessageBatchRequestEntry":{ + "type":"structure", + "required":[ + "Id", + "MessageBody" + ], + "members":{ + "Id":{"shape":"String"}, + "MessageBody":{"shape":"String"}, + "DelaySeconds":{"shape":"Integer"}, + "MessageAttributes":{ + "shape":"MessageAttributeMap", + "locationName":"MessageAttribute" + } + } + }, + "SendMessageBatchRequestEntryList":{ + "type":"list", + "member":{ + "shape":"SendMessageBatchRequestEntry", + "locationName":"SendMessageBatchRequestEntry" + }, + "flattened":true + }, + "SendMessageBatchResult":{ + "type":"structure", + "required":[ + "Successful", + "Failed" + ], + "members":{ + "Successful":{"shape":"SendMessageBatchResultEntryList"}, + "Failed":{"shape":"BatchResultErrorEntryList"} + } + }, + "SendMessageBatchResultEntry":{ + "type":"structure", + "required":[ + "Id", + "MessageId", + "MD5OfMessageBody" + ], + "members":{ + "Id":{"shape":"String"}, + "MessageId":{"shape":"String"}, + "MD5OfMessageBody":{"shape":"String"}, + "MD5OfMessageAttributes":{"shape":"String"} + } + }, + "SendMessageBatchResultEntryList":{ + "type":"list", + "member":{ + "shape":"SendMessageBatchResultEntry", + "locationName":"SendMessageBatchResultEntry" + }, + "flattened":true + }, + "SendMessageRequest":{ + "type":"structure", + "required":[ + "QueueUrl", + "MessageBody" + ], + "members":{ + "QueueUrl":{"shape":"String"}, + "MessageBody":{"shape":"String"}, + "DelaySeconds":{"shape":"Integer"}, + "MessageAttributes":{ + "shape":"MessageAttributeMap", + "locationName":"MessageAttribute" + } + } + }, + "SendMessageResult":{ + "type":"structure", + "members":{ + "MD5OfMessageBody":{"shape":"String"}, + "MD5OfMessageAttributes":{"shape":"String"}, + "MessageId":{"shape":"String"} + } + }, + "SetQueueAttributesRequest":{ + "type":"structure", + "required":[ + "QueueUrl", + "Attributes" + ], + "members":{ + "QueueUrl":{"shape":"String"}, + "Attributes":{ + "shape":"AttributeMap", + "locationName":"Attribute" + } + } + }, + "String":{"type":"string"}, + "StringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"StringListValue" + } + }, + "TooManyEntriesInBatchRequest":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"AWS.SimpleQueueService.TooManyEntriesInBatchRequest", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "UnsupportedOperation":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"AWS.SimpleQueueService.UnsupportedOperation", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/sqs/2012-11-05/docs-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/sqs/2012-11-05/docs-2.json new file mode 100644 index 000000000..3722552f8 --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/sqs/2012-11-05/docs-2.json @@ -0,0 +1,504 @@ +{ + "version": "2.0", + "service": "Welcome to the Amazon Simple Queue Service API Reference. This section describes who should read this guide, how the guide is organized, and other resources related to the Amazon Simple Queue Service (Amazon SQS).
Amazon SQS offers reliable and scalable hosted queues for storing messages as they travel between computers. By using Amazon SQS, you can move data between distributed components of your applications that perform different tasks without losing messages or requiring each component to be always available.
Helpful Links:
We also provide SDKs that enable you to access Amazon SQS from your preferred programming language. The SDKs contain functionality that automatically takes care of tasks such as:
Cryptographically signing your service requests
Retrying requests
Handling error responses
For a list of available SDKs, go to Tools for Amazon Web Services.
", + "operations": { + "AddPermission": "Adds a permission to a queue for a specific principal. This allows for sharing access to the queue.
When you create a queue, you have full control access rights for the queue. Only you (as owner of the queue) can grant or deny permissions to the queue. For more information about these permissions, see Shared Queues in the Amazon SQS Developer Guide.
AddPermission writes an Amazon SQS-generated policy. If you want to write your own policy, use SetQueueAttributes to upload your policy. For more information about writing your own policy, see Using The Access Policy Language in the Amazon SQS Developer Guide.
Some API actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:
Changes the visibility timeout of a specified message in a queue to a new value. The maximum allowed timeout value you can set the value to is 12 hours. This means you can't extend the timeout of a message in an existing queue to more than a total visibility timeout of 12 hours. (For more information visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.)
For example, let's say you have a message and its default message visibility timeout is 5 minutes. After 3 minutes, you call ChangeMessageVisiblity with a timeout of 10 minutes. At that time, the timeout for the message would be extended by 10 minutes beyond the time of the ChangeMessageVisibility call. This results in a total visibility timeout of 13 minutes. You can continue to call ChangeMessageVisibility to extend the visibility timeout to a maximum of 12 hours. If you try to extend beyond 12 hours, the request will be rejected.
There is a 120,000 limit for the number of inflight messages per queue. Messages are inflight after they have been received from the queue by a consuming component, but have not yet been deleted from the queue. If you reach the 120,000 limit, you will receive an OverLimit error message from Amazon SQS. To help avoid reaching the limit, you should delete the messages from the queue after they have been processed. You can also increase the number of queues you use to process the messages.
If you attempt to set the VisibilityTimeout to an amount more than the maximum time left, Amazon SQS returns an error. It will not automatically recalculate and increase the timeout to the maximum time remaining.
Unlike with a queue, when you change the visibility timeout for a specific message, that timeout value is applied immediately but is not saved in memory for that message. If you don't delete a message after it is received, the visibility timeout for the message the next time it is received reverts to the original timeout value, not the value you set with the ChangeMessageVisibility action.
Changes the visibility timeout of multiple messages. This is a batch version of ChangeMessageVisibility. The result of the action on each message is reported individually in the response. You can send up to 10 ChangeMessageVisibility requests with each ChangeMessageVisibilityBatch action.
Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.
Some API actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:
Creates a new queue, or returns the URL of an existing one. When you request CreateQueue, you provide a name for the queue. To successfully create a new queue, you must provide a name that is unique within the scope of your own queues.
If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.
You may pass one or more attributes in the request. If you do not provide a value for any attribute, the queue will have the default value for that attribute.
Use GetQueueUrl to get a queue's URL. GetQueueUrl requires only the QueueName parameter.
If you provide the name of an existing queue, along with the exact names and values of all the queue's attributes, CreateQueue returns the queue URL for the existing queue. If the queue name, attribute names, or attribute values do not match an existing queue, CreateQueue returns an error.
Some API actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:
Deletes the specified message from the specified queue. You specify the message by using the message's receipt handle and not the message ID you received when you sent the message. Even if the message is locked by another reader due to the visibility timeout setting, it is still deleted from the queue. If you leave a message in the queue for longer than the queue's configured retention period, Amazon SQS automatically deletes it.
The receipt handle is associated with a specific instance of receiving the message. If you receive a message more than once, the receipt handle you get each time you receive the message is different. When you request DeleteMessage, if you don't provide the most recently received receipt handle for the message, the request will still succeed, but the message might not be deleted.
It is possible you will receive a message even after you have deleted it. This might happen on rare occasions if one of the servers storing a copy of the message is unavailable when you request to delete the message. The copy remains on the server and might be returned to you again on a subsequent receive request. You should create your system to be idempotent so that receiving a particular message more than once is not a problem.
Deletes up to ten messages from the specified queue. This is a batch version of DeleteMessage. The result of the delete action on each message is reported individually in the response.
Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.
Some API actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:
Deletes the queue specified by the queue URL, regardless of whether the queue is empty. If the specified queue does not exist, Amazon SQS returns a successful response.
Use DeleteQueue with care; once you delete your queue, any messages in the queue are no longer available.
When you delete a queue, the deletion process takes up to 60 seconds. Requests you send involving that queue during the 60 seconds might succeed. For example, a SendMessage request might succeed, but after the 60 seconds, the queue and that message you sent no longer exist. Also, when you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.
We reserve the right to delete queues that have had no activity for more than 30 days. For more information, see How Amazon SQS Queues Work in the Amazon SQS Developer Guide.
", + "GetQueueAttributes": "Gets attributes for the specified queue.
Some API actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:
Returns the URL of an existing queue. This action provides a simple way to retrieve the URL of an Amazon SQS queue.
To access a queue that belongs to another AWS account, use the QueueOwnerAWSAccountId parameter to specify the account ID of the queue's owner. The queue's owner must grant you permission to access the queue. For more information about shared queue access, see AddPermission or go to Shared Queues in the Amazon SQS Developer Guide.
Returns a list of your queues that have the RedrivePolicy queue attribute configured with a dead letter queue.
For more information about using dead letter queues, see Using Amazon SQS Dead Letter Queues.
", + "ListQueues": "Returns a list of your queues. The maximum number of queues that can be returned is 1000. If you specify a value for the optional QueueNamePrefix parameter, only queues with a name beginning with the specified value are returned.
Deletes the messages in a queue specified by the queue URL.
When you use the PurgeQueue API, the deleted messages in the queue cannot be retrieved.
When you purge a queue, the message deletion process takes up to 60 seconds. All messages sent to the queue before calling PurgeQueue will be deleted; messages sent to the queue while it is being purged may be deleted. While the queue is being purged, messages sent to the queue before PurgeQueue was called may be received, but will be deleted within the next minute.
Retrieves one or more messages, with a maximum limit of 10 messages, from the specified queue. Long poll support is enabled by using the WaitTimeSeconds parameter. For more information, see Amazon SQS Long Poll in the Amazon SQS Developer Guide.
Short poll is the default behavior where a weighted random set of machines is sampled on a ReceiveMessage call. This means only the messages on the sampled machines are returned. If the number of messages in the queue is small (less than 1000), it is likely you will get fewer messages than you requested per ReceiveMessage call. If the number of messages in the queue is extremely small, you might not receive any messages in a particular ReceiveMessage response; in which case you should repeat the request.
For each message returned, the response includes the following:
Message body
MD5 digest of the message body. For information about MD5, go to http://www.faqs.org/rfcs/rfc1321.html.
Message ID you received when you sent the message to the queue.
Receipt handle.
Message attributes.
MD5 digest of the message attributes.
The receipt handle is the identifier you must provide when deleting the message. For more information, see Queue and Message Identifiers in the Amazon SQS Developer Guide.
You can provide the VisibilityTimeout parameter in your request, which will be applied to the messages that Amazon SQS returns in the response. If you do not include the parameter, the overall visibility timeout for the queue is used for the returned messages. For more information, see Visibility Timeout in the Amazon SQS Developer Guide.
Going forward, new attributes might be added. If you are writing code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
Revokes any permissions in the queue policy that matches the specified Label parameter. Only the owner of the queue can remove permissions.
Delivers a message to the specified queue. With Amazon SQS, you now have the ability to send large payload messages that are up to 256KB (262,144 bytes) in size. To send large payloads, you must use an AWS SDK that supports SigV4 signing. To verify whether SigV4 is supported for an AWS SDK, check the SDK release notes.
The following list shows the characters (in Unicode) allowed in your message, according to the W3C XML specification. For more information, go to http://www.w3.org/TR/REC-xml/#charsets If you send any characters not included in the list, your request will be rejected.
#x9 | #xA | #xD | [#x20 to #xD7FF] | [#xE000 to #xFFFD] | [#x10000 to #x10FFFF]
Delivers up to ten messages to the specified queue. This is a batch version of SendMessage. The result of the send action on each message is reported individually in the response. The maximum allowed individual message size is 256 KB (262,144 bytes).
The maximum total payload size (i.e., the sum of all a batch's individual message lengths) is also 256 KB (262,144 bytes).
If the DelaySeconds parameter is not specified for an entry, the default for the queue is used.
The following list shows the characters (in Unicode) that are allowed in your message, according to the W3C XML specification. For more information, go to http://www.faqs.org/rfcs/rfc1321.html. If you send any characters that are not included in the list, your request will be rejected.
#x9 | #xA | #xD | [#x20 to #xD7FF] | [#xE000 to #xFFFD] | [#x10000 to #x10FFFF]
Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.
Some API actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:
Sets the value of one or more queue attributes. When you change a queue's attributes, the change can take up to 60 seconds for most of the attributes to propagate throughout the SQS system. Changes made to the MessageRetentionPeriod attribute can take up to 15 minutes.
Going forward, new attributes might be added. If you are writing code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
The AWS account number of the principal who will be given permission. The principal must have an AWS account, but does not need to be signed up for Amazon SQS. For information about locating the AWS account identification, see Your AWS Identifiers in the Amazon SQS Developer Guide.
" + } + }, + "ActionNameList": { + "base": null, + "refs": { + "AddPermissionRequest$Actions": "The action the client wants to allow for the specified principal. The following are valid values: * | SendMessage | ReceiveMessage | DeleteMessage | ChangeMessageVisibility | GetQueueAttributes | GetQueueUrl. For more information about these actions, see Understanding Permissions in the Amazon SQS Developer Guide.
Specifying SendMessage, DeleteMessage, or ChangeMessageVisibility for the ActionName.n also grants permissions for the corresponding batch versions of those actions: SendMessageBatch, DeleteMessageBatch, and ChangeMessageVisibilityBatch.
A map of attributes with their corresponding values.
The following lists the names, descriptions, and values of the special request parameters the CreateQueue action uses:
DelaySeconds - The time in seconds that the delivery of all messages in the queue will be delayed. An integer from 0 to 900 (15 minutes). The default for this attribute is 0 (zero).
MaximumMessageSize - The limit of how many bytes a message can contain before Amazon SQS rejects it. An integer from 1024 bytes (1 KiB) up to 262144 bytes (256 KiB). The default for this attribute is 262144 (256 KiB).
MessageRetentionPeriod - The number of seconds Amazon SQS retains a message. Integer representing seconds, from 60 (1 minute) to 1209600 (14 days). The default for this attribute is 345600 (4 days).
Policy - The queue's policy. A valid AWS policy. For more information about policy structure, see Overview of AWS IAM Policies in the Amazon IAM User Guide.
ReceiveMessageWaitTimeSeconds - The time for which a ReceiveMessage call will wait for a message to arrive. An integer from 0 to 20 (seconds). The default for this attribute is 0.
RedrivePolicy - The parameters for dead letter queue functionality of the source queue. For more information about RedrivePolicy and dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS Developer Guide.
VisibilityTimeout - The visibility timeout for the queue. An integer from 0 to 43200 (12 hours). The default for this attribute is 30. For more information about visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.
Any other valid special request parameters that are specified (such as ApproximateNumberOfMessages, ApproximateNumberOfMessagesDelayed, ApproximateNumberOfMessagesNotVisible, CreatedTimestamp, LastModifiedTimestamp, and QueueArn) will be ignored.
A map of attributes to the respective values.
", + "Message$Attributes": "SenderId, SentTimestamp, ApproximateReceiveCount, and/or ApproximateFirstReceiveTimestamp. SentTimestamp and ApproximateFirstReceiveTimestamp are each returned as an integer representing the epoch time in milliseconds.
A map of attributes to set.
The following lists the names, descriptions, and values of the special request parameters the SetQueueAttributes action uses:
DelaySeconds - The time in seconds that the delivery of all messages in the queue will be delayed. An integer from 0 to 900 (15 minutes). The default for this attribute is 0 (zero).
MaximumMessageSize - The limit of how many bytes a message can contain before Amazon SQS rejects it. An integer from 1024 bytes (1 KiB) up to 262144 bytes (256 KiB). The default for this attribute is 262144 (256 KiB).
MessageRetentionPeriod - The number of seconds Amazon SQS retains a message. Integer representing seconds, from 60 (1 minute) to 1209600 (14 days). The default for this attribute is 345600 (4 days).
Policy - The queue's policy. A valid AWS policy. For more information about policy structure, see Overview of AWS IAM Policies in the Amazon IAM User Guide.
ReceiveMessageWaitTimeSeconds - The time for which a ReceiveMessage call will wait for a message to arrive. An integer from 0 to 20 (seconds). The default for this attribute is 0.
VisibilityTimeout - The visibility timeout for the queue. An integer from 0 to 43200 (12 hours). The default for this attribute is 30. For more information about visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.
RedrivePolicy - The parameters for dead letter queue functionality of the source queue. For more information about RedrivePolicy and dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS Developer Guide.
Any other valid special request parameters that are specified (such as ApproximateNumberOfMessages, ApproximateNumberOfMessagesDelayed, ApproximateNumberOfMessagesNotVisible, CreatedTimestamp, LastModifiedTimestamp, and QueueArn) will be ignored.
A list of attributes to retrieve information for. The following attributes are supported:
All - returns all values.
ApproximateNumberOfMessages - returns the approximate number of visible messages in a queue. For more information, see Resources Required to Process Messages in the Amazon SQS Developer Guide.
ApproximateNumberOfMessagesNotVisible - returns the approximate number of messages that are not timed-out and not deleted. For more information, see Resources Required to Process Messages in the Amazon SQS Developer Guide.
VisibilityTimeout - returns the visibility timeout for the queue. For more information about visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.
CreatedTimestamp - returns the time when the queue was created (epoch time in seconds).
LastModifiedTimestamp - returns the time when the queue was last changed (epoch time in seconds).
Policy - returns the queue's policy.
MaximumMessageSize - returns the limit of how many bytes a message can contain before Amazon SQS rejects it.
MessageRetentionPeriod - returns the number of seconds Amazon SQS retains a message.
QueueArn - returns the queue's Amazon resource name (ARN).
ApproximateNumberOfMessagesDelayed - returns the approximate number of messages that are pending to be added to the queue.
DelaySeconds - returns the default delay on the queue in seconds.
ReceiveMessageWaitTimeSeconds - returns the time for which a ReceiveMessage call will wait for a message to arrive.
RedrivePolicy - returns the parameters for dead letter queue functionality of the source queue. For more information about RedrivePolicy and dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS Developer Guide.
Going forward, new attributes might be added. If you are writing code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
A list of attributes that need to be returned along with each message. These attributes include:
All - returns all values.
ApproximateFirstReceiveTimestamp - returns the time when the message was first received from the queue (epoch time in milliseconds).
ApproximateReceiveCount - returns the number of times a message has been received from the queue but not deleted.
SenderId - returns the AWS account number (or the IP address, if anonymous access is allowed) of the sender.
SentTimestamp - returns the time when the message was sent to the queue (epoch time in milliseconds).
Any other valid special request parameters that are specified (such as ApproximateNumberOfMessages, ApproximateNumberOfMessagesDelayed, ApproximateNumberOfMessagesNotVisible, CreatedTimestamp, DelaySeconds, LastModifiedTimestamp, MaximumMessageSize, MessageRetentionPeriod, Policy, QueueArn, ReceiveMessageWaitTimeSeconds, RedrivePolicy, and VisibilityTimeout) will be ignored.
Two or more batch entries have the same Id in the request.
The length of all the messages put together is more than the limit.
", + "refs": { + } + }, + "BatchResultErrorEntry": { + "base": "This is used in the responses of batch API to give a detailed description of the result of an action on each entry in the request.
", + "refs": { + "BatchResultErrorEntryList$member": null + } + }, + "BatchResultErrorEntryList": { + "base": null, + "refs": { + "ChangeMessageVisibilityBatchResult$Failed": "A list of BatchResultErrorEntry items.
", + "DeleteMessageBatchResult$Failed": "A list of BatchResultErrorEntry items.
", + "SendMessageBatchResult$Failed": "A list of BatchResultErrorEntry items with the error detail about each message that could not be enqueued.
" + } + }, + "Binary": { + "base": null, + "refs": { + "BinaryList$member": null, + "MessageAttributeValue$BinaryValue": "Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images.
" + } + }, + "BinaryList": { + "base": null, + "refs": { + "MessageAttributeValue$BinaryListValues": "Not implemented. Reserved for future use.
" + } + }, + "Boolean": { + "base": null, + "refs": { + "BatchResultErrorEntry$SenderFault": "Whether the error happened due to the sender's fault.
" + } + }, + "ChangeMessageVisibilityBatchRequest": { + "base": "", + "refs": { + } + }, + "ChangeMessageVisibilityBatchRequestEntry": { + "base": "Encloses a receipt handle and an entry id for each message in ChangeMessageVisibilityBatch.
All of the following parameters are list parameters that must be prefixed with ChangeMessageVisibilityBatchRequestEntry.n, where n is an integer value starting with 1. For example, a parameter list for this action might look like this:
Your_Receipt_Handle]]>
A list of receipt handles of the messages for which the visibility timeout must be changed.
" + } + }, + "ChangeMessageVisibilityBatchResult": { + "base": "For each message in the batch, the response contains a ChangeMessageVisibilityBatchResultEntry tag if the message succeeds or a BatchResultErrorEntry tag if the message fails.
", + "refs": { + } + }, + "ChangeMessageVisibilityBatchResultEntry": { + "base": "Encloses the id of an entry in ChangeMessageVisibilityBatch.
", + "refs": { + "ChangeMessageVisibilityBatchResultEntryList$member": null + } + }, + "ChangeMessageVisibilityBatchResultEntryList": { + "base": null, + "refs": { + "ChangeMessageVisibilityBatchResult$Successful": "A list of ChangeMessageVisibilityBatchResultEntry items.
" + } + }, + "ChangeMessageVisibilityRequest": { + "base": null, + "refs": { + } + }, + "CreateQueueRequest": { + "base": "", + "refs": { + } + }, + "CreateQueueResult": { + "base": "Returns the QueueUrl element of the created queue.
", + "refs": { + } + }, + "DeleteMessageBatchRequest": { + "base": "", + "refs": { + } + }, + "DeleteMessageBatchRequestEntry": { + "base": "Encloses a receipt handle and an identifier for it.
", + "refs": { + "DeleteMessageBatchRequestEntryList$member": null + } + }, + "DeleteMessageBatchRequestEntryList": { + "base": null, + "refs": { + "DeleteMessageBatchRequest$Entries": "A list of receipt handles for the messages to be deleted.
" + } + }, + "DeleteMessageBatchResult": { + "base": "For each message in the batch, the response contains a DeleteMessageBatchResultEntry tag if the message is deleted or a BatchResultErrorEntry tag if the message cannot be deleted.
", + "refs": { + } + }, + "DeleteMessageBatchResultEntry": { + "base": "Encloses the id an entry in DeleteMessageBatch.
", + "refs": { + "DeleteMessageBatchResultEntryList$member": null + } + }, + "DeleteMessageBatchResultEntryList": { + "base": null, + "refs": { + "DeleteMessageBatchResult$Successful": "A list of DeleteMessageBatchResultEntry items.
" + } + }, + "DeleteMessageRequest": { + "base": "", + "refs": { + } + }, + "DeleteQueueRequest": { + "base": "", + "refs": { + } + }, + "EmptyBatchRequest": { + "base": "Batch request does not contain an entry.
", + "refs": { + } + }, + "GetQueueAttributesRequest": { + "base": "", + "refs": { + } + }, + "GetQueueAttributesResult": { + "base": "A list of returned queue attributes.
", + "refs": { + } + }, + "GetQueueUrlRequest": { + "base": "", + "refs": { + } + }, + "GetQueueUrlResult": { + "base": "For more information, see Responses in the Amazon SQS Developer Guide.
", + "refs": { + } + }, + "Integer": { + "base": null, + "refs": { + "ChangeMessageVisibilityBatchRequestEntry$VisibilityTimeout": "The new value (in seconds) for the message's visibility timeout.
", + "ChangeMessageVisibilityRequest$VisibilityTimeout": "The new value (in seconds - from 0 to 43200 - maximum 12 hours) for the message's visibility timeout.
", + "ReceiveMessageRequest$MaxNumberOfMessages": "The maximum number of messages to return. Amazon SQS never returns more messages than this value but may return fewer. Values can be from 1 to 10. Default is 1.
All of the messages are not necessarily returned.
", + "ReceiveMessageRequest$VisibilityTimeout": "The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request.
The duration (in seconds) for which the call will wait for a message to arrive in the queue before returning. If a message is available, the call will return sooner than WaitTimeSeconds.
", + "SendMessageBatchRequestEntry$DelaySeconds": "The number of seconds for which the message has to be delayed.
", + "SendMessageRequest$DelaySeconds": " The number of seconds (0 to 900 - 15 minutes) to delay a specific message. Messages with a positive DelaySeconds value become available for processing after the delay time is finished. If you don't specify a value, the default value for the queue applies.
The attribute referred to does not exist.
", + "refs": { + } + }, + "InvalidBatchEntryId": { + "base": "The Id of a batch entry in a batch request does not abide by the specification.
The receipt handle is not valid for the current version.
", + "refs": { + } + }, + "InvalidMessageContents": { + "base": "The message contains characters outside the allowed set.
", + "refs": { + } + }, + "ListDeadLetterSourceQueuesRequest": { + "base": "", + "refs": { + } + }, + "ListDeadLetterSourceQueuesResult": { + "base": "A list of your dead letter source queues.
", + "refs": { + } + }, + "ListQueuesRequest": { + "base": "", + "refs": { + } + }, + "ListQueuesResult": { + "base": "A list of your queues.
", + "refs": { + } + }, + "Message": { + "base": "An Amazon SQS message.
", + "refs": { + "MessageList$member": null + } + }, + "MessageAttributeMap": { + "base": null, + "refs": { + "Message$MessageAttributes": "Each message attribute consists of a Name, Type, and Value. For more information, see Message Attribute Items.
", + "SendMessageBatchRequestEntry$MessageAttributes": "Each message attribute consists of a Name, Type, and Value. For more information, see Message Attribute Items.
", + "SendMessageRequest$MessageAttributes": "Each message attribute consists of a Name, Type, and Value. For more information, see Message Attribute Items.
" + } + }, + "MessageAttributeName": { + "base": null, + "refs": { + "MessageAttributeNameList$member": null + } + }, + "MessageAttributeNameList": { + "base": null, + "refs": { + "ReceiveMessageRequest$MessageAttributeNames": "The name of the message attribute, where N is the index. The message attribute name can contain the following characters: A-Z, a-z, 0-9, underscore (_), hyphen (-), and period (.). The name must not start or end with a period, and it should not have successive periods. The name is case sensitive and must be unique among all attribute names for the message. The name can be up to 256 characters long. The name cannot start with \"AWS.\" or \"Amazon.\" (or any variations in casing), because these prefixes are reserved for use by Amazon Web Services.
When using ReceiveMessage, you can send a list of attribute names to receive, or you can return all of the attributes by specifying \"All\" or \".*\" in your request. You can also use \"bar.*\" to return all message attributes starting with the \"bar\" prefix.
The user-specified message attribute value. For string data types, the value attribute has the same restrictions on the content as the message body. For more information, see SendMessage.
Name, type, and value must not be empty or null. In addition, the message body should not be empty or null. All parts of the message attribute, including name, type, and value, are included in the message size restriction, which is currently 256 KB (262,144 bytes).
", + "refs": { + "MessageAttributeMap$value": null + } + }, + "MessageList": { + "base": null, + "refs": { + "ReceiveMessageResult$Messages": "A list of messages.
" + } + }, + "MessageNotInflight": { + "base": "The message referred to is not in flight.
", + "refs": { + } + }, + "OverLimit": { + "base": "The action that you requested would violate a limit. For example, ReceiveMessage returns this error if the maximum number of messages inflight has already been reached. AddPermission returns this error if the maximum number of permissions for the queue has already been reached.
", + "refs": { + } + }, + "PurgeQueueInProgress": { + "base": "Indicates that the specified queue previously received a PurgeQueue request within the last 60 seconds, the time it can take to delete the messages in the queue.
You must wait 60 seconds after deleting a queue before you can create another with the same name.
", + "refs": { + } + }, + "QueueDoesNotExist": { + "base": "The queue referred to does not exist.
", + "refs": { + } + }, + "QueueNameExists": { + "base": "A queue already exists with this name. Amazon SQS returns this error only if the request includes attributes whose values differ from those of the existing queue.
", + "refs": { + } + }, + "QueueUrlList": { + "base": null, + "refs": { + "ListDeadLetterSourceQueuesResult$queueUrls": "A list of source queue URLs that have the RedrivePolicy queue attribute configured with a dead letter queue.
", + "ListQueuesResult$QueueUrls": "A list of queue URLs, up to 1000 entries.
" + } + }, + "ReceiptHandleIsInvalid": { + "base": "The receipt handle provided is not valid.
", + "refs": { + } + }, + "ReceiveMessageRequest": { + "base": "", + "refs": { + } + }, + "ReceiveMessageResult": { + "base": "A list of received messages.
", + "refs": { + } + }, + "RemovePermissionRequest": { + "base": "", + "refs": { + } + }, + "SendMessageBatchRequest": { + "base": "", + "refs": { + } + }, + "SendMessageBatchRequestEntry": { + "base": "Contains the details of a single Amazon SQS message along with a Id.
A list of SendMessageBatchRequestEntry items.
" + } + }, + "SendMessageBatchResult": { + "base": "For each message in the batch, the response contains a SendMessageBatchResultEntry tag if the message succeeds or a BatchResultErrorEntry tag if the message fails.
", + "refs": { + } + }, + "SendMessageBatchResultEntry": { + "base": "Encloses a message ID for successfully enqueued message of a SendMessageBatch.
", + "refs": { + "SendMessageBatchResultEntryList$member": null + } + }, + "SendMessageBatchResultEntryList": { + "base": null, + "refs": { + "SendMessageBatchResult$Successful": "A list of SendMessageBatchResultEntry items.
" + } + }, + "SendMessageRequest": { + "base": "", + "refs": { + } + }, + "SendMessageResult": { + "base": "The MD5OfMessageBody and MessageId elements.
", + "refs": { + } + }, + "SetQueueAttributesRequest": { + "base": "", + "refs": { + } + }, + "String": { + "base": null, + "refs": { + "AWSAccountIdList$member": null, + "ActionNameList$member": null, + "AddPermissionRequest$QueueUrl": "The URL of the Amazon SQS queue to take action on.
Queue URLs are case-sensitive.
", + "AddPermissionRequest$Label": "The unique identification of the permission you're setting (e.g., AliceSendMessage). Constraints: Maximum 80 characters; alphanumeric characters, hyphens (-), and underscores (_) are allowed.
The id of an entry in a batch request.
", + "BatchResultErrorEntry$Code": "An error code representing why the action failed on this entry.
", + "BatchResultErrorEntry$Message": "A message explaining why the action failed on this entry.
", + "ChangeMessageVisibilityBatchRequest$QueueUrl": "The URL of the Amazon SQS queue to take action on.
Queue URLs are case-sensitive.
", + "ChangeMessageVisibilityBatchRequestEntry$Id": "An identifier for this particular receipt handle. This is used to communicate the result. Note that the Ids of a batch request need to be unique within the request.
A receipt handle.
", + "ChangeMessageVisibilityBatchResultEntry$Id": "Represents a message whose visibility timeout has been changed successfully.
", + "ChangeMessageVisibilityRequest$QueueUrl": "The URL of the Amazon SQS queue to take action on.
Queue URLs are case-sensitive.
", + "ChangeMessageVisibilityRequest$ReceiptHandle": "The receipt handle associated with the message whose visibility timeout should be changed. This parameter is returned by the ReceiveMessage action.
", + "CreateQueueRequest$QueueName": "The name for the queue to be created.
Queue names are case-sensitive.
", + "CreateQueueResult$QueueUrl": "The URL for the created Amazon SQS queue.
", + "DeleteMessageBatchRequest$QueueUrl": "The URL of the Amazon SQS queue to take action on.
Queue URLs are case-sensitive.
", + "DeleteMessageBatchRequestEntry$Id": "An identifier for this particular receipt handle. This is used to communicate the result. Note that the Ids of a batch request need to be unique within the request.
A receipt handle.
", + "DeleteMessageBatchResultEntry$Id": "Represents a successfully deleted message.
", + "DeleteMessageRequest$QueueUrl": "The URL of the Amazon SQS queue to take action on.
Queue URLs are case-sensitive.
", + "DeleteMessageRequest$ReceiptHandle": "The receipt handle associated with the message to delete.
", + "DeleteQueueRequest$QueueUrl": "The URL of the Amazon SQS queue to take action on.
Queue URLs are case-sensitive.
", + "GetQueueAttributesRequest$QueueUrl": "The URL of the Amazon SQS queue to take action on.
Queue URLs are case-sensitive.
", + "GetQueueUrlRequest$QueueName": "The name of the queue whose URL must be fetched. Maximum 80 characters; alphanumeric characters, hyphens (-), and underscores (_) are allowed.
Queue names are case-sensitive.
", + "GetQueueUrlRequest$QueueOwnerAWSAccountId": "The AWS account ID of the account that created the queue.
", + "GetQueueUrlResult$QueueUrl": "The URL for the queue.
", + "ListDeadLetterSourceQueuesRequest$QueueUrl": "The queue URL of a dead letter queue.
Queue URLs are case-sensitive.
", + "ListQueuesRequest$QueueNamePrefix": "A string to use for filtering the list results. Only those queues whose name begins with the specified string are returned.
Queue names are case-sensitive.
", + "Message$MessageId": "A unique identifier for the message. Message IDs are considered unique across all AWS accounts for an extended period of time.
", + "Message$ReceiptHandle": "An identifier associated with the act of receiving the message. A new receipt handle is returned every time you receive a message. When deleting a message, you provide the last received receipt handle to delete the message.
", + "Message$MD5OfBody": "An MD5 digest of the non-URL-encoded message body string.
", + "Message$Body": "The message's contents (not URL-encoded).
", + "Message$MD5OfMessageAttributes": "An MD5 digest of the non-URL-encoded message attribute string. This can be used to verify that Amazon SQS received the message correctly. Amazon SQS first URL decodes the message before creating the MD5 digest. For information about MD5, go to http://www.faqs.org/rfcs/rfc1321.html.
", + "MessageAttributeMap$key": null, + "MessageAttributeValue$StringValue": "Strings are Unicode with UTF8 binary encoding. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
", + "MessageAttributeValue$DataType": "Amazon SQS supports the following logical data types: String, Number, and Binary. For the Number data type, you must use StringValue.
You can also append custom labels. For more information, see Message Attribute Data Types.
", + "PurgeQueueRequest$QueueUrl": "The queue URL of the queue to delete the messages from when using the PurgeQueue API.
Queue URLs are case-sensitive.
", + "QueueUrlList$member": null, + "ReceiveMessageRequest$QueueUrl": "The URL of the Amazon SQS queue to take action on.
Queue URLs are case-sensitive.
", + "RemovePermissionRequest$QueueUrl": "The URL of the Amazon SQS queue to take action on.
Queue URLs are case-sensitive.
", + "RemovePermissionRequest$Label": "The identification of the permission to remove. This is the label added with the AddPermission action.
", + "SendMessageBatchRequest$QueueUrl": "The URL of the Amazon SQS queue to take action on.
Queue URLs are case-sensitive.
", + "SendMessageBatchRequestEntry$Id": "An identifier for the message in this batch. This is used to communicate the result. Note that the Ids of a batch request need to be unique within the request.
Body of the message.
", + "SendMessageBatchResultEntry$Id": "An identifier for the message in this batch.
", + "SendMessageBatchResultEntry$MessageId": "An identifier for the message.
", + "SendMessageBatchResultEntry$MD5OfMessageBody": "An MD5 digest of the non-URL-encoded message body string. This can be used to verify that Amazon SQS received the message correctly. Amazon SQS first URL decodes the message before creating the MD5 digest. For information about MD5, go to http://www.faqs.org/rfcs/rfc1321.html.
", + "SendMessageBatchResultEntry$MD5OfMessageAttributes": "An MD5 digest of the non-URL-encoded message attribute string. This can be used to verify that Amazon SQS received the message batch correctly. Amazon SQS first URL decodes the message before creating the MD5 digest. For information about MD5, go to http://www.faqs.org/rfcs/rfc1321.html.
", + "SendMessageRequest$QueueUrl": "The URL of the Amazon SQS queue to take action on.
Queue URLs are case-sensitive.
", + "SendMessageRequest$MessageBody": "The message to send. String maximum 256 KB in size. For a list of allowed characters, see the preceding important note.
", + "SendMessageResult$MD5OfMessageBody": "An MD5 digest of the non-URL-encoded message body string. This can be used to verify that Amazon SQS received the message correctly. Amazon SQS first URL decodes the message before creating the MD5 digest. For information about MD5, go to http://www.faqs.org/rfcs/rfc1321.html.
", + "SendMessageResult$MD5OfMessageAttributes": "An MD5 digest of the non-URL-encoded message attribute string. This can be used to verify that Amazon SQS received the message correctly. Amazon SQS first URL decodes the message before creating the MD5 digest. For information about MD5, go to http://www.faqs.org/rfcs/rfc1321.html.
", + "SendMessageResult$MessageId": "An element containing the message ID of the message sent to the queue. For more information, see Queue and Message Identifiers in the Amazon SQS Developer Guide.
", + "SetQueueAttributesRequest$QueueUrl": "The URL of the Amazon SQS queue to take action on.
Queue URLs are case-sensitive.
", + "StringList$member": null + } + }, + "StringList": { + "base": null, + "refs": { + "MessageAttributeValue$StringListValues": "Not implemented. Reserved for future use.
" + } + }, + "TooManyEntriesInBatchRequest": { + "base": "Batch request contains more number of entries than permissible.
", + "refs": { + } + }, + "UnsupportedOperation": { + "base": "Error code 400. Unsupported operation.
", + "refs": { + } + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/sqs/2012-11-05/examples-1.json b/vendor/github.com/aws/aws-sdk-go/models/apis/sqs/2012-11-05/examples-1.json new file mode 100644 index 000000000..ec813934f --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/sqs/2012-11-05/examples-1.json @@ -0,0 +1,44 @@ +{ + "version": "1.0", + "examples": { + "CreateQueue": [ + { + "input": { + "QueueName": "MyQueue" + }, + "output": { + "QueueUrl": "https://queue.amazonaws.com/012345678910/MyQueue" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following operation creates an SQS queue named MyQueue.", + "id": "create-an-sqs-queue-1445915686197", + "title": "Create an SQS queue" + } + ], + "GetQueueUrl": [ + { + "input": { + "QueueName": "MyQueue", + "QueueOwnerAWSAccountId": "12345678910" + }, + "output": { + "QueueUrl": "https://queue.amazonaws.com/12345678910/MyQueue" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example retrieves the queue ARN.", + "id": "retrieve-queue-attributes-from-an-sqs-queue-1445915930574", + "title": "Retrieve queue attributes from an SQS queue" + } + ] + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/sqs/2012-11-05/paginators-1.json b/vendor/github.com/aws/aws-sdk-go/models/apis/sqs/2012-11-05/paginators-1.json new file mode 100644 index 000000000..e7ac48a9f --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/sqs/2012-11-05/paginators-1.json @@ -0,0 +1,7 @@ +{ + "pagination": { + "ListQueues": { + "result_key": "QueueUrls" + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/ssm/2014-11-06/api-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/ssm/2014-11-06/api-2.json new file mode 100644 index 000000000..a29b991bc --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/ssm/2014-11-06/api-2.json @@ -0,0 +1,1742 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2014-11-06", + "endpointPrefix":"ssm", + "jsonVersion":"1.1", + "protocol":"json", + "serviceAbbreviation":"Amazon SSM", + "serviceFullName":"Amazon Simple Systems Management Service", + "signatureVersion":"v4", + "targetPrefix":"AmazonSSM" + }, + "operations":{ + "AddTagsToResource":{ + "name":"AddTagsToResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddTagsToResourceRequest"}, + "output":{"shape":"AddTagsToResourceResult"}, + "errors":[ + {"shape":"InvalidResourceType"}, + {"shape":"InvalidResourceId"}, + {"shape":"InternalServerError"} + ] + }, + "CancelCommand":{ + "name":"CancelCommand", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelCommandRequest"}, + "output":{"shape":"CancelCommandResult"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"InvalidCommandId"}, + {"shape":"InvalidInstanceId"}, + {"shape":"DuplicateInstanceId"} + ] + }, + "CreateActivation":{ + "name":"CreateActivation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateActivationRequest"}, + "output":{"shape":"CreateActivationResult"}, + "errors":[ + {"shape":"InternalServerError"} + ] + }, + "CreateAssociation":{ + "name":"CreateAssociation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateAssociationRequest"}, + "output":{"shape":"CreateAssociationResult"}, + "errors":[ + {"shape":"AssociationAlreadyExists"}, + {"shape":"AssociationLimitExceeded"}, + {"shape":"InternalServerError"}, + {"shape":"InvalidDocument"}, + {"shape":"InvalidInstanceId"}, + {"shape":"UnsupportedPlatformType"}, + {"shape":"InvalidParameters"} + ] + }, + "CreateAssociationBatch":{ + "name":"CreateAssociationBatch", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateAssociationBatchRequest"}, + "output":{"shape":"CreateAssociationBatchResult"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"InvalidDocument"}, + {"shape":"InvalidInstanceId"}, + {"shape":"InvalidParameters"}, + {"shape":"DuplicateInstanceId"}, + {"shape":"AssociationLimitExceeded"}, + {"shape":"UnsupportedPlatformType"} + ] + }, + "CreateDocument":{ + "name":"CreateDocument", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDocumentRequest"}, + "output":{"shape":"CreateDocumentResult"}, + "errors":[ + {"shape":"DocumentAlreadyExists"}, + {"shape":"MaxDocumentSizeExceeded"}, + {"shape":"InternalServerError"}, + {"shape":"InvalidDocumentContent"}, + {"shape":"DocumentLimitExceeded"} + ] + }, + "DeleteActivation":{ + "name":"DeleteActivation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteActivationRequest"}, + "output":{"shape":"DeleteActivationResult"}, + "errors":[ + {"shape":"InvalidActivationId"}, + {"shape":"InvalidActivation"}, + {"shape":"InternalServerError"} + ] + }, + "DeleteAssociation":{ + "name":"DeleteAssociation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteAssociationRequest"}, + "output":{"shape":"DeleteAssociationResult"}, + "errors":[ + {"shape":"AssociationDoesNotExist"}, + {"shape":"InternalServerError"}, + {"shape":"InvalidDocument"}, + {"shape":"InvalidInstanceId"}, + {"shape":"TooManyUpdates"} + ] + }, + "DeleteDocument":{ + "name":"DeleteDocument", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDocumentRequest"}, + "output":{"shape":"DeleteDocumentResult"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"InvalidDocument"}, + {"shape":"InvalidDocumentOperation"}, + {"shape":"AssociatedInstances"} + ] + }, + "DeregisterManagedInstance":{ + "name":"DeregisterManagedInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeregisterManagedInstanceRequest"}, + "output":{"shape":"DeregisterManagedInstanceResult"}, + "errors":[ + {"shape":"InvalidInstanceId"}, + {"shape":"InternalServerError"} + ] + }, + "DescribeActivations":{ + "name":"DescribeActivations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeActivationsRequest"}, + "output":{"shape":"DescribeActivationsResult"}, + "errors":[ + {"shape":"InvalidFilter"}, + {"shape":"InvalidNextToken"}, + {"shape":"InternalServerError"} + ] + }, + "DescribeAssociation":{ + "name":"DescribeAssociation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAssociationRequest"}, + "output":{"shape":"DescribeAssociationResult"}, + "errors":[ + {"shape":"AssociationDoesNotExist"}, + {"shape":"InternalServerError"}, + {"shape":"InvalidDocument"}, + {"shape":"InvalidInstanceId"} + ] + }, + "DescribeDocument":{ + "name":"DescribeDocument", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDocumentRequest"}, + "output":{"shape":"DescribeDocumentResult"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"InvalidDocument"} + ] + }, + "DescribeDocumentPermission":{ + "name":"DescribeDocumentPermission", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDocumentPermissionRequest"}, + "output":{"shape":"DescribeDocumentPermissionResponse"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"InvalidDocument"}, + {"shape":"InvalidPermissionType"} + ] + }, + "DescribeInstanceInformation":{ + "name":"DescribeInstanceInformation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeInstanceInformationRequest"}, + "output":{"shape":"DescribeInstanceInformationResult"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"InvalidInstanceId"}, + {"shape":"InvalidNextToken"}, + {"shape":"InvalidInstanceInformationFilterValue"}, + {"shape":"InvalidFilterKey"} + ] + }, + "GetDocument":{ + "name":"GetDocument", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetDocumentRequest"}, + "output":{"shape":"GetDocumentResult"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"InvalidDocument"} + ] + }, + "ListAssociations":{ + "name":"ListAssociations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAssociationsRequest"}, + "output":{"shape":"ListAssociationsResult"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"InvalidNextToken"} + ] + }, + "ListCommandInvocations":{ + "name":"ListCommandInvocations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListCommandInvocationsRequest"}, + "output":{"shape":"ListCommandInvocationsResult"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"InvalidCommandId"}, + {"shape":"InvalidInstanceId"}, + {"shape":"InvalidFilterKey"}, + {"shape":"InvalidNextToken"} + ] + }, + "ListCommands":{ + "name":"ListCommands", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListCommandsRequest"}, + "output":{"shape":"ListCommandsResult"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"InvalidCommandId"}, + {"shape":"InvalidInstanceId"}, + {"shape":"InvalidFilterKey"}, + {"shape":"InvalidNextToken"} + ] + }, + "ListDocuments":{ + "name":"ListDocuments", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListDocumentsRequest"}, + "output":{"shape":"ListDocumentsResult"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"InvalidNextToken"}, + {"shape":"InvalidFilterKey"} + ] + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResult"}, + "errors":[ + {"shape":"InvalidResourceType"}, + {"shape":"InvalidResourceId"}, + {"shape":"InternalServerError"} + ] + }, + "ModifyDocumentPermission":{ + "name":"ModifyDocumentPermission", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyDocumentPermissionRequest"}, + "output":{"shape":"ModifyDocumentPermissionResponse"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"InvalidDocument"}, + {"shape":"InvalidPermissionType"}, + {"shape":"DocumentPermissionLimit"}, + {"shape":"DocumentLimitExceeded"} + ] + }, + "RemoveTagsFromResource":{ + "name":"RemoveTagsFromResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RemoveTagsFromResourceRequest"}, + "output":{"shape":"RemoveTagsFromResourceResult"}, + "errors":[ + {"shape":"InvalidResourceType"}, + {"shape":"InvalidResourceId"}, + {"shape":"InternalServerError"} + ] + }, + "SendCommand":{ + "name":"SendCommand", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SendCommandRequest"}, + "output":{"shape":"SendCommandResult"}, + "errors":[ + {"shape":"DuplicateInstanceId"}, + {"shape":"InternalServerError"}, + {"shape":"InvalidInstanceId"}, + {"shape":"InvalidDocument"}, + {"shape":"InvalidOutputFolder"}, + {"shape":"InvalidParameters"}, + {"shape":"UnsupportedPlatformType"}, + {"shape":"MaxDocumentSizeExceeded"} + ] + }, + "UpdateAssociationStatus":{ + "name":"UpdateAssociationStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateAssociationStatusRequest"}, + "output":{"shape":"UpdateAssociationStatusResult"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"InvalidInstanceId"}, + {"shape":"InvalidDocument"}, + {"shape":"AssociationDoesNotExist"}, + {"shape":"StatusUnchanged"}, + {"shape":"TooManyUpdates"} + ] + }, + "UpdateManagedInstanceRole":{ + "name":"UpdateManagedInstanceRole", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateManagedInstanceRoleRequest"}, + "output":{"shape":"UpdateManagedInstanceRoleResult"}, + "errors":[ + {"shape":"InvalidInstanceId"}, + {"shape":"InternalServerError"} + ] + } + }, + "shapes":{ + "AccountId":{ + "type":"string", + "pattern":"(?i)all|[0-9]{12}" + }, + "AccountIdList":{ + "type":"list", + "member":{ + "shape":"AccountId", + "locationName":"AccountId" + }, + "max":20 + }, + "Activation":{ + "type":"structure", + "members":{ + "ActivationId":{"shape":"ActivationId"}, + "Description":{"shape":"ActivationDescription"}, + "DefaultInstanceName":{"shape":"DefaultInstanceName"}, + "IamRole":{"shape":"IamRole"}, + "RegistrationLimit":{"shape":"RegistrationLimit"}, + "RegistrationsCount":{"shape":"RegistrationsCount"}, + "ExpirationDate":{"shape":"ExpirationDate"}, + "Expired":{"shape":"Boolean"}, + "CreatedDate":{"shape":"CreatedDate"} + } + }, + "ActivationCode":{ + "type":"string", + "max":250, + "min":20 + }, + "ActivationDescription":{ + "type":"string", + "max":256, + "min":0 + }, + "ActivationId":{ + "type":"string", + "pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" + }, + "ActivationList":{ + "type":"list", + "member":{"shape":"Activation"} + }, + "AddTagsToResourceRequest":{ + "type":"structure", + "required":[ + "ResourceType", + "ResourceId", + "Tags" + ], + "members":{ + "ResourceType":{"shape":"ResourceTypeForTagging"}, + "ResourceId":{"shape":"ResourceId"}, + "Tags":{"shape":"TagList"} + } + }, + "AddTagsToResourceResult":{ + "type":"structure", + "members":{ + } + }, + "AssociatedInstances":{ + "type":"structure", + "members":{ + }, + "exception":true + }, + "Association":{ + "type":"structure", + "members":{ + "Name":{"shape":"DocumentName"}, + "InstanceId":{"shape":"InstanceId"} + } + }, + "AssociationAlreadyExists":{ + "type":"structure", + "members":{ + }, + "exception":true + }, + "AssociationDescription":{ + "type":"structure", + "members":{ + "Name":{"shape":"DocumentName"}, + "InstanceId":{"shape":"InstanceId"}, + "Date":{"shape":"DateTime"}, + "Status":{"shape":"AssociationStatus"}, + "Parameters":{"shape":"Parameters"} + } + }, + "AssociationDescriptionList":{ + "type":"list", + "member":{ + "shape":"AssociationDescription", + "locationName":"AssociationDescription" + } + }, + "AssociationDoesNotExist":{ + "type":"structure", + "members":{ + }, + "exception":true + }, + "AssociationFilter":{ + "type":"structure", + "required":[ + "key", + "value" + ], + "members":{ + "key":{"shape":"AssociationFilterKey"}, + "value":{"shape":"AssociationFilterValue"} + } + }, + "AssociationFilterKey":{ + "type":"string", + "enum":[ + "InstanceId", + "Name" + ] + }, + "AssociationFilterList":{ + "type":"list", + "member":{ + "shape":"AssociationFilter", + "locationName":"AssociationFilter" + }, + "min":1 + }, + "AssociationFilterValue":{ + "type":"string", + "min":1 + }, + "AssociationLimitExceeded":{ + "type":"structure", + "members":{ + }, + "exception":true + }, + "AssociationList":{ + "type":"list", + "member":{ + "shape":"Association", + "locationName":"Association" + } + }, + "AssociationStatus":{ + "type":"structure", + "required":[ + "Date", + "Name", + "Message" + ], + "members":{ + "Date":{"shape":"DateTime"}, + "Name":{"shape":"AssociationStatusName"}, + "Message":{"shape":"StatusMessage"}, + "AdditionalInfo":{"shape":"StatusAdditionalInfo"} + } + }, + "AssociationStatusName":{ + "type":"string", + "enum":[ + "Pending", + "Success", + "Failed" + ] + }, + "BatchErrorMessage":{"type":"string"}, + "Boolean":{"type":"boolean"}, + "CancelCommandRequest":{ + "type":"structure", + "required":["CommandId"], + "members":{ + "CommandId":{"shape":"CommandId"}, + "InstanceIds":{"shape":"InstanceIdList"} + } + }, + "CancelCommandResult":{ + "type":"structure", + "members":{ + } + }, + "Command":{ + "type":"structure", + "members":{ + "CommandId":{"shape":"CommandId"}, + "DocumentName":{"shape":"DocumentName"}, + "Comment":{"shape":"Comment"}, + "ExpiresAfter":{"shape":"DateTime"}, + "Parameters":{"shape":"Parameters"}, + "InstanceIds":{"shape":"InstanceIdList"}, + "RequestedDateTime":{"shape":"DateTime"}, + "Status":{"shape":"CommandStatus"}, + "OutputS3BucketName":{"shape":"S3BucketName"}, + "OutputS3KeyPrefix":{"shape":"S3KeyPrefix"} + } + }, + "CommandFilter":{ + "type":"structure", + "required":[ + "key", + "value" + ], + "members":{ + "key":{"shape":"CommandFilterKey"}, + "value":{"shape":"CommandFilterValue"} + } + }, + "CommandFilterKey":{ + "type":"string", + "enum":[ + "InvokedAfter", + "InvokedBefore", + "Status" + ] + }, + "CommandFilterList":{ + "type":"list", + "member":{"shape":"CommandFilter"}, + "max":3, + "min":1 + }, + "CommandFilterValue":{ + "type":"string", + "min":1 + }, + "CommandId":{ + "type":"string", + "max":36, + "min":36 + }, + "CommandInvocation":{ + "type":"structure", + "members":{ + "CommandId":{"shape":"CommandId"}, + "InstanceId":{"shape":"InstanceId"}, + "Comment":{"shape":"Comment"}, + "DocumentName":{"shape":"DocumentName"}, + "RequestedDateTime":{"shape":"DateTime"}, + "Status":{"shape":"CommandInvocationStatus"}, + "TraceOutput":{"shape":"InvocationTraceOutput"}, + "CommandPlugins":{"shape":"CommandPluginList"} + } + }, + "CommandInvocationList":{ + "type":"list", + "member":{"shape":"CommandInvocation"} + }, + "CommandInvocationStatus":{ + "type":"string", + "enum":[ + "Pending", + "InProgress", + "Cancelling", + "Success", + "TimedOut", + "Cancelled", + "Failed" + ] + }, + "CommandList":{ + "type":"list", + "member":{"shape":"Command"} + }, + "CommandMaxResults":{ + "type":"integer", + "max":50, + "min":1 + }, + "CommandPlugin":{ + "type":"structure", + "members":{ + "Name":{"shape":"CommandPluginName"}, + "Status":{"shape":"CommandPluginStatus"}, + "ResponseCode":{"shape":"ResponseCode"}, + "ResponseStartDateTime":{"shape":"DateTime"}, + "ResponseFinishDateTime":{"shape":"DateTime"}, + "Output":{"shape":"CommandPluginOutput"}, + "OutputS3BucketName":{"shape":"S3BucketName"}, + "OutputS3KeyPrefix":{"shape":"S3KeyPrefix"} + } + }, + "CommandPluginList":{ + "type":"list", + "member":{"shape":"CommandPlugin"} + }, + "CommandPluginName":{ + "type":"string", + "min":4 + }, + "CommandPluginOutput":{ + "type":"string", + "max":2500 + }, + "CommandPluginStatus":{ + "type":"string", + "enum":[ + "Pending", + "InProgress", + "Success", + "TimedOut", + "Cancelled", + "Failed" + ] + }, + "CommandStatus":{ + "type":"string", + "enum":[ + "Pending", + "InProgress", + "Cancelling", + "Success", + "TimedOut", + "Cancelled", + "Failed" + ] + }, + "Comment":{ + "type":"string", + "max":100 + }, + "ComputerName":{ + "type":"string", + "max":255, + "min":1 + }, + "CreateActivationRequest":{ + "type":"structure", + "required":["IamRole"], + "members":{ + "Description":{"shape":"ActivationDescription"}, + "DefaultInstanceName":{"shape":"DefaultInstanceName"}, + "IamRole":{"shape":"IamRole"}, + "RegistrationLimit":{ + "shape":"RegistrationLimit", + "box":true + }, + "ExpirationDate":{"shape":"ExpirationDate"} + } + }, + "CreateActivationResult":{ + "type":"structure", + "members":{ + "ActivationId":{"shape":"ActivationId"}, + "ActivationCode":{"shape":"ActivationCode"} + } + }, + "CreateAssociationBatchRequest":{ + "type":"structure", + "required":["Entries"], + "members":{ + "Entries":{"shape":"CreateAssociationBatchRequestEntries"} + } + }, + "CreateAssociationBatchRequestEntries":{ + "type":"list", + "member":{ + "shape":"CreateAssociationBatchRequestEntry", + "locationName":"entries" + } + }, + "CreateAssociationBatchRequestEntry":{ + "type":"structure", + "members":{ + "Name":{"shape":"DocumentName"}, + "InstanceId":{"shape":"InstanceId"}, + "Parameters":{"shape":"Parameters"} + } + }, + "CreateAssociationBatchResult":{ + "type":"structure", + "members":{ + "Successful":{"shape":"AssociationDescriptionList"}, + "Failed":{"shape":"FailedCreateAssociationList"} + } + }, + "CreateAssociationRequest":{ + "type":"structure", + "required":[ + "Name", + "InstanceId" + ], + "members":{ + "Name":{"shape":"DocumentName"}, + "InstanceId":{"shape":"InstanceId"}, + "Parameters":{"shape":"Parameters"} + } + }, + "CreateAssociationResult":{ + "type":"structure", + "members":{ + "AssociationDescription":{"shape":"AssociationDescription"} + } + }, + "CreateDocumentRequest":{ + "type":"structure", + "required":[ + "Content", + "Name" + ], + "members":{ + "Content":{"shape":"DocumentContent"}, + "Name":{"shape":"DocumentName"} + } + }, + "CreateDocumentResult":{ + "type":"structure", + "members":{ + "DocumentDescription":{"shape":"DocumentDescription"} + } + }, + "CreatedDate":{"type":"timestamp"}, + "DateTime":{"type":"timestamp"}, + "DefaultInstanceName":{ + "type":"string", + "max":256, + "min":0, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "DeleteActivationRequest":{ + "type":"structure", + "required":["ActivationId"], + "members":{ + "ActivationId":{"shape":"ActivationId"} + } + }, + "DeleteActivationResult":{ + "type":"structure", + "members":{ + } + }, + "DeleteAssociationRequest":{ + "type":"structure", + "required":[ + "Name", + "InstanceId" + ], + "members":{ + "Name":{"shape":"DocumentName"}, + "InstanceId":{"shape":"InstanceId"} + } + }, + "DeleteAssociationResult":{ + "type":"structure", + "members":{ + } + }, + "DeleteDocumentRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{"shape":"DocumentName"} + } + }, + "DeleteDocumentResult":{ + "type":"structure", + "members":{ + } + }, + "DeregisterManagedInstanceRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "InstanceId":{"shape":"ManagedInstanceId"} + } + }, + "DeregisterManagedInstanceResult":{ + "type":"structure", + "members":{ + } + }, + "DescribeActivationsFilter":{ + "type":"structure", + "members":{ + "FilterKey":{"shape":"DescribeActivationsFilterKeys"}, + "FilterValues":{"shape":"StringList"} + } + }, + "DescribeActivationsFilterKeys":{ + "type":"string", + "enum":[ + "ActivationIds", + "DefaultInstanceName", + "IamRole" + ] + }, + "DescribeActivationsFilterList":{ + "type":"list", + "member":{"shape":"DescribeActivationsFilter"} + }, + "DescribeActivationsRequest":{ + "type":"structure", + "members":{ + "Filters":{"shape":"DescribeActivationsFilterList"}, + "MaxResults":{ + "shape":"MaxResults", + "box":true + }, + "NextToken":{"shape":"NextToken"} + } + }, + "DescribeActivationsResult":{ + "type":"structure", + "members":{ + "ActivationList":{"shape":"ActivationList"}, + "NextToken":{"shape":"NextToken"} + } + }, + "DescribeAssociationRequest":{ + "type":"structure", + "required":[ + "Name", + "InstanceId" + ], + "members":{ + "Name":{"shape":"DocumentName"}, + "InstanceId":{"shape":"InstanceId"} + } + }, + "DescribeAssociationResult":{ + "type":"structure", + "members":{ + "AssociationDescription":{"shape":"AssociationDescription"} + } + }, + "DescribeDocumentPermissionRequest":{ + "type":"structure", + "required":[ + "Name", + "PermissionType" + ], + "members":{ + "Name":{"shape":"DocumentName"}, + "PermissionType":{"shape":"DocumentPermissionType"} + } + }, + "DescribeDocumentPermissionResponse":{ + "type":"structure", + "members":{ + "AccountIds":{"shape":"AccountIdList"} + } + }, + "DescribeDocumentRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{"shape":"DocumentARN"} + } + }, + "DescribeDocumentResult":{ + "type":"structure", + "members":{ + "Document":{"shape":"DocumentDescription"} + } + }, + "DescribeInstanceInformationRequest":{ + "type":"structure", + "members":{ + "InstanceInformationFilterList":{"shape":"InstanceInformationFilterList"}, + "MaxResults":{ + "shape":"MaxResultsEC2Compatible", + "box":true + }, + "NextToken":{"shape":"NextToken"} + } + }, + "DescribeInstanceInformationResult":{ + "type":"structure", + "members":{ + "InstanceInformationList":{"shape":"InstanceInformationList"}, + "NextToken":{"shape":"NextToken"} + } + }, + "DescriptionInDocument":{"type":"string"}, + "DocumentARN":{ + "type":"string", + "pattern":"^[a-zA-Z0-9_\\-.:/]{3,128}$" + }, + "DocumentAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "exception":true + }, + "DocumentContent":{ + "type":"string", + "min":1 + }, + "DocumentDescription":{ + "type":"structure", + "members":{ + "Sha1":{"shape":"DocumentSha1"}, + "Hash":{"shape":"DocumentHash"}, + "HashType":{"shape":"DocumentHashType"}, + "Name":{"shape":"DocumentARN"}, + "Owner":{"shape":"DocumentOwner"}, + "CreatedDate":{"shape":"DateTime"}, + "Status":{"shape":"DocumentStatus"}, + "Description":{"shape":"DescriptionInDocument"}, + "Parameters":{"shape":"DocumentParameterList"}, + "PlatformTypes":{"shape":"PlatformTypeList"} + } + }, + "DocumentFilter":{ + "type":"structure", + "required":[ + "key", + "value" + ], + "members":{ + "key":{"shape":"DocumentFilterKey"}, + "value":{"shape":"DocumentFilterValue"} + } + }, + "DocumentFilterKey":{ + "type":"string", + "enum":[ + "Name", + "Owner", + "PlatformTypes" + ] + }, + "DocumentFilterList":{ + "type":"list", + "member":{ + "shape":"DocumentFilter", + "locationName":"DocumentFilter" + }, + "min":1 + }, + "DocumentFilterValue":{ + "type":"string", + "min":1 + }, + "DocumentHash":{ + "type":"string", + "max":256 + }, + "DocumentHashType":{ + "type":"string", + "enum":[ + "Sha256", + "Sha1" + ] + }, + "DocumentIdentifier":{ + "type":"structure", + "members":{ + "Name":{"shape":"DocumentARN"}, + "Owner":{"shape":"DocumentOwner"}, + "PlatformTypes":{"shape":"PlatformTypeList"} + } + }, + "DocumentIdentifierList":{ + "type":"list", + "member":{ + "shape":"DocumentIdentifier", + "locationName":"DocumentIdentifier" + } + }, + "DocumentLimitExceeded":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "exception":true + }, + "DocumentName":{ + "type":"string", + "pattern":"^[a-zA-Z0-9_\\-.]{3,128}$" + }, + "DocumentOwner":{"type":"string"}, + "DocumentParameter":{ + "type":"structure", + "members":{ + "Name":{"shape":"DocumentParameterName"}, + "Type":{"shape":"DocumentParameterType"}, + "Description":{"shape":"DocumentParameterDescrption"}, + "DefaultValue":{"shape":"DocumentParameterDefaultValue"} + } + }, + "DocumentParameterDefaultValue":{"type":"string"}, + "DocumentParameterDescrption":{"type":"string"}, + "DocumentParameterList":{ + "type":"list", + "member":{ + "shape":"DocumentParameter", + "locationName":"DocumentParameter" + } + }, + "DocumentParameterName":{"type":"string"}, + "DocumentParameterType":{ + "type":"string", + "enum":[ + "String", + "StringList" + ] + }, + "DocumentPermissionLimit":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "exception":true + }, + "DocumentPermissionType":{ + "type":"string", + "enum":["Share"] + }, + "DocumentSha1":{"type":"string"}, + "DocumentStatus":{ + "type":"string", + "enum":[ + "Creating", + "Active", + "Deleting" + ] + }, + "DuplicateInstanceId":{ + "type":"structure", + "members":{ + }, + "exception":true + }, + "ExpirationDate":{"type":"timestamp"}, + "FailedCreateAssociation":{ + "type":"structure", + "members":{ + "Entry":{"shape":"CreateAssociationBatchRequestEntry"}, + "Message":{"shape":"BatchErrorMessage"}, + "Fault":{"shape":"Fault"} + } + }, + "FailedCreateAssociationList":{ + "type":"list", + "member":{ + "shape":"FailedCreateAssociation", + "locationName":"FailedCreateAssociationEntry" + } + }, + "Fault":{ + "type":"string", + "enum":[ + "Client", + "Server", + "Unknown" + ] + }, + "GetDocumentRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{"shape":"DocumentARN"} + } + }, + "GetDocumentResult":{ + "type":"structure", + "members":{ + "Name":{"shape":"DocumentARN"}, + "Content":{"shape":"DocumentContent"} + } + }, + "IPAddress":{ + "type":"string", + "max":46, + "min":1 + }, + "IamRole":{ + "type":"string", + "max":64 + }, + "InstanceId":{ + "type":"string", + "pattern":"(^i-(\\w{8}|\\w{17})$)|(^mi-\\w{17}$)" + }, + "InstanceIdList":{ + "type":"list", + "member":{"shape":"InstanceId"}, + "max":50, + "min":1 + }, + "InstanceInformation":{ + "type":"structure", + "members":{ + "InstanceId":{"shape":"InstanceId"}, + "PingStatus":{"shape":"PingStatus"}, + "LastPingDateTime":{ + "shape":"DateTime", + "box":true + }, + "AgentVersion":{"shape":"Version"}, + "IsLatestVersion":{ + "shape":"Boolean", + "box":true + }, + "PlatformType":{"shape":"PlatformType"}, + "PlatformName":{"shape":"String"}, + "PlatformVersion":{"shape":"String"}, + "ActivationId":{"shape":"ActivationId"}, + "IamRole":{"shape":"IamRole"}, + "RegistrationDate":{ + "shape":"DateTime", + "box":true + }, + "ResourceType":{"shape":"ResourceType"}, + "Name":{"shape":"String"}, + "IPAddress":{"shape":"IPAddress"}, + "ComputerName":{"shape":"ComputerName"} + } + }, + "InstanceInformationFilter":{ + "type":"structure", + "required":[ + "key", + "valueSet" + ], + "members":{ + "key":{"shape":"InstanceInformationFilterKey"}, + "valueSet":{"shape":"InstanceInformationFilterValueSet"} + } + }, + "InstanceInformationFilterKey":{ + "type":"string", + "enum":[ + "InstanceIds", + "AgentVersion", + "PingStatus", + "PlatformTypes", + "ActivationIds", + "IamRole", + "ResourceType" + ] + }, + "InstanceInformationFilterList":{ + "type":"list", + "member":{ + "shape":"InstanceInformationFilter", + "locationName":"InstanceInformationFilter" + }, + "min":1 + }, + "InstanceInformationFilterValue":{ + "type":"string", + "min":1 + }, + "InstanceInformationFilterValueSet":{ + "type":"list", + "member":{ + "shape":"InstanceInformationFilterValue", + "locationName":"InstanceInformationFilterValue" + }, + "max":100, + "min":1 + }, + "InstanceInformationList":{ + "type":"list", + "member":{ + "shape":"InstanceInformation", + "locationName":"InstanceInformation" + } + }, + "InternalServerError":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "exception":true + }, + "InvalidActivation":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "exception":true + }, + "InvalidActivationId":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "exception":true + }, + "InvalidCommandId":{ + "type":"structure", + "members":{ + }, + "exception":true + }, + "InvalidDocument":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "exception":true + }, + "InvalidDocumentContent":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "exception":true + }, + "InvalidDocumentOperation":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "exception":true + }, + "InvalidFilter":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "exception":true + }, + "InvalidFilterKey":{ + "type":"structure", + "members":{ + }, + "exception":true + }, + "InvalidInstanceId":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "exception":true + }, + "InvalidInstanceInformationFilterValue":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "exception":true + }, + "InvalidNextToken":{ + "type":"structure", + "members":{ + }, + "exception":true + }, + "InvalidOutputFolder":{ + "type":"structure", + "members":{ + }, + "exception":true + }, + "InvalidParameters":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "exception":true + }, + "InvalidPermissionType":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "exception":true + }, + "InvalidResourceId":{ + "type":"structure", + "members":{ + }, + "exception":true + }, + "InvalidResourceType":{ + "type":"structure", + "members":{ + }, + "exception":true + }, + "InvocationTraceOutput":{ + "type":"string", + "max":2500 + }, + "KeyList":{ + "type":"list", + "member":{"shape":"TagKey"} + }, + "ListAssociationsRequest":{ + "type":"structure", + "required":["AssociationFilterList"], + "members":{ + "AssociationFilterList":{"shape":"AssociationFilterList"}, + "MaxResults":{ + "shape":"MaxResults", + "box":true + }, + "NextToken":{"shape":"NextToken"} + } + }, + "ListAssociationsResult":{ + "type":"structure", + "members":{ + "Associations":{"shape":"AssociationList"}, + "NextToken":{"shape":"NextToken"} + } + }, + "ListCommandInvocationsRequest":{ + "type":"structure", + "members":{ + "CommandId":{"shape":"CommandId"}, + "InstanceId":{"shape":"InstanceId"}, + "MaxResults":{ + "shape":"CommandMaxResults", + "box":true + }, + "NextToken":{"shape":"NextToken"}, + "Filters":{"shape":"CommandFilterList"}, + "Details":{"shape":"Boolean"} + } + }, + "ListCommandInvocationsResult":{ + "type":"structure", + "members":{ + "CommandInvocations":{"shape":"CommandInvocationList"}, + "NextToken":{"shape":"NextToken"} + } + }, + "ListCommandsRequest":{ + "type":"structure", + "members":{ + "CommandId":{"shape":"CommandId"}, + "InstanceId":{"shape":"InstanceId"}, + "MaxResults":{ + "shape":"CommandMaxResults", + "box":true + }, + "NextToken":{"shape":"NextToken"}, + "Filters":{"shape":"CommandFilterList"} + } + }, + "ListCommandsResult":{ + "type":"structure", + "members":{ + "Commands":{"shape":"CommandList"}, + "NextToken":{"shape":"NextToken"} + } + }, + "ListDocumentsRequest":{ + "type":"structure", + "members":{ + "DocumentFilterList":{"shape":"DocumentFilterList"}, + "MaxResults":{ + "shape":"MaxResults", + "box":true + }, + "NextToken":{"shape":"NextToken"} + } + }, + "ListDocumentsResult":{ + "type":"structure", + "members":{ + "DocumentIdentifiers":{"shape":"DocumentIdentifierList"}, + "NextToken":{"shape":"NextToken"} + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":[ + "ResourceType", + "ResourceId" + ], + "members":{ + "ResourceType":{"shape":"ResourceTypeForTagging"}, + "ResourceId":{"shape":"ResourceId"} + } + }, + "ListTagsForResourceResult":{ + "type":"structure", + "members":{ + "TagList":{"shape":"TagList"} + } + }, + "ManagedInstanceId":{ + "type":"string", + "pattern":"^mi-[0-9a-f]{17}$" + }, + "MaxDocumentSizeExceeded":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "exception":true + }, + "MaxResults":{ + "type":"integer", + "max":50, + "min":1 + }, + "MaxResultsEC2Compatible":{ + "type":"integer", + "max":50, + "min":5 + }, + "ModifyDocumentPermissionRequest":{ + "type":"structure", + "required":[ + "Name", + "PermissionType" + ], + "members":{ + "Name":{"shape":"DocumentName"}, + "PermissionType":{"shape":"DocumentPermissionType"}, + "AccountIdsToAdd":{"shape":"AccountIdList"}, + "AccountIdsToRemove":{"shape":"AccountIdList"} + } + }, + "ModifyDocumentPermissionResponse":{ + "type":"structure", + "members":{ + } + }, + "NextToken":{"type":"string"}, + "ParameterName":{"type":"string"}, + "ParameterValue":{"type":"string"}, + "ParameterValueList":{ + "type":"list", + "member":{"shape":"ParameterValue"} + }, + "Parameters":{ + "type":"map", + "key":{"shape":"ParameterName"}, + "value":{"shape":"ParameterValueList"} + }, + "PingStatus":{ + "type":"string", + "enum":[ + "Online", + "ConnectionLost", + "Inactive" + ] + }, + "PlatformType":{ + "type":"string", + "enum":[ + "Windows", + "Linux" + ] + }, + "PlatformTypeList":{ + "type":"list", + "member":{ + "shape":"PlatformType", + "locationName":"PlatformType" + } + }, + "RegistrationLimit":{ + "type":"integer", + "max":1000, + "min":1 + }, + "RegistrationsCount":{ + "type":"integer", + "max":1000, + "min":1 + }, + "RemoveTagsFromResourceRequest":{ + "type":"structure", + "required":[ + "ResourceType", + "ResourceId", + "TagKeys" + ], + "members":{ + "ResourceType":{"shape":"ResourceTypeForTagging"}, + "ResourceId":{"shape":"ResourceId"}, + "TagKeys":{"shape":"KeyList"} + } + }, + "RemoveTagsFromResourceResult":{ + "type":"structure", + "members":{ + } + }, + "ResourceId":{ + "type":"string", + "pattern":"^mi-[0-9a-f]{17}$" + }, + "ResourceType":{ + "type":"string", + "enum":[ + "ManagedInstance", + "Document", + "EC2Instance" + ] + }, + "ResourceTypeForTagging":{ + "type":"string", + "enum":["ManagedInstance"] + }, + "ResponseCode":{"type":"integer"}, + "S3BucketName":{ + "type":"string", + "max":63, + "min":3 + }, + "S3KeyPrefix":{ + "type":"string", + "max":500 + }, + "SendCommandRequest":{ + "type":"structure", + "required":[ + "InstanceIds", + "DocumentName" + ], + "members":{ + "InstanceIds":{"shape":"InstanceIdList"}, + "DocumentName":{"shape":"DocumentARN"}, + "DocumentHash":{"shape":"DocumentHash"}, + "DocumentHashType":{"shape":"DocumentHashType"}, + "TimeoutSeconds":{ + "shape":"TimeoutSeconds", + "box":true + }, + "Comment":{"shape":"Comment"}, + "Parameters":{"shape":"Parameters"}, + "OutputS3BucketName":{"shape":"S3BucketName"}, + "OutputS3KeyPrefix":{"shape":"S3KeyPrefix"} + } + }, + "SendCommandResult":{ + "type":"structure", + "members":{ + "Command":{"shape":"Command"} + } + }, + "StatusAdditionalInfo":{ + "type":"string", + "max":1024 + }, + "StatusMessage":{ + "type":"string", + "max":1024 + }, + "StatusUnchanged":{ + "type":"structure", + "members":{ + }, + "exception":true + }, + "String":{"type":"string"}, + "StringList":{ + "type":"list", + "member":{"shape":"String"} + }, + "Tag":{ + "type":"structure", + "required":[ + "Key", + "Value" + ], + "members":{ + "Key":{"shape":"TagKey"}, + "Value":{"shape":"TagValue"} + } + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^(?!^(?i)aws:)(?=^[\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*$).*$" + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"} + }, + "TagValue":{ + "type":"string", + "max":256, + "min":1, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "TimeoutSeconds":{ + "type":"integer", + "max":2592000, + "min":30 + }, + "TooManyUpdates":{ + "type":"structure", + "members":{ + }, + "exception":true + }, + "UnsupportedPlatformType":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "exception":true + }, + "UpdateAssociationStatusRequest":{ + "type":"structure", + "required":[ + "Name", + "InstanceId", + "AssociationStatus" + ], + "members":{ + "Name":{"shape":"DocumentName"}, + "InstanceId":{"shape":"InstanceId"}, + "AssociationStatus":{"shape":"AssociationStatus"} + } + }, + "UpdateAssociationStatusResult":{ + "type":"structure", + "members":{ + "AssociationDescription":{"shape":"AssociationDescription"} + } + }, + "UpdateManagedInstanceRoleRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "IamRole" + ], + "members":{ + "InstanceId":{"shape":"ManagedInstanceId"}, + "IamRole":{"shape":"IamRole"} + } + }, + "UpdateManagedInstanceRoleResult":{ + "type":"structure", + "members":{ + } + }, + "Version":{ + "type":"string", + "pattern":"^[0-9]{1,6}(\\.[0-9]{1,6}){2,3}$" + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/ssm/2014-11-06/docs-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/ssm/2014-11-06/docs-2.json new file mode 100644 index 000000000..64d7b0e2c --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/ssm/2014-11-06/docs-2.json @@ -0,0 +1,1251 @@ +{ + "version": "2.0", + "service": "This is the Amazon Simple Systems Manager (SSM) API Reference. SSM enables you to remotely manage the configuration of your on-premises servers and virtual machines (VMs) and your Amazon EC2 instances using scripts, commands, or the Amazon EC2 console. SSM includes an on-demand solution called Amazon EC2 Run Command and a lightweight instance configuration solution called SSM Config.
This references is intended to be used with the EC2 Run Command User Guide for Linux or Windows.
You must register your on-premises servers and VMs through an activation process before you can configure them using Run Command. Registered servers and VMs are called managed instances. For more information, see Setting Up Run Command On Managed Instances (On-Premises Servers and VMs) on Linux or Setting Up Run Command On Managed Instances (On-Premises Servers and VMs) on Windows.
Run Command
Run Command provides an on-demand experience for executing commands. You can use pre-defined SSM documents to perform the actions listed later in this section, or you can create your own documents. With these documents, you can remotely configure your instances by sending commands using the Commands page in the Amazon EC2 console, AWS Tools for Windows PowerShell, the AWS CLI, or AWS SDKs.
Run Command reports the status of the command execution for each instance targeted by a command. You can also audit the command execution to understand who executed commands, when, and what changes were made. By switching between different SSM documents, you can quickly configure your instances with different types of commands. To get started with Run Command, verify that your environment meets the prerequisites for remotely running commands on EC2 instances (Linux or Windows).
SSM Config
SSM Config is a lightweight instance configuration solution. SSM Config is currently only available for Windows instances. With SSM Config, you can specify a setup configuration for your instances. SSM Config is similar to EC2 User Data, which is another way of running one-time scripts or applying settings during instance launch. SSM Config is an extension of this capability. Using SSM documents, you can specify which actions the system should perform on your instances, including which applications to install, which AWS Directory Service directory to join, which Microsoft PowerShell modules to install, etc. If an instance is missing one or more of these configurations, the system makes those changes. By default, the system checks every five minutes to see if there is a new configuration to apply as defined in a new SSM document. If so, the system updates the instances accordingly. In this way, you can remotely maintain a consistent configuration baseline on your instances. SSM Config is available using the AWS CLI or the AWS Tools for Windows PowerShell. For more information, see Managing Windows Instance Configuration.
SSM Config and Run Command include the following pre-defined documents.
Linux
AWS-RunShellScript to run shell scripts
AWS-UpdateSSMAgent to update the Amazon SSM agent
Windows
AWS-JoinDirectoryServiceDomain to join an AWS Directory
AWS-RunPowerShellScript to run PowerShell commands or scripts
AWS-UpdateEC2Config to update the EC2Config service
AWS-ConfigureWindowsUpdate to configure Windows Update settings
AWS-InstallApplication to install, repair, or uninstall software using an MSI package
AWS-InstallPowerShellModule to install PowerShell modules
AWS-ConfigureCloudWatch to configure Amazon CloudWatch Logs to monitor applications and systems
AWS-ListWindowsInventory to collect information about an EC2 instance running in Windows.
AWS-FindWindowsUpdates to scan an instance and determines which updates are missing.
AWS-InstallMissingWindowsUpdates to install missing updates on your EC2 instance.
AWS-InstallSpecificWindowsUpdates to install one or more specific updates.
The commands or scripts specified in SSM documents run with administrative privilege on your instances because the Amazon SSM agent runs as root on Linux and the EC2Config service runs in the Local System account on Windows. If a user has permission to execute any of the pre-defined SSM documents (any document that begins with AWS-*) then that user also has administrator access to the instance. Delegate access to Run Command and SSM Config judiciously. This becomes extremely important if you create your own SSM documents. Amazon Web Services does not provide guidance about how to create secure SSM documents. You create SSM documents and delegate access to Run Command at your own risk. As a security best practice, we recommend that you assign access to \"AWS-*\" documents, especially the AWS-RunShellScript document on Linux and the AWS-RunPowerShellScript document on Windows, to trusted administrators only. You can create SSM documents for specific tasks and delegate access to non-administrators.
For information about creating and sharing SSM documents, see the following topics in the SSM User Guide:
Creating SSM Documents and Sharing SSM Documents (Linux)
Creating SSM Documents and Sharing SSM Documents (Windows)
Adds or overwrites one or more tags for the specified resource. Tags are metadata that you assign to your managed instances. Tags enable you to categorize your managed instances in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define. For example, you could define a set of tags for your account's managed instances that helps you track each instance's owner and stack level. For example: Key=Owner and Value=DbAdmin, SysAdmin, or Dev. Or Key=Stack and Value=Production, Pre-Production, or Test. Each resource can have a maximum of 10 tags.
We recommend that you devise a set of tag keys that meets your needs for each resource type. Using a consistent set of tag keys makes it easier for you to manage your resources. You can search and filter the resources based on the tags you add. Tags don't have any semantic meaning to Amazon EC2 and are interpreted strictly as a string of characters.
For more information about tags, see Tagging Your Amazon EC2 Resources in the Amazon EC2 User Guide.
", + "CancelCommand": "Attempts to cancel the command specified by the Command ID. There is no guarantee that the command will be terminated and the underlying process stopped.
", + "CreateActivation": "Registers your on-premises server or virtual machine with Amazon EC2 so that you can manage these resources using Run Command. An on-premises server or virtual machine that has been registered with EC2 is called a managed instance. For more information about activations, see Setting Up Managed Instances (Linux) or Setting Up Managed Instances (Windows) in the Amazon EC2 User Guide.
", + "CreateAssociation": "Associates the specified SSM document with the specified instance.
When you associate an SSM document with an instance, the configuration agent on the instance processes the document and configures the instance as specified.
If you associate a document with an instance that already has an associated document, the system throws the AssociationAlreadyExists exception.
", + "CreateAssociationBatch": "Associates the specified SSM document with the specified instances.
When you associate an SSM document with an instance, the configuration agent on the instance processes the document and configures the instance as specified.
If you associate a document with an instance that already has an associated document, the system throws the AssociationAlreadyExists exception.
", + "CreateDocument": "Creates an SSM document.
After you create an SSM document, you can use CreateAssociation to associate it with one or more running instances.
", + "DeleteActivation": "Deletes an activation. You are not required to delete an activation. If you delete an activation, you can no longer use it to register additional managed instances. Deleting an activation does not de-register managed instances. You must manually de-register managed instances.
", + "DeleteAssociation": "Disassociates the specified SSM document from the specified instance.
When you disassociate an SSM document from an instance, it does not change the configuration of the instance. To change the configuration state of an instance after you disassociate a document, you must create a new document with the desired configuration and associate it with the instance.
", + "DeleteDocument": "Deletes the SSM document and all instance associations to the document.
Before you delete the SSM document, we recommend that you use DeleteAssociation to disassociate all instances that are associated with the document.
", + "DeregisterManagedInstance": "Removes the server or virtual machine from the list of registered servers. You can reregister the instance again at any time. If you don’t plan to use Run Command on the server, we suggest uninstalling the SSM agent first.
", + "DescribeActivations": "Details about the activation, including: the date and time the activation was created, the expiration date, the IAM role assigned to the instances in the activation, and the number of instances activated by this registration.
", + "DescribeAssociation": "Describes the associations for the specified SSM document or instance.
", + "DescribeDocument": "Describes the specified SSM document.
", + "DescribeDocumentPermission": "Describes the permissions for an SSM document. If you created the document, you are the owner. If a document is shared, it can either be shared privately (by specifying a user’s AWS account ID) or publicly (All).
", + "DescribeInstanceInformation": "Describes one or more of your instances. You can use this to get information about instances like the operating system platform, the SSM agent version, status etc. If you specify one or more instance IDs, it returns information for those instances. If you do not specify instance IDs, it returns information for all your instances. If you specify an instance ID that is not valid or an instance that you do not own, you receive an error.
", + "GetDocument": "Gets the contents of the specified SSM document.
", + "ListAssociations": "Lists the associations for the specified SSM document or instance.
", + "ListCommandInvocations": "An invocation is copy of a command sent to a specific instance. A command can apply to one or more instances. A command invocation applies to one instance. For example, if a user executes SendCommand against three instances, then a command invocation is created for each requested instance ID. ListCommandInvocations provide status about command execution.
", + "ListCommands": "Lists the commands requested by users of the AWS account.
", + "ListDocuments": "Describes one or more of your SSM documents.
", + "ListTagsForResource": "Returns a list of the tags assigned to the specified resource.
", + "ModifyDocumentPermission": "Share a document publicly or privately. If you share a document privately, you must specify the AWS user account IDs for those people who can use the document. If you share a document publicly, you must specify All as the account ID.
", + "RemoveTagsFromResource": "Removes all tags from the specified resource.
", + "SendCommand": "Executes commands on one or more remote instances.
", + "UpdateAssociationStatus": "Updates the status of the SSM document associated with the specified instance.
", + "UpdateManagedInstanceRole": "Assigns or changes an Amazon Identity and Access Management (IAM) role to the managed instance.
" + }, + "shapes": { + "AccountId": { + "base": null, + "refs": { + "AccountIdList$member": null + } + }, + "AccountIdList": { + "base": null, + "refs": { + "DescribeDocumentPermissionResponse$AccountIds": "The account IDs that have permission to use this document. The ID can be either an AWS account or All.
", + "ModifyDocumentPermissionRequest$AccountIdsToAdd": "The AWS user accounts that should have access to the document. The account IDs can either be a group of account IDs or All.
", + "ModifyDocumentPermissionRequest$AccountIdsToRemove": "The AWS user accounts that should no longer have access to the document. The AWS user account can either be a group of account IDs or All. This action has a higher priority than AccountIdsToAdd. If you specify an account ID to add and the same ID to remove, the system removes access to the document.
" + } + }, + "Activation": { + "base": "An activation registers one or more on-premises servers or virtual machines (VMs) with AWS so that you can configure those servers or VMs using Run Command. A server or VM that has been registered with AWS is called a managed instance.
", + "refs": { + "ActivationList$member": null + } + }, + "ActivationCode": { + "base": null, + "refs": { + "CreateActivationResult$ActivationCode": "The code the system generates when it processes the activation. The activation code functions like a password to validate the activation ID.
" + } + }, + "ActivationDescription": { + "base": null, + "refs": { + "Activation$Description": "A user defined description of the activation.
", + "CreateActivationRequest$Description": "A user-defined description of the resource that you want to register with Amazon EC2.
" + } + }, + "ActivationId": { + "base": null, + "refs": { + "Activation$ActivationId": "The ID created by SSM when you submitted the activation.
", + "CreateActivationResult$ActivationId": "The ID number generated by the system when it processed the activation. The activation ID functions like a user name.
", + "DeleteActivationRequest$ActivationId": "The ID of the activation that you want to delete.
", + "InstanceInformation$ActivationId": "The activation ID created by SSM when the server or VM was registered.
" + } + }, + "ActivationList": { + "base": null, + "refs": { + "DescribeActivationsResult$ActivationList": "A list of activations for your AWS account.
" + } + }, + "AddTagsToResourceRequest": { + "base": null, + "refs": { + } + }, + "AddTagsToResourceResult": { + "base": null, + "refs": { + } + }, + "AssociatedInstances": { + "base": "You must disassociate an SSM document from all instances before you can delete it.
", + "refs": { + } + }, + "Association": { + "base": "Describes an association of an SSM document and an instance.
", + "refs": { + "AssociationList$member": null + } + }, + "AssociationAlreadyExists": { + "base": "The specified association already exists.
", + "refs": { + } + }, + "AssociationDescription": { + "base": "Describes the parameters for a document.
", + "refs": { + "AssociationDescriptionList$member": null, + "CreateAssociationResult$AssociationDescription": "Information about the association.
", + "DescribeAssociationResult$AssociationDescription": "Information about the association.
", + "UpdateAssociationStatusResult$AssociationDescription": "Information about the association.
" + } + }, + "AssociationDescriptionList": { + "base": null, + "refs": { + "CreateAssociationBatchResult$Successful": "Information about the associations that succeeded.
" + } + }, + "AssociationDoesNotExist": { + "base": "The specified association does not exist.
", + "refs": { + } + }, + "AssociationFilter": { + "base": "Describes a filter.
", + "refs": { + "AssociationFilterList$member": null + } + }, + "AssociationFilterKey": { + "base": null, + "refs": { + "AssociationFilter$key": "The name of the filter.
" + } + }, + "AssociationFilterList": { + "base": null, + "refs": { + "ListAssociationsRequest$AssociationFilterList": "One or more filters. Use a filter to return a more specific list of results.
" + } + }, + "AssociationFilterValue": { + "base": null, + "refs": { + "AssociationFilter$value": "The filter value.
" + } + }, + "AssociationLimitExceeded": { + "base": "You can have at most 2,000 active associations.
", + "refs": { + } + }, + "AssociationList": { + "base": null, + "refs": { + "ListAssociationsResult$Associations": "The associations.
" + } + }, + "AssociationStatus": { + "base": "Describes an association status.
", + "refs": { + "AssociationDescription$Status": "The association status.
", + "UpdateAssociationStatusRequest$AssociationStatus": "The association status.
" + } + }, + "AssociationStatusName": { + "base": null, + "refs": { + "AssociationStatus$Name": "The status.
" + } + }, + "BatchErrorMessage": { + "base": null, + "refs": { + "FailedCreateAssociation$Message": "A description of the failure.
" + } + }, + "Boolean": { + "base": null, + "refs": { + "Activation$Expired": "Whether or not the activation is expired.
", + "InstanceInformation$IsLatestVersion": "Indicates whether latest version of the SSM agent is running on your instance.
", + "ListCommandInvocationsRequest$Details": "(Optional) If set this returns the response of the command executions and any command output. By default this is set to False.
" + } + }, + "CancelCommandRequest": { + "base": "", + "refs": { + } + }, + "CancelCommandResult": { + "base": "Whether or not the command was successfully canceled. There is no guarantee that a request can be canceled.
", + "refs": { + } + }, + "Command": { + "base": "Describes a command request.
", + "refs": { + "CommandList$member": null, + "SendCommandResult$Command": "The request as it was received by SSM. Also provides the command ID which can be used future references to this request.
" + } + }, + "CommandFilter": { + "base": "Describes a command filter.
", + "refs": { + "CommandFilterList$member": null + } + }, + "CommandFilterKey": { + "base": null, + "refs": { + "CommandFilter$key": "The name of the filter. For example, requested date and time.
" + } + }, + "CommandFilterList": { + "base": null, + "refs": { + "ListCommandInvocationsRequest$Filters": "(Optional) One or more filters. Use a filter to return a more specific list of results.
", + "ListCommandsRequest$Filters": "(Optional) One or more filters. Use a filter to return a more specific list of results.
" + } + }, + "CommandFilterValue": { + "base": null, + "refs": { + "CommandFilter$value": "The filter value. For example: June 30, 2015.
" + } + }, + "CommandId": { + "base": null, + "refs": { + "CancelCommandRequest$CommandId": "The ID of the command you want to cancel.
", + "Command$CommandId": "A unique identifier for this command.
", + "CommandInvocation$CommandId": "The command against which this invocation was requested.
", + "ListCommandInvocationsRequest$CommandId": "(Optional) The invocations for a specific command ID.
", + "ListCommandsRequest$CommandId": "(Optional) If provided, lists only the specified command.
" + } + }, + "CommandInvocation": { + "base": "An invocation is copy of a command sent to a specific instance. A command can apply to one or more instances. A command invocation applies to one instance. For example, if a user executes SendCommand against three instances, then a command invocation is created for each requested instance ID. A command invocation returns status and detail information about a command you executed.
", + "refs": { + "CommandInvocationList$member": null + } + }, + "CommandInvocationList": { + "base": null, + "refs": { + "ListCommandInvocationsResult$CommandInvocations": "(Optional) A list of all invocations.
" + } + }, + "CommandInvocationStatus": { + "base": null, + "refs": { + "CommandInvocation$Status": "Whether or not the invocation succeeded, failed, or is pending.
" + } + }, + "CommandList": { + "base": null, + "refs": { + "ListCommandsResult$Commands": "(Optional) The list of commands requested by the user.
" + } + }, + "CommandMaxResults": { + "base": null, + "refs": { + "ListCommandInvocationsRequest$MaxResults": "(Optional) The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
", + "ListCommandsRequest$MaxResults": "(Optional) The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
" + } + }, + "CommandPlugin": { + "base": "Describes plugin details.
", + "refs": { + "CommandPluginList$member": null + } + }, + "CommandPluginList": { + "base": null, + "refs": { + "CommandInvocation$CommandPlugins": null + } + }, + "CommandPluginName": { + "base": null, + "refs": { + "CommandPlugin$Name": "The name of the plugin. Must be one of the following: aws:updateAgent, aws:domainjoin, aws:applications, aws:runPowerShellScript, aws:psmodule, aws:cloudWatch, aws:runShellScript, or aws:updateSSMAgent.
" + } + }, + "CommandPluginOutput": { + "base": null, + "refs": { + "CommandPlugin$Output": "Output of the plugin execution.
" + } + }, + "CommandPluginStatus": { + "base": null, + "refs": { + "CommandPlugin$Status": "The status of this plugin. You can execute a document with multiple plugins.
" + } + }, + "CommandStatus": { + "base": null, + "refs": { + "Command$Status": "The status of the command.
" + } + }, + "Comment": { + "base": null, + "refs": { + "Command$Comment": "User-specified information about the command, such as a brief description of what the command should do.
", + "CommandInvocation$Comment": "User-specified information about the command, such as a brief description of what the command should do.
", + "SendCommandRequest$Comment": "User-specified information about the command, such as a brief description of what the command should do.
" + } + }, + "ComputerName": { + "base": null, + "refs": { + "InstanceInformation$ComputerName": "The fully qualified host name of the managed instance.
" + } + }, + "CreateActivationRequest": { + "base": null, + "refs": { + } + }, + "CreateActivationResult": { + "base": null, + "refs": { + } + }, + "CreateAssociationBatchRequest": { + "base": null, + "refs": { + } + }, + "CreateAssociationBatchRequestEntries": { + "base": null, + "refs": { + "CreateAssociationBatchRequest$Entries": "One or more associations.
" + } + }, + "CreateAssociationBatchRequestEntry": { + "base": "Describes the association of an SSM document and an instance.
", + "refs": { + "CreateAssociationBatchRequestEntries$member": null, + "FailedCreateAssociation$Entry": "The association.
" + } + }, + "CreateAssociationBatchResult": { + "base": null, + "refs": { + } + }, + "CreateAssociationRequest": { + "base": null, + "refs": { + } + }, + "CreateAssociationResult": { + "base": null, + "refs": { + } + }, + "CreateDocumentRequest": { + "base": null, + "refs": { + } + }, + "CreateDocumentResult": { + "base": null, + "refs": { + } + }, + "CreatedDate": { + "base": null, + "refs": { + "Activation$CreatedDate": "The date the activation was created.
" + } + }, + "DateTime": { + "base": null, + "refs": { + "AssociationDescription$Date": "The date when the association was made.
", + "AssociationStatus$Date": "The date when the status changed.
", + "Command$ExpiresAfter": "If this time is reached and the command has not already started executing, it will not execute. Calculated based on the ExpiresAfter user input provided as part of the SendCommand API.
", + "Command$RequestedDateTime": "The date and time the command was requested.
", + "CommandInvocation$RequestedDateTime": "The time and date the request was sent to this instance.
", + "CommandPlugin$ResponseStartDateTime": "The time the plugin started executing.
", + "CommandPlugin$ResponseFinishDateTime": "The time the plugin stopped executing. Could stop prematurely if, for example, a cancel command was sent.
", + "DocumentDescription$CreatedDate": "The date when the SSM document was created.
", + "InstanceInformation$LastPingDateTime": "The date and time when agent last pinged SSM service.
", + "InstanceInformation$RegistrationDate": "The date the server or VM was registered with AWS as a managed instance.
" + } + }, + "DefaultInstanceName": { + "base": null, + "refs": { + "Activation$DefaultInstanceName": "A name for the managed instance when it is created.
", + "CreateActivationRequest$DefaultInstanceName": "The name of the registered, managed instance as it will appear in the Amazon EC2 console or when you use the AWS command line tools to list EC2 resources.
" + } + }, + "DeleteActivationRequest": { + "base": null, + "refs": { + } + }, + "DeleteActivationResult": { + "base": null, + "refs": { + } + }, + "DeleteAssociationRequest": { + "base": null, + "refs": { + } + }, + "DeleteAssociationResult": { + "base": null, + "refs": { + } + }, + "DeleteDocumentRequest": { + "base": null, + "refs": { + } + }, + "DeleteDocumentResult": { + "base": null, + "refs": { + } + }, + "DeregisterManagedInstanceRequest": { + "base": null, + "refs": { + } + }, + "DeregisterManagedInstanceResult": { + "base": null, + "refs": { + } + }, + "DescribeActivationsFilter": { + "base": "Filter for the DescribeActivation API.
", + "refs": { + "DescribeActivationsFilterList$member": null + } + }, + "DescribeActivationsFilterKeys": { + "base": null, + "refs": { + "DescribeActivationsFilter$FilterKey": "The name of the filter.
" + } + }, + "DescribeActivationsFilterList": { + "base": null, + "refs": { + "DescribeActivationsRequest$Filters": "A filter to view information about your activations.
" + } + }, + "DescribeActivationsRequest": { + "base": null, + "refs": { + } + }, + "DescribeActivationsResult": { + "base": null, + "refs": { + } + }, + "DescribeAssociationRequest": { + "base": null, + "refs": { + } + }, + "DescribeAssociationResult": { + "base": null, + "refs": { + } + }, + "DescribeDocumentPermissionRequest": { + "base": null, + "refs": { + } + }, + "DescribeDocumentPermissionResponse": { + "base": null, + "refs": { + } + }, + "DescribeDocumentRequest": { + "base": null, + "refs": { + } + }, + "DescribeDocumentResult": { + "base": null, + "refs": { + } + }, + "DescribeInstanceInformationRequest": { + "base": null, + "refs": { + } + }, + "DescribeInstanceInformationResult": { + "base": null, + "refs": { + } + }, + "DescriptionInDocument": { + "base": null, + "refs": { + "DocumentDescription$Description": "A description of the document.
" + } + }, + "DocumentARN": { + "base": null, + "refs": { + "DescribeDocumentRequest$Name": "The name of the SSM document.
", + "DocumentDescription$Name": "The name of the SSM document.
", + "DocumentIdentifier$Name": "The name of the SSM document.
", + "GetDocumentRequest$Name": "The name of the SSM document.
", + "GetDocumentResult$Name": "The name of the SSM document.
", + "SendCommandRequest$DocumentName": "Required. The name of the SSM document to execute. This can be an SSM public document or a custom document.
" + } + }, + "DocumentAlreadyExists": { + "base": "The specified SSM document already exists.
", + "refs": { + } + }, + "DocumentContent": { + "base": null, + "refs": { + "CreateDocumentRequest$Content": "A valid JSON string.
", + "GetDocumentResult$Content": "The contents of the SSM document.
" + } + }, + "DocumentDescription": { + "base": "Describes an SSM document.
", + "refs": { + "CreateDocumentResult$DocumentDescription": "Information about the SSM document.
", + "DescribeDocumentResult$Document": "Information about the SSM document.
" + } + }, + "DocumentFilter": { + "base": "Describes a filter.
", + "refs": { + "DocumentFilterList$member": null + } + }, + "DocumentFilterKey": { + "base": null, + "refs": { + "DocumentFilter$key": "The name of the filter.
" + } + }, + "DocumentFilterList": { + "base": null, + "refs": { + "ListDocumentsRequest$DocumentFilterList": "One or more filters. Use a filter to return a more specific list of results.
" + } + }, + "DocumentFilterValue": { + "base": null, + "refs": { + "DocumentFilter$value": "The value of the filter.
" + } + }, + "DocumentHash": { + "base": null, + "refs": { + "DocumentDescription$Hash": "The Sha256 or Sha1 hash created by the system when the document was created.
Sha1 hashes have been deprecated.
The Sha256 or Sha1 hash created by the system when the document was created.
Sha1 hashes have been deprecated.
Sha256 or Sha1.
Sha1 hashes have been deprecated.
Sha256 or Sha1.
Sha1 hashes have been deprecated.
Describes the name of an SSM document.
", + "refs": { + "DocumentIdentifierList$member": null + } + }, + "DocumentIdentifierList": { + "base": null, + "refs": { + "ListDocumentsResult$DocumentIdentifiers": "The names of the SSM documents.
" + } + }, + "DocumentLimitExceeded": { + "base": "You can have at most 100 active SSM documents.
", + "refs": { + } + }, + "DocumentName": { + "base": null, + "refs": { + "Association$Name": "The name of the SSM document.
", + "AssociationDescription$Name": "The name of the SSM document.
", + "Command$DocumentName": "The name of the SSM document requested for execution.
", + "CommandInvocation$DocumentName": "The document name that was requested for execution.
", + "CreateAssociationBatchRequestEntry$Name": "The name of the configuration document.
", + "CreateAssociationRequest$Name": "The name of the SSM document.
", + "CreateDocumentRequest$Name": "A name for the SSM document.
", + "DeleteAssociationRequest$Name": "The name of the SSM document.
", + "DeleteDocumentRequest$Name": "The name of the SSM document.
", + "DescribeAssociationRequest$Name": "The name of the SSM document.
", + "DescribeDocumentPermissionRequest$Name": "The name of the document for which you are the owner.
", + "ModifyDocumentPermissionRequest$Name": "The name of the document that you want to share.
", + "UpdateAssociationStatusRequest$Name": "The name of the SSM document.
" + } + }, + "DocumentOwner": { + "base": null, + "refs": { + "DocumentDescription$Owner": "The AWS user account of the person who created the document.
", + "DocumentIdentifier$Owner": "The AWS user account of the person who created the document.
" + } + }, + "DocumentParameter": { + "base": "Parameters specified in the SSM document that execute on the server when the command is run.
", + "refs": { + "DocumentParameterList$member": null + } + }, + "DocumentParameterDefaultValue": { + "base": null, + "refs": { + "DocumentParameter$DefaultValue": "If specified, the default values for the parameters. Parameters without a default value are required. Parameters with a default value are optional.
" + } + }, + "DocumentParameterDescrption": { + "base": null, + "refs": { + "DocumentParameter$Description": "A description of what the parameter does, how to use it, the default value, and whether or not the parameter is optional.
" + } + }, + "DocumentParameterList": { + "base": null, + "refs": { + "DocumentDescription$Parameters": "A description of the parameters for a document.
" + } + }, + "DocumentParameterName": { + "base": null, + "refs": { + "DocumentParameter$Name": "The name of the parameter.
" + } + }, + "DocumentParameterType": { + "base": null, + "refs": { + "DocumentParameter$Type": "The type of parameter. The type can be either “String” or “StringList”.
" + } + }, + "DocumentPermissionLimit": { + "base": "The document cannot be shared with more AWS user accounts. You can share a document with a maximum of 20 accounts. You can publicly share up to five documents. If you need to increase this limit, contact AWS Support.
", + "refs": { + } + }, + "DocumentPermissionType": { + "base": null, + "refs": { + "DescribeDocumentPermissionRequest$PermissionType": "The permission type for the document. The permission type can be Share.
", + "ModifyDocumentPermissionRequest$PermissionType": "The permission type for the document. The permission type can be Share.
" + } + }, + "DocumentSha1": { + "base": null, + "refs": { + "DocumentDescription$Sha1": "The SHA1 hash of the document, which you can use for verification purposes.
" + } + }, + "DocumentStatus": { + "base": null, + "refs": { + "DocumentDescription$Status": "The status of the SSM document.
" + } + }, + "DuplicateInstanceId": { + "base": "You cannot specify an instance ID in more than one association.
", + "refs": { + } + }, + "ExpirationDate": { + "base": null, + "refs": { + "Activation$ExpirationDate": "The date when this activation can no longer be used to register managed instances.
", + "CreateActivationRequest$ExpirationDate": "The date by which this activation request should expire. The default value is 24 hours.
" + } + }, + "FailedCreateAssociation": { + "base": "Describes a failed association.
", + "refs": { + "FailedCreateAssociationList$member": null + } + }, + "FailedCreateAssociationList": { + "base": null, + "refs": { + "CreateAssociationBatchResult$Failed": "Information about the associations that failed.
" + } + }, + "Fault": { + "base": null, + "refs": { + "FailedCreateAssociation$Fault": "The source of the failure.
" + } + }, + "GetDocumentRequest": { + "base": null, + "refs": { + } + }, + "GetDocumentResult": { + "base": null, + "refs": { + } + }, + "IPAddress": { + "base": null, + "refs": { + "InstanceInformation$IPAddress": "The IP address of the managed instance.
" + } + }, + "IamRole": { + "base": null, + "refs": { + "Activation$IamRole": "The Amazon Identity and Access Management (IAM) role to assign to the managed instance.
", + "CreateActivationRequest$IamRole": "The Amazon Identity and Access Management (IAM) role that you want to assign to the managed instance.
", + "InstanceInformation$IamRole": "The Amazon Identity and Access Management (IAM) role assigned to EC2 instances or managed instances.
", + "UpdateManagedInstanceRoleRequest$IamRole": "The IAM role you want to assign or change.
" + } + }, + "InstanceId": { + "base": null, + "refs": { + "Association$InstanceId": "The ID of the instance.
", + "AssociationDescription$InstanceId": "The ID of the instance.
", + "CommandInvocation$InstanceId": "The instance ID in which this invocation was requested.
", + "CreateAssociationBatchRequestEntry$InstanceId": "The ID of the instance.
", + "CreateAssociationRequest$InstanceId": "The instance ID.
", + "DeleteAssociationRequest$InstanceId": "The ID of the instance.
", + "DescribeAssociationRequest$InstanceId": "The instance ID.
", + "InstanceIdList$member": null, + "InstanceInformation$InstanceId": "The instance ID.
", + "ListCommandInvocationsRequest$InstanceId": "(Optional) The command execution details for a specific instance ID.
", + "ListCommandsRequest$InstanceId": "(Optional) Lists commands issued against this instance ID.
", + "UpdateAssociationStatusRequest$InstanceId": "The ID of the instance.
" + } + }, + "InstanceIdList": { + "base": null, + "refs": { + "CancelCommandRequest$InstanceIds": "(Optional) A list of instance IDs on which you want to cancel the command. If not provided, the command is canceled on every instance on which it was requested.
", + "Command$InstanceIds": "The instance IDs against which this command was requested.
", + "SendCommandRequest$InstanceIds": "Required. The instance IDs where the command should execute. You can specify a maximum of 50 IDs.
" + } + }, + "InstanceInformation": { + "base": "Describes a filter for a specific list of instances.
", + "refs": { + "InstanceInformationList$member": null + } + }, + "InstanceInformationFilter": { + "base": "Describes a filter for a specific list of instances.
", + "refs": { + "InstanceInformationFilterList$member": null + } + }, + "InstanceInformationFilterKey": { + "base": null, + "refs": { + "InstanceInformationFilter$key": "The name of the filter.
" + } + }, + "InstanceInformationFilterList": { + "base": null, + "refs": { + "DescribeInstanceInformationRequest$InstanceInformationFilterList": "One or more filters. Use a filter to return a more specific list of instances.
" + } + }, + "InstanceInformationFilterValue": { + "base": null, + "refs": { + "InstanceInformationFilterValueSet$member": null + } + }, + "InstanceInformationFilterValueSet": { + "base": null, + "refs": { + "InstanceInformationFilter$valueSet": "The filter values.
" + } + }, + "InstanceInformationList": { + "base": null, + "refs": { + "DescribeInstanceInformationResult$InstanceInformationList": "The instance information list.
" + } + }, + "InternalServerError": { + "base": "An error occurred on the server side.
", + "refs": { + } + }, + "InvalidActivation": { + "base": "The activation is not valid. The activation might have been deleted, or the ActivationId and the ActivationCode do not match.
", + "refs": { + } + }, + "InvalidActivationId": { + "base": "The activation ID is not valid. Verify the you entered the correct ActivationId or ActivationCode and try again.
", + "refs": { + } + }, + "InvalidCommandId": { + "base": null, + "refs": { + } + }, + "InvalidDocument": { + "base": "The specified document does not exist.
", + "refs": { + } + }, + "InvalidDocumentContent": { + "base": "The content for the SSM document is not valid.
", + "refs": { + } + }, + "InvalidDocumentOperation": { + "base": "You attempted to delete a document while it is still shared. You must stop sharing the document before you can delete it.
", + "refs": { + } + }, + "InvalidFilter": { + "base": "The filter name is not valid. Verify the you entered the correct name and try again.
", + "refs": { + } + }, + "InvalidFilterKey": { + "base": "The specified key is not valid.
", + "refs": { + } + }, + "InvalidInstanceId": { + "base": "The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
", + "refs": { + } + }, + "InvalidInstanceInformationFilterValue": { + "base": "The specified filter value is not valid.
", + "refs": { + } + }, + "InvalidNextToken": { + "base": "The specified token is not valid.
", + "refs": { + } + }, + "InvalidOutputFolder": { + "base": "The S3 bucket does not exist.
", + "refs": { + } + }, + "InvalidParameters": { + "base": "You must specify values for all required parameters in the SSM document. You can only supply values to parameters defined in the SSM document.
", + "refs": { + } + }, + "InvalidPermissionType": { + "base": "The permission type is not supported. Share is the only supported permission type.
", + "refs": { + } + }, + "InvalidResourceId": { + "base": "The resource ID is not valid. Verify that you entered the correct ID and try again.
", + "refs": { + } + }, + "InvalidResourceType": { + "base": "The resource type is not valid. If you are attempting to tag an instance, the instance must be a registered, managed instance.
", + "refs": { + } + }, + "InvocationTraceOutput": { + "base": null, + "refs": { + "CommandInvocation$TraceOutput": "Gets the trace output sent by the agent.
" + } + }, + "KeyList": { + "base": null, + "refs": { + "RemoveTagsFromResourceRequest$TagKeys": "Tag keys that you want to remove from the specified resource.
" + } + }, + "ListAssociationsRequest": { + "base": null, + "refs": { + } + }, + "ListAssociationsResult": { + "base": null, + "refs": { + } + }, + "ListCommandInvocationsRequest": { + "base": null, + "refs": { + } + }, + "ListCommandInvocationsResult": { + "base": null, + "refs": { + } + }, + "ListCommandsRequest": { + "base": null, + "refs": { + } + }, + "ListCommandsResult": { + "base": null, + "refs": { + } + }, + "ListDocumentsRequest": { + "base": null, + "refs": { + } + }, + "ListDocumentsResult": { + "base": null, + "refs": { + } + }, + "ListTagsForResourceRequest": { + "base": null, + "refs": { + } + }, + "ListTagsForResourceResult": { + "base": null, + "refs": { + } + }, + "ManagedInstanceId": { + "base": null, + "refs": { + "DeregisterManagedInstanceRequest$InstanceId": "The ID assigned to the managed instance when you registered it using the activation process.
", + "UpdateManagedInstanceRoleRequest$InstanceId": "The ID of the managed instance where you want to update the role.
" + } + }, + "MaxDocumentSizeExceeded": { + "base": "The size limit of an SSM document is 64 KB.
", + "refs": { + } + }, + "MaxResults": { + "base": null, + "refs": { + "DescribeActivationsRequest$MaxResults": "The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
", + "ListAssociationsRequest$MaxResults": "The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
", + "ListDocumentsRequest$MaxResults": "The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
" + } + }, + "MaxResultsEC2Compatible": { + "base": null, + "refs": { + "DescribeInstanceInformationRequest$MaxResults": "The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
" + } + }, + "ModifyDocumentPermissionRequest": { + "base": null, + "refs": { + } + }, + "ModifyDocumentPermissionResponse": { + "base": null, + "refs": { + } + }, + "NextToken": { + "base": null, + "refs": { + "DescribeActivationsRequest$NextToken": "A token to start the list. Use this token to get the next set of results.
", + "DescribeActivationsResult$NextToken": "The token for the next set of items to return. Use this token to get the next set of results.
", + "DescribeInstanceInformationRequest$NextToken": "The token for the next set of items to return. (You received this token from a previous call.)
", + "DescribeInstanceInformationResult$NextToken": "The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
", + "ListAssociationsRequest$NextToken": "The token for the next set of items to return. (You received this token from a previous call.)
", + "ListAssociationsResult$NextToken": "The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
", + "ListCommandInvocationsRequest$NextToken": "(Optional) The token for the next set of items to return. (You received this token from a previous call.)
", + "ListCommandInvocationsResult$NextToken": "(Optional) The token for the next set of items to return. (You received this token from a previous call.)
", + "ListCommandsRequest$NextToken": "(Optional) The token for the next set of items to return. (You received this token from a previous call.)
", + "ListCommandsResult$NextToken": "(Optional) The token for the next set of items to return. (You received this token from a previous call.)
", + "ListDocumentsRequest$NextToken": "The token for the next set of items to return. (You received this token from a previous call.)
", + "ListDocumentsResult$NextToken": "The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
" + } + }, + "ParameterName": { + "base": null, + "refs": { + "Parameters$key": null + } + }, + "ParameterValue": { + "base": null, + "refs": { + "ParameterValueList$member": null + } + }, + "ParameterValueList": { + "base": null, + "refs": { + "Parameters$value": null + } + }, + "Parameters": { + "base": null, + "refs": { + "AssociationDescription$Parameters": "A description of the parameters for a document.
", + "Command$Parameters": "The parameter values to be inserted in the SSM document when executing the command.
", + "CreateAssociationBatchRequestEntry$Parameters": "A description of the parameters for a document.
", + "CreateAssociationRequest$Parameters": "The parameters for the documents runtime configuration.
", + "SendCommandRequest$Parameters": "The required and optional parameters specified in the SSM document being executed.
" + } + }, + "PingStatus": { + "base": null, + "refs": { + "InstanceInformation$PingStatus": "Connection status of the SSM agent.
" + } + }, + "PlatformType": { + "base": null, + "refs": { + "InstanceInformation$PlatformType": "The operating system platform type.
", + "PlatformTypeList$member": null + } + }, + "PlatformTypeList": { + "base": null, + "refs": { + "DocumentDescription$PlatformTypes": "The list of OS platforms compatible with this SSM document.
", + "DocumentIdentifier$PlatformTypes": "The operating system platform.
" + } + }, + "RegistrationLimit": { + "base": null, + "refs": { + "Activation$RegistrationLimit": "The maximum number of managed instances that can be registered using this activation.
", + "CreateActivationRequest$RegistrationLimit": "Specify the maximum number of managed instances you want to register. The default value is 1 instance.
" + } + }, + "RegistrationsCount": { + "base": null, + "refs": { + "Activation$RegistrationsCount": "The number of managed instances already registered with this activation.
" + } + }, + "RemoveTagsFromResourceRequest": { + "base": null, + "refs": { + } + }, + "RemoveTagsFromResourceResult": { + "base": null, + "refs": { + } + }, + "ResourceId": { + "base": null, + "refs": { + "AddTagsToResourceRequest$ResourceId": "The resource ID you want to tag.
", + "ListTagsForResourceRequest$ResourceId": "The resource ID for which you want to see a list of tags.
", + "RemoveTagsFromResourceRequest$ResourceId": "The resource ID for which you want to remove tags.
" + } + }, + "ResourceType": { + "base": null, + "refs": { + "InstanceInformation$ResourceType": "The type of instance. Instances are either EC2 instances or managed instances.
" + } + }, + "ResourceTypeForTagging": { + "base": null, + "refs": { + "AddTagsToResourceRequest$ResourceType": "Specifies the type of resource you are tagging.
", + "ListTagsForResourceRequest$ResourceType": "Returns a list of tags for a specific resource type.
", + "RemoveTagsFromResourceRequest$ResourceType": "The type of resource of which you want to remove a tag.
" + } + }, + "ResponseCode": { + "base": null, + "refs": { + "CommandPlugin$ResponseCode": "A numeric response code generated after executing the plugin.
" + } + }, + "S3BucketName": { + "base": null, + "refs": { + "Command$OutputS3BucketName": "The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command.
", + "CommandPlugin$OutputS3BucketName": "The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command.
", + "SendCommandRequest$OutputS3BucketName": "The name of the S3 bucket where command execution responses should be stored.
" + } + }, + "S3KeyPrefix": { + "base": null, + "refs": { + "Command$OutputS3KeyPrefix": "The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command.
", + "CommandPlugin$OutputS3KeyPrefix": "The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command.
", + "SendCommandRequest$OutputS3KeyPrefix": "The directory structure within the S3 bucket where the responses should be stored.
" + } + }, + "SendCommandRequest": { + "base": null, + "refs": { + } + }, + "SendCommandResult": { + "base": null, + "refs": { + } + }, + "StatusAdditionalInfo": { + "base": null, + "refs": { + "AssociationStatus$AdditionalInfo": "A user-defined string.
" + } + }, + "StatusMessage": { + "base": null, + "refs": { + "AssociationStatus$Message": "The reason for the status.
" + } + }, + "StatusUnchanged": { + "base": "The updated status is the same as the current status.
", + "refs": { + } + }, + "String": { + "base": null, + "refs": { + "DocumentAlreadyExists$Message": null, + "DocumentLimitExceeded$Message": null, + "DocumentPermissionLimit$Message": null, + "InstanceInformation$PlatformName": "The name of the operating system platform running on your instance.
", + "InstanceInformation$PlatformVersion": "The version of the OS platform running on your instance.
", + "InstanceInformation$Name": "The name of the managed instance.
", + "InternalServerError$Message": null, + "InvalidActivation$Message": null, + "InvalidActivationId$Message": null, + "InvalidDocument$Message": "The SSM document does not exist or the document is not available to the user. This exception can be issued by CreateAssociation, CreateAssociationBatch, DeleteAssociation, DeleteDocument, DescribeAssociation, DescribeDocument, GetDocument, SendCommand, or UpdateAssociationStatus.
", + "InvalidDocumentContent$Message": "A description of the validation error.
", + "InvalidDocumentOperation$Message": null, + "InvalidFilter$Message": null, + "InvalidInstanceId$Message": null, + "InvalidInstanceInformationFilterValue$message": null, + "InvalidParameters$Message": null, + "InvalidPermissionType$Message": null, + "MaxDocumentSizeExceeded$Message": null, + "StringList$member": null, + "UnsupportedPlatformType$Message": null + } + }, + "StringList": { + "base": null, + "refs": { + "DescribeActivationsFilter$FilterValues": "The filter values.
" + } + }, + "Tag": { + "base": "Metadata that you assign to your managed instances. Tags enable you to categorize your managed instances in different ways, for example, by purpose, owner, or environment.
", + "refs": { + "TagList$member": null + } + }, + "TagKey": { + "base": null, + "refs": { + "KeyList$member": null, + "Tag$Key": "The name of the tag.
" + } + }, + "TagList": { + "base": null, + "refs": { + "AddTagsToResourceRequest$Tags": "One or more tags. The value parameter is required, but if you don't want the tag to have a value, specify the parameter with no value, and we set the value to an empty string.
", + "ListTagsForResourceResult$TagList": "A list of tags.
" + } + }, + "TagValue": { + "base": null, + "refs": { + "Tag$Value": "The value of the tag.
" + } + }, + "TimeoutSeconds": { + "base": null, + "refs": { + "SendCommandRequest$TimeoutSeconds": "If this time is reached and the command has not already started executing, it will not execute.
" + } + }, + "TooManyUpdates": { + "base": "There are concurrent updates for a resource that supports one update at a time.
", + "refs": { + } + }, + "UnsupportedPlatformType": { + "base": "The document does not support the platform type of the given instance ID(s). For example, you sent an SSM document for a Windows instance to a Linux instance.
", + "refs": { + } + }, + "UpdateAssociationStatusRequest": { + "base": null, + "refs": { + } + }, + "UpdateAssociationStatusResult": { + "base": null, + "refs": { + } + }, + "UpdateManagedInstanceRoleRequest": { + "base": null, + "refs": { + } + }, + "UpdateManagedInstanceRoleResult": { + "base": null, + "refs": { + } + }, + "Version": { + "base": null, + "refs": { + "InstanceInformation$AgentVersion": "The version of the SSM agent running on your instance.
" + } + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/ssm/2014-11-06/examples-1.json b/vendor/github.com/aws/aws-sdk-go/models/apis/ssm/2014-11-06/examples-1.json new file mode 100644 index 000000000..0ea7e3b0b --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/ssm/2014-11-06/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/ssm/2014-11-06/paginators-1.json b/vendor/github.com/aws/aws-sdk-go/models/apis/ssm/2014-11-06/paginators-1.json new file mode 100644 index 000000000..d024f65c2 --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/ssm/2014-11-06/paginators-1.json @@ -0,0 +1,34 @@ +{ + "pagination": { + "ListAssociations": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Associations" + }, + "ListCommandInvocations": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "CommandInvocations" + }, + "ListCommands": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Commands" + }, + "ListDocuments": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "DocumentIdentifiers" + }, + "DescribeActivations": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "ActivationList" + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/storagegateway/2013-06-30/api-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/storagegateway/2013-06-30/api-2.json new file mode 100644 index 000000000..f84fe73fc --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/storagegateway/2013-06-30/api-2.json @@ -0,0 +1,2275 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2013-06-30", + "endpointPrefix":"storagegateway", + "jsonVersion":"1.1", + "protocol":"json", + "serviceFullName":"AWS Storage Gateway", + "signatureVersion":"v4", + "targetPrefix":"StorageGateway_20130630" + }, + "operations":{ + "ActivateGateway":{ + "name":"ActivateGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ActivateGatewayInput"}, + "output":{"shape":"ActivateGatewayOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ] + }, + "AddCache":{ + "name":"AddCache", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddCacheInput"}, + "output":{"shape":"AddCacheOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ] + }, + "AddTagsToResource":{ + "name":"AddTagsToResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddTagsToResourceInput"}, + "output":{"shape":"AddTagsToResourceOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ] + }, + "AddUploadBuffer":{ + "name":"AddUploadBuffer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddUploadBufferInput"}, + "output":{"shape":"AddUploadBufferOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ] + }, + "AddWorkingStorage":{ + "name":"AddWorkingStorage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddWorkingStorageInput"}, + "output":{"shape":"AddWorkingStorageOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ] + }, + "CancelArchival":{ + "name":"CancelArchival", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelArchivalInput"}, + "output":{"shape":"CancelArchivalOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ] + }, + "CancelRetrieval":{ + "name":"CancelRetrieval", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelRetrievalInput"}, + "output":{"shape":"CancelRetrievalOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ] + }, + "CreateCachediSCSIVolume":{ + "name":"CreateCachediSCSIVolume", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateCachediSCSIVolumeInput"}, + "output":{"shape":"CreateCachediSCSIVolumeOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ] + }, + "CreateSnapshot":{ + "name":"CreateSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateSnapshotInput"}, + "output":{"shape":"CreateSnapshotOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ] + }, + "CreateSnapshotFromVolumeRecoveryPoint":{ + "name":"CreateSnapshotFromVolumeRecoveryPoint", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateSnapshotFromVolumeRecoveryPointInput"}, + "output":{"shape":"CreateSnapshotFromVolumeRecoveryPointOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ] + }, + "CreateStorediSCSIVolume":{ + "name":"CreateStorediSCSIVolume", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateStorediSCSIVolumeInput"}, + "output":{"shape":"CreateStorediSCSIVolumeOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ] + }, + "CreateTapeWithBarcode":{ + "name":"CreateTapeWithBarcode", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateTapeWithBarcodeInput"}, + "output":{"shape":"CreateTapeWithBarcodeOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ] + }, + "CreateTapes":{ + "name":"CreateTapes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateTapesInput"}, + "output":{"shape":"CreateTapesOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ] + }, + "DeleteBandwidthRateLimit":{ + "name":"DeleteBandwidthRateLimit", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteBandwidthRateLimitInput"}, + "output":{"shape":"DeleteBandwidthRateLimitOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ] + }, + "DeleteChapCredentials":{ + "name":"DeleteChapCredentials", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteChapCredentialsInput"}, + "output":{"shape":"DeleteChapCredentialsOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ] + }, + "DeleteGateway":{ + "name":"DeleteGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteGatewayInput"}, + "output":{"shape":"DeleteGatewayOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ] + }, + "DeleteSnapshotSchedule":{ + "name":"DeleteSnapshotSchedule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSnapshotScheduleInput"}, + "output":{"shape":"DeleteSnapshotScheduleOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ] + }, + "DeleteTape":{ + "name":"DeleteTape", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteTapeInput"}, + "output":{"shape":"DeleteTapeOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ] + }, + "DeleteTapeArchive":{ + "name":"DeleteTapeArchive", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteTapeArchiveInput"}, + "output":{"shape":"DeleteTapeArchiveOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ] + }, + "DeleteVolume":{ + "name":"DeleteVolume", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteVolumeInput"}, + "output":{"shape":"DeleteVolumeOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ] + }, + "DescribeBandwidthRateLimit":{ + "name":"DescribeBandwidthRateLimit", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeBandwidthRateLimitInput"}, + "output":{"shape":"DescribeBandwidthRateLimitOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ] + }, + "DescribeCache":{ + "name":"DescribeCache", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeCacheInput"}, + "output":{"shape":"DescribeCacheOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ] + }, + "DescribeCachediSCSIVolumes":{ + "name":"DescribeCachediSCSIVolumes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeCachediSCSIVolumesInput"}, + "output":{"shape":"DescribeCachediSCSIVolumesOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ] + }, + "DescribeChapCredentials":{ + "name":"DescribeChapCredentials", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeChapCredentialsInput"}, + "output":{"shape":"DescribeChapCredentialsOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ] + }, + "DescribeGatewayInformation":{ + "name":"DescribeGatewayInformation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeGatewayInformationInput"}, + "output":{"shape":"DescribeGatewayInformationOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ] + }, + "DescribeMaintenanceStartTime":{ + "name":"DescribeMaintenanceStartTime", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeMaintenanceStartTimeInput"}, + "output":{"shape":"DescribeMaintenanceStartTimeOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ] + }, + "DescribeSnapshotSchedule":{ + "name":"DescribeSnapshotSchedule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSnapshotScheduleInput"}, + "output":{"shape":"DescribeSnapshotScheduleOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ] + }, + "DescribeStorediSCSIVolumes":{ + "name":"DescribeStorediSCSIVolumes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeStorediSCSIVolumesInput"}, + "output":{"shape":"DescribeStorediSCSIVolumesOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ] + }, + "DescribeTapeArchives":{ + "name":"DescribeTapeArchives", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeTapeArchivesInput"}, + "output":{"shape":"DescribeTapeArchivesOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ] + }, + "DescribeTapeRecoveryPoints":{ + "name":"DescribeTapeRecoveryPoints", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeTapeRecoveryPointsInput"}, + "output":{"shape":"DescribeTapeRecoveryPointsOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ] + }, + "DescribeTapes":{ + "name":"DescribeTapes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeTapesInput"}, + "output":{"shape":"DescribeTapesOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ] + }, + "DescribeUploadBuffer":{ + "name":"DescribeUploadBuffer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeUploadBufferInput"}, + "output":{"shape":"DescribeUploadBufferOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ] + }, + "DescribeVTLDevices":{ + "name":"DescribeVTLDevices", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVTLDevicesInput"}, + "output":{"shape":"DescribeVTLDevicesOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ] + }, + "DescribeWorkingStorage":{ + "name":"DescribeWorkingStorage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeWorkingStorageInput"}, + "output":{"shape":"DescribeWorkingStorageOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ] + }, + "DisableGateway":{ + "name":"DisableGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisableGatewayInput"}, + "output":{"shape":"DisableGatewayOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ] + }, + "ListGateways":{ + "name":"ListGateways", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListGatewaysInput"}, + "output":{"shape":"ListGatewaysOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ] + }, + "ListLocalDisks":{ + "name":"ListLocalDisks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListLocalDisksInput"}, + "output":{"shape":"ListLocalDisksOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ] + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForResourceInput"}, + "output":{"shape":"ListTagsForResourceOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ] + }, + "ListTapes":{ + "name":"ListTapes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTapesInput"}, + "output":{"shape":"ListTapesOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ] + }, + "ListVolumeInitiators":{ + "name":"ListVolumeInitiators", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListVolumeInitiatorsInput"}, + "output":{"shape":"ListVolumeInitiatorsOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ] + }, + "ListVolumeRecoveryPoints":{ + "name":"ListVolumeRecoveryPoints", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListVolumeRecoveryPointsInput"}, + "output":{"shape":"ListVolumeRecoveryPointsOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ] + }, + "ListVolumes":{ + "name":"ListVolumes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListVolumesInput"}, + "output":{"shape":"ListVolumesOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ] + }, + "RemoveTagsFromResource":{ + "name":"RemoveTagsFromResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RemoveTagsFromResourceInput"}, + "output":{"shape":"RemoveTagsFromResourceOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ] + }, + "ResetCache":{ + "name":"ResetCache", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResetCacheInput"}, + "output":{"shape":"ResetCacheOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ] + }, + "RetrieveTapeArchive":{ + "name":"RetrieveTapeArchive", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RetrieveTapeArchiveInput"}, + "output":{"shape":"RetrieveTapeArchiveOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ] + }, + "RetrieveTapeRecoveryPoint":{ + "name":"RetrieveTapeRecoveryPoint", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RetrieveTapeRecoveryPointInput"}, + "output":{"shape":"RetrieveTapeRecoveryPointOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ] + }, + "SetLocalConsolePassword":{ + "name":"SetLocalConsolePassword", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SetLocalConsolePasswordInput"}, + "output":{"shape":"SetLocalConsolePasswordOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ] + }, + "ShutdownGateway":{ + "name":"ShutdownGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ShutdownGatewayInput"}, + "output":{"shape":"ShutdownGatewayOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ] + }, + "StartGateway":{ + "name":"StartGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartGatewayInput"}, + "output":{"shape":"StartGatewayOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ] + }, + "UpdateBandwidthRateLimit":{ + "name":"UpdateBandwidthRateLimit", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateBandwidthRateLimitInput"}, + "output":{"shape":"UpdateBandwidthRateLimitOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ] + }, + "UpdateChapCredentials":{ + "name":"UpdateChapCredentials", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateChapCredentialsInput"}, + "output":{"shape":"UpdateChapCredentialsOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ] + }, + "UpdateGatewayInformation":{ + "name":"UpdateGatewayInformation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateGatewayInformationInput"}, + "output":{"shape":"UpdateGatewayInformationOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ] + }, + "UpdateGatewaySoftwareNow":{ + "name":"UpdateGatewaySoftwareNow", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateGatewaySoftwareNowInput"}, + "output":{"shape":"UpdateGatewaySoftwareNowOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ] + }, + "UpdateMaintenanceStartTime":{ + "name":"UpdateMaintenanceStartTime", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateMaintenanceStartTimeInput"}, + "output":{"shape":"UpdateMaintenanceStartTimeOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ] + }, + "UpdateSnapshotSchedule":{ + "name":"UpdateSnapshotSchedule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateSnapshotScheduleInput"}, + "output":{"shape":"UpdateSnapshotScheduleOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ] + }, + "UpdateVTLDeviceType":{ + "name":"UpdateVTLDeviceType", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateVTLDeviceTypeInput"}, + "output":{"shape":"UpdateVTLDeviceTypeOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ] + } + }, + "shapes":{ + "ActivateGatewayInput":{ + "type":"structure", + "required":[ + "ActivationKey", + "GatewayName", + "GatewayTimezone", + "GatewayRegion" + ], + "members":{ + "ActivationKey":{"shape":"ActivationKey"}, + "GatewayName":{"shape":"GatewayName"}, + "GatewayTimezone":{"shape":"GatewayTimezone"}, + "GatewayRegion":{"shape":"RegionId"}, + "GatewayType":{"shape":"GatewayType"}, + "TapeDriveType":{"shape":"TapeDriveType"}, + "MediumChangerType":{"shape":"MediumChangerType"} + } + }, + "ActivateGatewayOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + } + }, + "ActivationKey":{ + "type":"string", + "max":50, + "min":1 + }, + "AddCacheInput":{ + "type":"structure", + "required":[ + "GatewayARN", + "DiskIds" + ], + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "DiskIds":{"shape":"DiskIds"} + } + }, + "AddCacheOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + } + }, + "AddTagsToResourceInput":{ + "type":"structure", + "required":[ + "ResourceARN", + "Tags" + ], + "members":{ + "ResourceARN":{"shape":"ResourceARN"}, + "Tags":{"shape":"Tags"} + } + }, + "AddTagsToResourceOutput":{ + "type":"structure", + "members":{ + "ResourceARN":{"shape":"ResourceARN"} + } + }, + "AddUploadBufferInput":{ + "type":"structure", + "required":[ + "GatewayARN", + "DiskIds" + ], + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "DiskIds":{"shape":"DiskIds"} + } + }, + "AddUploadBufferOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + } + }, + "AddWorkingStorageInput":{ + "type":"structure", + "required":[ + "GatewayARN", + "DiskIds" + ], + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "DiskIds":{"shape":"DiskIds"} + } + }, + "AddWorkingStorageOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + } + }, + "BandwidthDownloadRateLimit":{ + "type":"long", + "min":102400 + }, + "BandwidthType":{ + "type":"string", + "max":25, + "min":3 + }, + "BandwidthUploadRateLimit":{ + "type":"long", + "min":51200 + }, + "CachediSCSIVolume":{ + "type":"structure", + "members":{ + "VolumeARN":{"shape":"VolumeARN"}, + "VolumeId":{"shape":"VolumeId"}, + "VolumeType":{"shape":"VolumeType"}, + "VolumeStatus":{"shape":"VolumeStatus"}, + "VolumeSizeInBytes":{"shape":"long"}, + "VolumeProgress":{"shape":"DoubleObject"}, + "SourceSnapshotId":{"shape":"SnapshotId"}, + "VolumeiSCSIAttributes":{"shape":"VolumeiSCSIAttributes"} + } + }, + "CachediSCSIVolumes":{ + "type":"list", + "member":{"shape":"CachediSCSIVolume"} + }, + "CancelArchivalInput":{ + "type":"structure", + "required":[ + "GatewayARN", + "TapeARN" + ], + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "TapeARN":{"shape":"TapeARN"} + } + }, + "CancelArchivalOutput":{ + "type":"structure", + "members":{ + "TapeARN":{"shape":"TapeARN"} + } + }, + "CancelRetrievalInput":{ + "type":"structure", + "required":[ + "GatewayARN", + "TapeARN" + ], + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "TapeARN":{"shape":"TapeARN"} + } + }, + "CancelRetrievalOutput":{ + "type":"structure", + "members":{ + "TapeARN":{"shape":"TapeARN"} + } + }, + "ChapCredentials":{ + "type":"list", + "member":{"shape":"ChapInfo"} + }, + "ChapInfo":{ + "type":"structure", + "members":{ + "TargetARN":{"shape":"TargetARN"}, + "SecretToAuthenticateInitiator":{"shape":"ChapSecret"}, + "InitiatorName":{"shape":"IqnName"}, + "SecretToAuthenticateTarget":{"shape":"ChapSecret"} + } + }, + "ChapSecret":{ + "type":"string", + "max":100, + "min":1 + }, + "ClientToken":{ + "type":"string", + "max":100, + "min":5 + }, + "CreateCachediSCSIVolumeInput":{ + "type":"structure", + "required":[ + "GatewayARN", + "VolumeSizeInBytes", + "TargetName", + "NetworkInterfaceId", + "ClientToken" + ], + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "VolumeSizeInBytes":{"shape":"long"}, + "SnapshotId":{"shape":"SnapshotId"}, + "TargetName":{"shape":"TargetName"}, + "NetworkInterfaceId":{"shape":"NetworkInterfaceId"}, + "ClientToken":{"shape":"ClientToken"} + } + }, + "CreateCachediSCSIVolumeOutput":{ + "type":"structure", + "members":{ + "VolumeARN":{"shape":"VolumeARN"}, + "TargetARN":{"shape":"TargetARN"} + } + }, + "CreateSnapshotFromVolumeRecoveryPointInput":{ + "type":"structure", + "required":[ + "VolumeARN", + "SnapshotDescription" + ], + "members":{ + "VolumeARN":{"shape":"VolumeARN"}, + "SnapshotDescription":{"shape":"SnapshotDescription"} + } + }, + "CreateSnapshotFromVolumeRecoveryPointOutput":{ + "type":"structure", + "members":{ + "SnapshotId":{"shape":"SnapshotId"}, + "VolumeARN":{"shape":"VolumeARN"}, + "VolumeRecoveryPointTime":{"shape":"string"} + } + }, + "CreateSnapshotInput":{ + "type":"structure", + "required":[ + "VolumeARN", + "SnapshotDescription" + ], + "members":{ + "VolumeARN":{"shape":"VolumeARN"}, + "SnapshotDescription":{"shape":"SnapshotDescription"} + } + }, + "CreateSnapshotOutput":{ + "type":"structure", + "members":{ + "VolumeARN":{"shape":"VolumeARN"}, + "SnapshotId":{"shape":"SnapshotId"} + } + }, + "CreateStorediSCSIVolumeInput":{ + "type":"structure", + "required":[ + "GatewayARN", + "DiskId", + "PreserveExistingData", + "TargetName", + "NetworkInterfaceId" + ], + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "DiskId":{"shape":"DiskId"}, + "SnapshotId":{"shape":"SnapshotId"}, + "PreserveExistingData":{"shape":"boolean"}, + "TargetName":{"shape":"TargetName"}, + "NetworkInterfaceId":{"shape":"NetworkInterfaceId"} + } + }, + "CreateStorediSCSIVolumeOutput":{ + "type":"structure", + "members":{ + "VolumeARN":{"shape":"VolumeARN"}, + "VolumeSizeInBytes":{"shape":"long"}, + "TargetARN":{"shape":"TargetARN"} + } + }, + "CreateTapeWithBarcodeInput":{ + "type":"structure", + "required":[ + "GatewayARN", + "TapeSizeInBytes", + "TapeBarcode" + ], + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "TapeSizeInBytes":{"shape":"TapeSize"}, + "TapeBarcode":{"shape":"TapeBarcode"} + } + }, + "CreateTapeWithBarcodeOutput":{ + "type":"structure", + "members":{ + "TapeARN":{"shape":"TapeARN"} + } + }, + "CreateTapesInput":{ + "type":"structure", + "required":[ + "GatewayARN", + "TapeSizeInBytes", + "ClientToken", + "NumTapesToCreate", + "TapeBarcodePrefix" + ], + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "TapeSizeInBytes":{"shape":"TapeSize"}, + "ClientToken":{"shape":"ClientToken"}, + "NumTapesToCreate":{"shape":"NumTapesToCreate"}, + "TapeBarcodePrefix":{"shape":"TapeBarcodePrefix"} + } + }, + "CreateTapesOutput":{ + "type":"structure", + "members":{ + "TapeARNs":{"shape":"TapeARNs"} + } + }, + "DayOfWeek":{ + "type":"integer", + "max":6, + "min":0 + }, + "DeleteBandwidthRateLimitInput":{ + "type":"structure", + "required":[ + "GatewayARN", + "BandwidthType" + ], + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "BandwidthType":{"shape":"BandwidthType"} + } + }, + "DeleteBandwidthRateLimitOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + } + }, + "DeleteChapCredentialsInput":{ + "type":"structure", + "required":[ + "TargetARN", + "InitiatorName" + ], + "members":{ + "TargetARN":{"shape":"TargetARN"}, + "InitiatorName":{"shape":"IqnName"} + } + }, + "DeleteChapCredentialsOutput":{ + "type":"structure", + "members":{ + "TargetARN":{"shape":"TargetARN"}, + "InitiatorName":{"shape":"IqnName"} + } + }, + "DeleteGatewayInput":{ + "type":"structure", + "required":["GatewayARN"], + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + } + }, + "DeleteGatewayOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + } + }, + "DeleteSnapshotScheduleInput":{ + "type":"structure", + "required":["VolumeARN"], + "members":{ + "VolumeARN":{"shape":"VolumeARN"} + } + }, + "DeleteSnapshotScheduleOutput":{ + "type":"structure", + "members":{ + "VolumeARN":{"shape":"VolumeARN"} + } + }, + "DeleteTapeArchiveInput":{ + "type":"structure", + "required":["TapeARN"], + "members":{ + "TapeARN":{"shape":"TapeARN"} + } + }, + "DeleteTapeArchiveOutput":{ + "type":"structure", + "members":{ + "TapeARN":{"shape":"TapeARN"} + } + }, + "DeleteTapeInput":{ + "type":"structure", + "required":[ + "GatewayARN", + "TapeARN" + ], + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "TapeARN":{"shape":"TapeARN"} + } + }, + "DeleteTapeOutput":{ + "type":"structure", + "members":{ + "TapeARN":{"shape":"TapeARN"} + } + }, + "DeleteVolumeInput":{ + "type":"structure", + "required":["VolumeARN"], + "members":{ + "VolumeARN":{"shape":"VolumeARN"} + } + }, + "DeleteVolumeOutput":{ + "type":"structure", + "members":{ + "VolumeARN":{"shape":"VolumeARN"} + } + }, + "DescribeBandwidthRateLimitInput":{ + "type":"structure", + "required":["GatewayARN"], + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + } + }, + "DescribeBandwidthRateLimitOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "AverageUploadRateLimitInBitsPerSec":{"shape":"BandwidthUploadRateLimit"}, + "AverageDownloadRateLimitInBitsPerSec":{"shape":"BandwidthDownloadRateLimit"} + } + }, + "DescribeCacheInput":{ + "type":"structure", + "required":["GatewayARN"], + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + } + }, + "DescribeCacheOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "DiskIds":{"shape":"DiskIds"}, + "CacheAllocatedInBytes":{"shape":"long"}, + "CacheUsedPercentage":{"shape":"double"}, + "CacheDirtyPercentage":{"shape":"double"}, + "CacheHitPercentage":{"shape":"double"}, + "CacheMissPercentage":{"shape":"double"} + } + }, + "DescribeCachediSCSIVolumesInput":{ + "type":"structure", + "required":["VolumeARNs"], + "members":{ + "VolumeARNs":{"shape":"VolumeARNs"} + } + }, + "DescribeCachediSCSIVolumesOutput":{ + "type":"structure", + "members":{ + "CachediSCSIVolumes":{"shape":"CachediSCSIVolumes"} + } + }, + "DescribeChapCredentialsInput":{ + "type":"structure", + "required":["TargetARN"], + "members":{ + "TargetARN":{"shape":"TargetARN"} + } + }, + "DescribeChapCredentialsOutput":{ + "type":"structure", + "members":{ + "ChapCredentials":{"shape":"ChapCredentials"} + } + }, + "DescribeGatewayInformationInput":{ + "type":"structure", + "required":["GatewayARN"], + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + } + }, + "DescribeGatewayInformationOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "GatewayId":{"shape":"GatewayId"}, + "GatewayName":{"shape":"string"}, + "GatewayTimezone":{"shape":"GatewayTimezone"}, + "GatewayState":{"shape":"GatewayState"}, + "GatewayNetworkInterfaces":{"shape":"GatewayNetworkInterfaces"}, + "GatewayType":{"shape":"GatewayType"}, + "NextUpdateAvailabilityDate":{"shape":"NextUpdateAvailabilityDate"}, + "LastSoftwareUpdate":{"shape":"LastSoftwareUpdate"} + } + }, + "DescribeMaintenanceStartTimeInput":{ + "type":"structure", + "required":["GatewayARN"], + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + } + }, + "DescribeMaintenanceStartTimeOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "HourOfDay":{"shape":"HourOfDay"}, + "MinuteOfHour":{"shape":"MinuteOfHour"}, + "DayOfWeek":{"shape":"DayOfWeek"}, + "Timezone":{"shape":"GatewayTimezone"} + } + }, + "DescribeSnapshotScheduleInput":{ + "type":"structure", + "required":["VolumeARN"], + "members":{ + "VolumeARN":{"shape":"VolumeARN"} + } + }, + "DescribeSnapshotScheduleOutput":{ + "type":"structure", + "members":{ + "VolumeARN":{"shape":"VolumeARN"}, + "StartAt":{"shape":"HourOfDay"}, + "RecurrenceInHours":{"shape":"RecurrenceInHours"}, + "Description":{"shape":"Description"}, + "Timezone":{"shape":"GatewayTimezone"} + } + }, + "DescribeStorediSCSIVolumesInput":{ + "type":"structure", + "required":["VolumeARNs"], + "members":{ + "VolumeARNs":{"shape":"VolumeARNs"} + } + }, + "DescribeStorediSCSIVolumesOutput":{ + "type":"structure", + "members":{ + "StorediSCSIVolumes":{"shape":"StorediSCSIVolumes"} + } + }, + "DescribeTapeArchivesInput":{ + "type":"structure", + "members":{ + "TapeARNs":{"shape":"TapeARNs"}, + "Marker":{"shape":"Marker"}, + "Limit":{"shape":"PositiveIntObject"} + } + }, + "DescribeTapeArchivesOutput":{ + "type":"structure", + "members":{ + "TapeArchives":{"shape":"TapeArchives"}, + "Marker":{"shape":"Marker"} + } + }, + "DescribeTapeRecoveryPointsInput":{ + "type":"structure", + "required":["GatewayARN"], + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "Marker":{"shape":"Marker"}, + "Limit":{"shape":"PositiveIntObject"} + } + }, + "DescribeTapeRecoveryPointsOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "TapeRecoveryPointInfos":{"shape":"TapeRecoveryPointInfos"}, + "Marker":{"shape":"Marker"} + } + }, + "DescribeTapesInput":{ + "type":"structure", + "required":["GatewayARN"], + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "TapeARNs":{"shape":"TapeARNs"}, + "Marker":{"shape":"Marker"}, + "Limit":{"shape":"PositiveIntObject"} + } + }, + "DescribeTapesOutput":{ + "type":"structure", + "members":{ + "Tapes":{"shape":"Tapes"}, + "Marker":{"shape":"Marker"} + } + }, + "DescribeUploadBufferInput":{ + "type":"structure", + "required":["GatewayARN"], + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + } + }, + "DescribeUploadBufferOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "DiskIds":{"shape":"DiskIds"}, + "UploadBufferUsedInBytes":{"shape":"long"}, + "UploadBufferAllocatedInBytes":{"shape":"long"} + } + }, + "DescribeVTLDevicesInput":{ + "type":"structure", + "required":["GatewayARN"], + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "VTLDeviceARNs":{"shape":"VTLDeviceARNs"}, + "Marker":{"shape":"Marker"}, + "Limit":{"shape":"PositiveIntObject"} + } + }, + "DescribeVTLDevicesOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "VTLDevices":{"shape":"VTLDevices"}, + "Marker":{"shape":"Marker"} + } + }, + "DescribeWorkingStorageInput":{ + "type":"structure", + "required":["GatewayARN"], + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + } + }, + "DescribeWorkingStorageOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "DiskIds":{"shape":"DiskIds"}, + "WorkingStorageUsedInBytes":{"shape":"long"}, + "WorkingStorageAllocatedInBytes":{"shape":"long"} + } + }, + "Description":{ + "type":"string", + "max":255, + "min":1 + }, + "DeviceType":{ + "type":"string", + "max":50, + "min":2 + }, + "DeviceiSCSIAttributes":{ + "type":"structure", + "members":{ + "TargetARN":{"shape":"TargetARN"}, + "NetworkInterfaceId":{"shape":"NetworkInterfaceId"}, + "NetworkInterfacePort":{"shape":"integer"}, + "ChapEnabled":{"shape":"boolean"} + } + }, + "DisableGatewayInput":{ + "type":"structure", + "required":["GatewayARN"], + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + } + }, + "DisableGatewayOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + } + }, + "Disk":{ + "type":"structure", + "members":{ + "DiskId":{"shape":"DiskId"}, + "DiskPath":{"shape":"string"}, + "DiskNode":{"shape":"string"}, + "DiskStatus":{"shape":"string"}, + "DiskSizeInBytes":{"shape":"long"}, + "DiskAllocationType":{"shape":"DiskAllocationType"}, + "DiskAllocationResource":{"shape":"string"} + } + }, + "DiskAllocationType":{ + "type":"string", + "max":100, + "min":3 + }, + "DiskId":{ + "type":"string", + "max":300, + "min":1 + }, + "DiskIds":{ + "type":"list", + "member":{"shape":"DiskId"} + }, + "Disks":{ + "type":"list", + "member":{"shape":"Disk"} + }, + "DoubleObject":{"type":"double"}, + "ErrorCode":{ + "type":"string", + "enum":[ + "ActivationKeyExpired", + "ActivationKeyInvalid", + "ActivationKeyNotFound", + "GatewayInternalError", + "GatewayNotConnected", + "GatewayNotFound", + "GatewayProxyNetworkConnectionBusy", + "AuthenticationFailure", + "BandwidthThrottleScheduleNotFound", + "Blocked", + "CannotExportSnapshot", + "ChapCredentialNotFound", + "DiskAlreadyAllocated", + "DiskDoesNotExist", + "DiskSizeGreaterThanVolumeMaxSize", + "DiskSizeLessThanVolumeSize", + "DiskSizeNotGigAligned", + "DuplicateCertificateInfo", + "DuplicateSchedule", + "EndpointNotFound", + "IAMNotSupported", + "InitiatorInvalid", + "InitiatorNotFound", + "InternalError", + "InvalidGateway", + "InvalidEndpoint", + "InvalidParameters", + "InvalidSchedule", + "LocalStorageLimitExceeded", + "LunAlreadyAllocated ", + "LunInvalid", + "MaximumContentLengthExceeded", + "MaximumTapeCartridgeCountExceeded", + "MaximumVolumeCountExceeded", + "NetworkConfigurationChanged", + "NoDisksAvailable", + "NotImplemented", + "NotSupported", + "OperationAborted", + "OutdatedGateway", + "ParametersNotImplemented", + "RegionInvalid", + "RequestTimeout", + "ServiceUnavailable", + "SnapshotDeleted", + "SnapshotIdInvalid", + "SnapshotInProgress", + "SnapshotNotFound", + "SnapshotScheduleNotFound", + "StagingAreaFull", + "StorageFailure", + "TapeCartridgeNotFound", + "TargetAlreadyExists", + "TargetInvalid", + "TargetNotFound", + "UnauthorizedOperation", + "VolumeAlreadyExists", + "VolumeIdInvalid", + "VolumeInUse", + "VolumeNotFound", + "VolumeNotReady" + ] + }, + "GatewayARN":{ + "type":"string", + "max":500, + "min":50 + }, + "GatewayId":{ + "type":"string", + "max":30, + "min":12 + }, + "GatewayInfo":{ + "type":"structure", + "members":{ + "GatewayId":{"shape":"GatewayId"}, + "GatewayARN":{"shape":"GatewayARN"}, + "GatewayType":{"shape":"GatewayType"}, + "GatewayOperationalState":{"shape":"GatewayOperationalState"}, + "GatewayName":{"shape":"string"} + } + }, + "GatewayName":{ + "type":"string", + "max":255, + "min":2, + "pattern":"^[ -\\.0-\\[\\]-~]*[!-\\.0-\\[\\]-~][ -\\.0-\\[\\]-~]*$" + }, + "GatewayNetworkInterfaces":{ + "type":"list", + "member":{"shape":"NetworkInterface"} + }, + "GatewayOperationalState":{ + "type":"string", + "max":25, + "min":2 + }, + "GatewayState":{ + "type":"string", + "max":25, + "min":2 + }, + "GatewayTimezone":{ + "type":"string", + "max":10, + "min":3 + }, + "GatewayType":{ + "type":"string", + "max":20, + "min":2 + }, + "Gateways":{ + "type":"list", + "member":{"shape":"GatewayInfo"} + }, + "HourOfDay":{ + "type":"integer", + "max":23, + "min":0 + }, + "Initiator":{ + "type":"string", + "max":50, + "min":1 + }, + "Initiators":{ + "type":"list", + "member":{"shape":"Initiator"} + }, + "InternalServerError":{ + "type":"structure", + "members":{ + "message":{"shape":"string"}, + "error":{"shape":"StorageGatewayError"} + }, + "exception":true + }, + "InvalidGatewayRequestException":{ + "type":"structure", + "members":{ + "message":{"shape":"string"}, + "error":{"shape":"StorageGatewayError"} + }, + "exception":true + }, + "IqnName":{ + "type":"string", + "max":255, + "min":1, + "pattern":"[0-9a-z:.-]+" + }, + "LastSoftwareUpdate":{ + "type":"string", + "max":25, + "min":1 + }, + "ListGatewaysInput":{ + "type":"structure", + "members":{ + "Marker":{"shape":"Marker"}, + "Limit":{"shape":"PositiveIntObject"} + } + }, + "ListGatewaysOutput":{ + "type":"structure", + "members":{ + "Gateways":{"shape":"Gateways"}, + "Marker":{"shape":"Marker"} + } + }, + "ListLocalDisksInput":{ + "type":"structure", + "required":["GatewayARN"], + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + } + }, + "ListLocalDisksOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "Disks":{"shape":"Disks"} + } + }, + "ListTagsForResourceInput":{ + "type":"structure", + "required":["ResourceARN"], + "members":{ + "ResourceARN":{"shape":"ResourceARN"}, + "Marker":{"shape":"Marker"}, + "Limit":{"shape":"PositiveIntObject"} + } + }, + "ListTagsForResourceOutput":{ + "type":"structure", + "members":{ + "ResourceARN":{"shape":"ResourceARN"}, + "Marker":{"shape":"Marker"}, + "Tags":{"shape":"Tags"} + } + }, + "ListTapesInput":{ + "type":"structure", + "members":{ + "TapeARNs":{"shape":"TapeARNs"}, + "Marker":{"shape":"Marker"}, + "Limit":{"shape":"PositiveIntObject"} + } + }, + "ListTapesOutput":{ + "type":"structure", + "members":{ + "TapeInfos":{"shape":"TapeInfos"}, + "Marker":{"shape":"Marker"} + } + }, + "ListVolumeInitiatorsInput":{ + "type":"structure", + "required":["VolumeARN"], + "members":{ + "VolumeARN":{"shape":"VolumeARN"} + } + }, + "ListVolumeInitiatorsOutput":{ + "type":"structure", + "members":{ + "Initiators":{"shape":"Initiators"} + } + }, + "ListVolumeRecoveryPointsInput":{ + "type":"structure", + "required":["GatewayARN"], + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + } + }, + "ListVolumeRecoveryPointsOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "VolumeRecoveryPointInfos":{"shape":"VolumeRecoveryPointInfos"} + } + }, + "ListVolumesInput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "Marker":{"shape":"Marker"}, + "Limit":{"shape":"PositiveIntObject"} + } + }, + "ListVolumesOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "Marker":{"shape":"Marker"}, + "VolumeInfos":{"shape":"VolumeInfos"} + } + }, + "LocalConsolePassword":{ + "type":"string", + "max":512, + "min":6, + "pattern":"^[ -~]+$", + "sensitive":true + }, + "Marker":{ + "type":"string", + "max":1000, + "min":1 + }, + "MediumChangerType":{ + "type":"string", + "max":50, + "min":2 + }, + "MinuteOfHour":{ + "type":"integer", + "max":59, + "min":0 + }, + "NetworkInterface":{ + "type":"structure", + "members":{ + "Ipv4Address":{"shape":"string"}, + "MacAddress":{"shape":"string"}, + "Ipv6Address":{"shape":"string"} + } + }, + "NetworkInterfaceId":{ + "type":"string", + "pattern":"\\A(25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(\\.(25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}\\z" + }, + "NextUpdateAvailabilityDate":{ + "type":"string", + "max":25, + "min":1 + }, + "NumTapesToCreate":{ + "type":"integer", + "max":10, + "min":1 + }, + "PositiveIntObject":{ + "type":"integer", + "min":1 + }, + "RecurrenceInHours":{ + "type":"integer", + "max":24, + "min":1 + }, + "RegionId":{ + "type":"string", + "max":25, + "min":1 + }, + "RemoveTagsFromResourceInput":{ + "type":"structure", + "required":[ + "ResourceARN", + "TagKeys" + ], + "members":{ + "ResourceARN":{"shape":"ResourceARN"}, + "TagKeys":{"shape":"TagKeys"} + } + }, + "RemoveTagsFromResourceOutput":{ + "type":"structure", + "members":{ + "ResourceARN":{"shape":"ResourceARN"} + } + }, + "ResetCacheInput":{ + "type":"structure", + "required":["GatewayARN"], + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + } + }, + "ResetCacheOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + } + }, + "ResourceARN":{ + "type":"string", + "max":500, + "min":50 + }, + "RetrieveTapeArchiveInput":{ + "type":"structure", + "required":[ + "TapeARN", + "GatewayARN" + ], + "members":{ + "TapeARN":{"shape":"TapeARN"}, + "GatewayARN":{"shape":"GatewayARN"} + } + }, + "RetrieveTapeArchiveOutput":{ + "type":"structure", + "members":{ + "TapeARN":{"shape":"TapeARN"} + } + }, + "RetrieveTapeRecoveryPointInput":{ + "type":"structure", + "required":[ + "TapeARN", + "GatewayARN" + ], + "members":{ + "TapeARN":{"shape":"TapeARN"}, + "GatewayARN":{"shape":"GatewayARN"} + } + }, + "RetrieveTapeRecoveryPointOutput":{ + "type":"structure", + "members":{ + "TapeARN":{"shape":"TapeARN"} + } + }, + "SetLocalConsolePasswordInput":{ + "type":"structure", + "required":[ + "GatewayARN", + "LocalConsolePassword" + ], + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "LocalConsolePassword":{"shape":"LocalConsolePassword"} + } + }, + "SetLocalConsolePasswordOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + } + }, + "ShutdownGatewayInput":{ + "type":"structure", + "required":["GatewayARN"], + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + } + }, + "ShutdownGatewayOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + } + }, + "SnapshotDescription":{ + "type":"string", + "max":255, + "min":1 + }, + "SnapshotId":{ + "type":"string", + "pattern":"\\Asnap-([0-9A-Fa-f]{8}|[0-9A-Fa-f]{17})\\z" + }, + "StartGatewayInput":{ + "type":"structure", + "required":["GatewayARN"], + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + } + }, + "StartGatewayOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + } + }, + "StorageGatewayError":{ + "type":"structure", + "members":{ + "errorCode":{"shape":"ErrorCode"}, + "errorDetails":{"shape":"errorDetails"} + } + }, + "StorediSCSIVolume":{ + "type":"structure", + "members":{ + "VolumeARN":{"shape":"VolumeARN"}, + "VolumeId":{"shape":"VolumeId"}, + "VolumeType":{"shape":"VolumeType"}, + "VolumeStatus":{"shape":"VolumeStatus"}, + "VolumeSizeInBytes":{"shape":"long"}, + "VolumeProgress":{"shape":"DoubleObject"}, + "VolumeDiskId":{"shape":"DiskId"}, + "SourceSnapshotId":{"shape":"SnapshotId"}, + "PreservedExistingData":{"shape":"boolean"}, + "VolumeiSCSIAttributes":{"shape":"VolumeiSCSIAttributes"} + } + }, + "StorediSCSIVolumes":{ + "type":"list", + "member":{"shape":"StorediSCSIVolume"} + }, + "Tag":{ + "type":"structure", + "required":[ + "Key", + "Value" + ], + "members":{ + "Key":{"shape":"TagKey"}, + "Value":{"shape":"TagValue"} + } + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-%@]*)$" + }, + "TagKeys":{ + "type":"list", + "member":{"shape":"TagKey"} + }, + "TagValue":{ + "type":"string", + "max":256 + }, + "Tags":{ + "type":"list", + "member":{"shape":"Tag"} + }, + "Tape":{ + "type":"structure", + "members":{ + "TapeARN":{"shape":"TapeARN"}, + "TapeBarcode":{"shape":"TapeBarcode"}, + "TapeSizeInBytes":{"shape":"TapeSize"}, + "TapeStatus":{"shape":"TapeStatus"}, + "VTLDevice":{"shape":"VTLDeviceARN"}, + "Progress":{"shape":"DoubleObject"} + } + }, + "TapeARN":{ + "type":"string", + "max":500, + "min":50 + }, + "TapeARNs":{ + "type":"list", + "member":{"shape":"TapeARN"} + }, + "TapeArchive":{ + "type":"structure", + "members":{ + "TapeARN":{"shape":"TapeARN"}, + "TapeBarcode":{"shape":"TapeBarcode"}, + "TapeSizeInBytes":{"shape":"TapeSize"}, + "CompletionTime":{"shape":"Time"}, + "RetrievedTo":{"shape":"GatewayARN"}, + "TapeStatus":{"shape":"TapeArchiveStatus"} + } + }, + "TapeArchiveStatus":{"type":"string"}, + "TapeArchives":{ + "type":"list", + "member":{"shape":"TapeArchive"} + }, + "TapeBarcode":{ + "type":"string", + "max":16, + "min":7, + "pattern":"^[A-Z0-9]*$" + }, + "TapeBarcodePrefix":{ + "type":"string", + "max":4, + "min":1, + "pattern":"^[A-Z]*$" + }, + "TapeDriveType":{ + "type":"string", + "max":50, + "min":2 + }, + "TapeInfo":{ + "type":"structure", + "members":{ + "TapeARN":{"shape":"TapeARN"}, + "TapeBarcode":{"shape":"TapeBarcode"}, + "TapeSizeInBytes":{"shape":"TapeSize"}, + "TapeStatus":{"shape":"TapeStatus"}, + "GatewayARN":{"shape":"GatewayARN"} + } + }, + "TapeInfos":{ + "type":"list", + "member":{"shape":"TapeInfo"} + }, + "TapeRecoveryPointInfo":{ + "type":"structure", + "members":{ + "TapeARN":{"shape":"TapeARN"}, + "TapeRecoveryPointTime":{"shape":"Time"}, + "TapeSizeInBytes":{"shape":"TapeSize"}, + "TapeStatus":{"shape":"TapeRecoveryPointStatus"} + } + }, + "TapeRecoveryPointInfos":{ + "type":"list", + "member":{"shape":"TapeRecoveryPointInfo"} + }, + "TapeRecoveryPointStatus":{"type":"string"}, + "TapeSize":{"type":"long"}, + "TapeStatus":{"type":"string"}, + "Tapes":{ + "type":"list", + "member":{"shape":"Tape"} + }, + "TargetARN":{ + "type":"string", + "max":800, + "min":50 + }, + "TargetName":{ + "type":"string", + "max":200, + "min":1, + "pattern":"^[-\\.;a-z0-9]+$" + }, + "Time":{"type":"timestamp"}, + "UpdateBandwidthRateLimitInput":{ + "type":"structure", + "required":["GatewayARN"], + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "AverageUploadRateLimitInBitsPerSec":{"shape":"BandwidthUploadRateLimit"}, + "AverageDownloadRateLimitInBitsPerSec":{"shape":"BandwidthDownloadRateLimit"} + } + }, + "UpdateBandwidthRateLimitOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + } + }, + "UpdateChapCredentialsInput":{ + "type":"structure", + "required":[ + "TargetARN", + "SecretToAuthenticateInitiator", + "InitiatorName" + ], + "members":{ + "TargetARN":{"shape":"TargetARN"}, + "SecretToAuthenticateInitiator":{"shape":"ChapSecret"}, + "InitiatorName":{"shape":"IqnName"}, + "SecretToAuthenticateTarget":{"shape":"ChapSecret"} + } + }, + "UpdateChapCredentialsOutput":{ + "type":"structure", + "members":{ + "TargetARN":{"shape":"TargetARN"}, + "InitiatorName":{"shape":"IqnName"} + } + }, + "UpdateGatewayInformationInput":{ + "type":"structure", + "required":["GatewayARN"], + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "GatewayName":{"shape":"GatewayName"}, + "GatewayTimezone":{"shape":"GatewayTimezone"} + } + }, + "UpdateGatewayInformationOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "GatewayName":{"shape":"string"} + } + }, + "UpdateGatewaySoftwareNowInput":{ + "type":"structure", + "required":["GatewayARN"], + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + } + }, + "UpdateGatewaySoftwareNowOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + } + }, + "UpdateMaintenanceStartTimeInput":{ + "type":"structure", + "required":[ + "GatewayARN", + "HourOfDay", + "MinuteOfHour", + "DayOfWeek" + ], + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "HourOfDay":{"shape":"HourOfDay"}, + "MinuteOfHour":{"shape":"MinuteOfHour"}, + "DayOfWeek":{"shape":"DayOfWeek"} + } + }, + "UpdateMaintenanceStartTimeOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + } + }, + "UpdateSnapshotScheduleInput":{ + "type":"structure", + "required":[ + "VolumeARN", + "StartAt", + "RecurrenceInHours" + ], + "members":{ + "VolumeARN":{"shape":"VolumeARN"}, + "StartAt":{"shape":"HourOfDay"}, + "RecurrenceInHours":{"shape":"RecurrenceInHours"}, + "Description":{"shape":"Description"} + } + }, + "UpdateSnapshotScheduleOutput":{ + "type":"structure", + "members":{ + "VolumeARN":{"shape":"VolumeARN"} + } + }, + "UpdateVTLDeviceTypeInput":{ + "type":"structure", + "required":[ + "VTLDeviceARN", + "DeviceType" + ], + "members":{ + "VTLDeviceARN":{"shape":"VTLDeviceARN"}, + "DeviceType":{"shape":"DeviceType"} + } + }, + "UpdateVTLDeviceTypeOutput":{ + "type":"structure", + "members":{ + "VTLDeviceARN":{"shape":"VTLDeviceARN"} + } + }, + "VTLDevice":{ + "type":"structure", + "members":{ + "VTLDeviceARN":{"shape":"VTLDeviceARN"}, + "VTLDeviceType":{"shape":"VTLDeviceType"}, + "VTLDeviceVendor":{"shape":"VTLDeviceVendor"}, + "VTLDeviceProductIdentifier":{"shape":"VTLDeviceProductIdentifier"}, + "DeviceiSCSIAttributes":{"shape":"DeviceiSCSIAttributes"} + } + }, + "VTLDeviceARN":{ + "type":"string", + "max":500, + "min":50 + }, + "VTLDeviceARNs":{ + "type":"list", + "member":{"shape":"VTLDeviceARN"} + }, + "VTLDeviceProductIdentifier":{"type":"string"}, + "VTLDeviceType":{"type":"string"}, + "VTLDeviceVendor":{"type":"string"}, + "VTLDevices":{ + "type":"list", + "member":{"shape":"VTLDevice"} + }, + "VolumeARN":{ + "type":"string", + "max":500, + "min":50 + }, + "VolumeARNs":{ + "type":"list", + "member":{"shape":"VolumeARN"} + }, + "VolumeId":{ + "type":"string", + "max":30, + "min":12 + }, + "VolumeInfo":{ + "type":"structure", + "members":{ + "VolumeARN":{"shape":"VolumeARN"}, + "VolumeId":{"shape":"VolumeId"}, + "GatewayARN":{"shape":"GatewayARN"}, + "GatewayId":{"shape":"GatewayId"}, + "VolumeType":{"shape":"VolumeType"}, + "VolumeSizeInBytes":{"shape":"long"} + } + }, + "VolumeInfos":{ + "type":"list", + "member":{"shape":"VolumeInfo"} + }, + "VolumeRecoveryPointInfo":{ + "type":"structure", + "members":{ + "VolumeARN":{"shape":"VolumeARN"}, + "VolumeSizeInBytes":{"shape":"long"}, + "VolumeUsageInBytes":{"shape":"long"}, + "VolumeRecoveryPointTime":{"shape":"string"} + } + }, + "VolumeRecoveryPointInfos":{ + "type":"list", + "member":{"shape":"VolumeRecoveryPointInfo"} + }, + "VolumeStatus":{ + "type":"string", + "max":50, + "min":3 + }, + "VolumeType":{ + "type":"string", + "max":100, + "min":3 + }, + "VolumeiSCSIAttributes":{ + "type":"structure", + "members":{ + "TargetARN":{"shape":"TargetARN"}, + "NetworkInterfaceId":{"shape":"NetworkInterfaceId"}, + "NetworkInterfacePort":{"shape":"integer"}, + "LunNumber":{"shape":"PositiveIntObject"}, + "ChapEnabled":{"shape":"boolean"} + } + }, + "boolean":{"type":"boolean"}, + "double":{"type":"double"}, + "errorDetails":{ + "type":"map", + "key":{"shape":"string"}, + "value":{"shape":"string"} + }, + "integer":{"type":"integer"}, + "long":{"type":"long"}, + "string":{"type":"string"} + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/storagegateway/2013-06-30/docs-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/storagegateway/2013-06-30/docs-2.json new file mode 100644 index 000000000..0702cc75f --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/storagegateway/2013-06-30/docs-2.json @@ -0,0 +1,1484 @@ +{ + "version": "2.0", + "service": "AWS Storage Gateway is the service that connects an on-premises software appliance with cloud-based storage to provide seamless and secure integration between an organization's on-premises IT environment and AWS's storage infrastructure. The service enables you to securely upload data to the AWS cloud for cost effective backup and rapid disaster recovery.
Use the following links to get started using the AWS Storage Gateway Service API Reference:
AWS Storage Gateway Required Request Headers: Describes the required headers that you must send with every POST request to AWS Storage Gateway.
Signing Requests: AWS Storage Gateway requires that you authenticate every request you send; this topic describes how sign such a request.
Error Responses: Provides reference information about AWS Storage Gateway errors.
Operations in AWS Storage Gateway: Contains detailed descriptions of all AWS Storage Gateway operations, their request parameters, response elements, possible errors, and examples of requests and responses.
AWS Storage Gateway Regions and Endpoints: Provides a list of each of the s and endpoints available for use with AWS Storage Gateway.
AWS Storage Gateway resource IDs are in uppercase. When you use these resource IDs with the Amazon EC2 API, EC2 expects resource IDs in lowercase. You must change your resource ID to lowercase to use it with the EC2 API. For example, in Storage Gateway the ID for a volume might be vol-1122AABB. When you use this ID with the EC2 API, you must change it to vol-1122aabb. Otherwise, the EC2 API might not behave as expected.
IDs for Storage Gateway volumes and Amazon EBS snapshots created from gateway volumes are changing to a longer format. Starting in December 2016, all new volumes and snapshots will be created with a 17-character string. Starting in April 2016, you will be able to use these longer IDs so you can test your systems with the new format. For more information, see Longer EC2 and EBS Resource IDs.
For example, a volume ARN with the longer volume ID format will look like this:
arn:aws:storagegateway:us-west-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABBCCDDEEFFG.
A snapshot ID with the longer ID format will look like this: snap-78e226633445566ee.
For more information, see Announcement: Heads-up – Longer AWS Storage Gateway volume and snapshot IDs coming in 2016.
Activates the gateway you previously deployed on your host. For more information, see Activate the AWS Storage Gateway. In the activation process, you specify information such as the you want to use for storing snapshots, the time zone for scheduled snapshots the gateway snapshot schedule window, an activation key, and a name for your gateway. The activation process also associates your gateway with your account; for more information, see UpdateGatewayInformation.
You must turn on the gateway VM before you can activate your gateway.
Configures one or more gateway local disks as cache for a cached-volume gateway. This operation is supported only for the gateway-cached volume architecture (see Storage Gateway Concepts).
In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add cache, and one or more disk IDs that you want to configure as cache.
", + "AddTagsToResource": "Adds one or more tags to the specified resource. You use tags to add metadata to resources, which you can use to categorize these resources. For example, you can categorize resources by purpose, owner, environment, or team. Each tag consists of a key and a value, which you define. You can add tags to the following AWS Storage Gateway resources:
Storage gateways of all types
Storage Volumes
Virtual Tapes
You can create a maximum of 10 tags for each resource. Virtual tapes and storage volumes that are recovered to a new gateway maintain their tags.
", + "AddUploadBuffer": "Configures one or more gateway local disks as upload buffer for a specified gateway. This operation is supported for both the gateway-stored and gateway-cached volume architectures.
In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add upload buffer, and one or more disk IDs that you want to configure as upload buffer.
", + "AddWorkingStorage": "Configures one or more gateway local disks as working storage for a gateway. This operation is supported only for the gateway-stored volume architecture. This operation is deprecated in cached-volumes API version 20120630. Use AddUploadBuffer instead.
Working storage is also referred to as upload buffer. You can also use the AddUploadBuffer operation to add upload buffer to a stored-volume gateway.
In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add working storage, and one or more disk IDs that you want to configure as working storage.
", + "CancelArchival": "Cancels archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving process is initiated.
", + "CancelRetrieval": "Cancels retrieval of a virtual tape from the virtual tape shelf (VTS) to a gateway after the retrieval process is initiated. The virtual tape is returned to the VTS.
", + "CreateCachediSCSIVolume": "Creates a cached volume on a specified cached gateway. This operation is supported only for the gateway-cached volume architecture.
Cache storage must be allocated to the gateway before you can create a cached volume. Use the AddCache operation to add cache storage to a gateway.
In the request, you must specify the gateway, size of the volume in bytes, the iSCSI target name, an IP address on which to expose the target, and a unique client token. In response, AWS Storage Gateway creates the volume and returns information about it such as the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target.
", + "CreateSnapshot": "Initiates a snapshot of a volume.
AWS Storage Gateway provides the ability to back up point-in-time snapshots of your data to Amazon Simple Storage (S3) for durable off-site recovery, as well as import the data to an Amazon Elastic Block Store (EBS) volume in Amazon Elastic Compute Cloud (EC2). You can take snapshots of your gateway volume on a scheduled or ad-hoc basis. This API enables you to take ad-hoc snapshot. For more information, see Working With Snapshots in the AWS Storage Gateway Console.
In the CreateSnapshot request you identify the volume by providing its Amazon Resource Name (ARN). You must also provide description for the snapshot. When AWS Storage Gateway takes the snapshot of specified volume, the snapshot and description appears in the AWS Storage Gateway Console. In response, AWS Storage Gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot.
To list or delete a snapshot, you must use the Amazon EC2 API. For more information, see DescribeSnapshots or DeleteSnapshot in the EC2 API reference.
Volume and snapshot IDs are changing to a longer length ID format. For more information, see the important note on the Welcome page.
Initiates a snapshot of a gateway from a volume recovery point. This operation is supported only for the gateway-cached volume architecture.
A volume recovery point is a point in time at which all data of the volume is consistent and from which you can create a snapshot. To get a list of volume recovery point for gateway-cached volumes, use ListVolumeRecoveryPoints.
In the CreateSnapshotFromVolumeRecoveryPoint request, you identify the volume by providing its Amazon Resource Name (ARN). You must also provide a description for the snapshot. When AWS Storage Gateway takes a snapshot of the specified volume, the snapshot and its description appear in the AWS Storage Gateway console. In response, AWS Storage Gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot.
To list or delete a snapshot, you must use the Amazon EC2 API. For more information, in Amazon Elastic Compute Cloud API Reference.
Creates a volume on a specified gateway. This operation is supported only for the gateway-stored volume architecture.
The size of the volume to create is inferred from the disk size. You can choose to preserve existing data on the disk, create volume from an existing snapshot, or create an empty volume. If you choose to create an empty gateway volume, then any existing data on the disk is erased.
In the request you must specify the gateway and the disk information on which you are creating the volume. In response, AWS Storage Gateway creates the volume and returns volume information such as the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target.
", + "CreateTapeWithBarcode": "Creates a virtual tape by using your own barcode. You write data to the virtual tape and then archive the tape.
Cache storage must be allocated to the gateway before you can create a virtual tape. Use the AddCache operation to add cache storage to a gateway.
Creates one or more virtual tapes. You write data to the virtual tapes and then archive the tapes.
Cache storage must be allocated to the gateway before you can create virtual tapes. Use the AddCache operation to add cache storage to a gateway.
Deletes the bandwidth rate limits of a gateway. You can delete either the upload and download bandwidth rate limit, or you can delete both. If you delete only one of the limits, the other limit remains unchanged. To specify which gateway to work with, use the Amazon Resource Name (ARN) of the gateway in your request.
", + "DeleteChapCredentials": "Deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair.
", + "DeleteGateway": "Deletes a gateway. To specify which gateway to delete, use the Amazon Resource Name (ARN) of the gateway in your request. The operation deletes the gateway; however, it does not delete the gateway virtual machine (VM) from your host computer.
After you delete a gateway, you cannot reactivate it. Completed snapshots of the gateway volumes are not deleted upon deleting the gateway, however, pending snapshots will not complete. After you delete a gateway, your next step is to remove it from your environment.
You no longer pay software charges after the gateway is deleted; however, your existing Amazon EBS snapshots persist and you will continue to be billed for these snapshots. You can choose to remove all remaining Amazon EBS snapshots by canceling your Amazon EC2 subscription. If you prefer not to cancel your Amazon EC2 subscription, you can delete your snapshots using the Amazon EC2 console. For more information, see the AWS Storage Gateway Detail Page.
Deletes a snapshot of a volume.
You can take snapshots of your gateway volumes on a scheduled or ad hoc basis. This API action enables you to delete a snapshot schedule for a volume. For more information, see Working with Snapshots. In the DeleteSnapshotSchedule request, you identify the volume by providing its Amazon Resource Name (ARN).
To list or delete a snapshot, you must use the Amazon EC2 API. in Amazon Elastic Compute Cloud API Reference.
Deletes the specified virtual tape.
", + "DeleteTapeArchive": "Deletes the specified virtual tape from the virtual tape shelf (VTS).
", + "DeleteVolume": "Deletes the specified gateway volume that you previously created using the CreateCachediSCSIVolume or CreateStorediSCSIVolume API. For gateway-stored volumes, the local disk that was configured as the storage volume is not deleted. You can reuse the local disk to create another storage volume.
Before you delete a gateway volume, make sure there are no iSCSI connections to the volume you are deleting. You should also make sure there is no snapshot in progress. You can use the Amazon Elastic Compute Cloud (Amazon EC2) API to query snapshots on the volume you are deleting and check the snapshot status. For more information, go to DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.
In the request, you must provide the Amazon Resource Name (ARN) of the storage volume you want to delete.
", + "DescribeBandwidthRateLimit": "Returns the bandwidth rate limits of a gateway. By default, these limits are not set, which means no bandwidth rate limiting is in effect.
This operation only returns a value for a bandwidth rate limit only if the limit is set. If no limits are set for the gateway, then this operation returns only the gateway ARN in the response body. To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.
", + "DescribeCache": "Returns information about the cache of a gateway. This operation is supported only for the gateway-cached volume architecture.
The response includes disk IDs that are configured as cache, and it includes the amount of cache allocated and used.
", + "DescribeCachediSCSIVolumes": "Returns a description of the gateway volumes specified in the request. This operation is supported only for the gateway-cached volume architecture.
The list of gateway volumes in the request must be from one gateway. In the response Amazon Storage Gateway returns volume information sorted by volume Amazon Resource Name (ARN).
", + "DescribeChapCredentials": "Returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair.
", + "DescribeGatewayInformation": "Returns metadata about a gateway such as its name, network interfaces, configured time zone, and the state (whether the gateway is running or not). To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.
", + "DescribeMaintenanceStartTime": "Returns your gateway's weekly maintenance start time including the day and time of the week. Note that values are in terms of the gateway's time zone.
", + "DescribeSnapshotSchedule": "Describes the snapshot schedule for the specified gateway volume. The snapshot schedule information includes intervals at which snapshots are automatically initiated on the volume.
", + "DescribeStorediSCSIVolumes": "Returns the description of the gateway volumes specified in the request. The list of gateway volumes in the request must be from one gateway. In the response Amazon Storage Gateway returns volume information sorted by volume ARNs.
", + "DescribeTapeArchives": "Returns a description of specified virtual tapes in the virtual tape shelf (VTS).
If a specific TapeARN is not specified, AWS Storage Gateway returns a description of all virtual tapes found in the VTS associated with your account.
Returns a list of virtual tape recovery points that are available for the specified gateway-VTL.
A recovery point is a point-in-time view of a virtual tape at which all the data on the virtual tape is consistent. If your gateway crashes, virtual tapes that have recovery points can be recovered to a new gateway.
", + "DescribeTapes": "Returns a description of the specified Amazon Resource Name (ARN) of virtual tapes. If a TapeARN is not specified, returns a description of all virtual tapes associated with the specified gateway.
Returns information about the upload buffer of a gateway. This operation is supported for both the gateway-stored and gateway-cached volume architectures.
The response includes disk IDs that are configured as upload buffer space, and it includes the amount of upload buffer space allocated and used.
", + "DescribeVTLDevices": "Returns a description of virtual tape library (VTL) devices for the specified gateway. In the response, AWS Storage Gateway returns VTL device information.
The list of VTL devices must be from one gateway.
", + "DescribeWorkingStorage": "Returns information about the working storage of a gateway. This operation is supported only for the gateway-stored volume architecture. This operation is deprecated in cached-volumes API version (20120630). Use DescribeUploadBuffer instead.
Working storage is also referred to as upload buffer. You can also use the DescribeUploadBuffer operation to add upload buffer to a stored-volume gateway.
The response includes disk IDs that are configured as working storage, and it includes the amount of working storage allocated and used.
", + "DisableGateway": "Disables a gateway when the gateway is no longer functioning. For example, if your gateway VM is damaged, you can disable the gateway so you can recover virtual tapes.
Use this operation for a gateway-VTL that is not reachable or not functioning.
Once a gateway is disabled it cannot be enabled.
Lists gateways owned by an AWS account in a region specified in the request. The returned list is ordered by gateway Amazon Resource Name (ARN).
By default, the operation returns a maximum of 100 gateways. This operation supports pagination that allows you to optionally reduce the number of gateways returned in a response.
If you have more gateways than are returned in a response (that is, the response returns only a truncated list of your gateways), the response contains a marker that you can specify in your next request to fetch the next page of gateways.
", + "ListLocalDisks": "Returns a list of the gateway's local disks. To specify which gateway to describe, you use the Amazon Resource Name (ARN) of the gateway in the body of the request.
The request returns a list of all disks, specifying which are configured as working storage, cache storage, or stored volume or not configured at all. The response includes a DiskStatus field. This field can have a value of present (the disk is available to use), missing (the disk is no longer connected to the gateway), or mismatch (the disk node is occupied by a disk that has incorrect metadata or the disk content is corrupted).
Lists the tags that have been added to the specified resource.
", + "ListTapes": "Lists virtual tapes in your virtual tape library (VTL) and your virtual tape shelf (VTS). You specify the tapes to list by specifying one or more tape Amazon Resource Names (ARNs). If you don't specify a tape ARN, the operation lists all virtual tapes in both your VTL and VTS.
This operation supports pagination. By default, the operation returns a maximum of up to 100 tapes. You can optionally specify the Limit parameter in the body to limit the number of tapes in the response. If the number of tapes returned in the response is truncated, the response includes a Marker element that you can use in your subsequent request to retrieve the next set of tapes.
Lists iSCSI initiators that are connected to a volume. You can use this operation to determine whether a volume is being used or not.
", + "ListVolumeRecoveryPoints": "Lists the recovery points for a specified gateway. This operation is supported only for the gateway-cached volume architecture.
Each gateway-cached volume has one recovery point. A volume recovery point is a point in time at which all data of the volume is consistent and from which you can create a snapshot. To create a snapshot from a volume recovery point use the CreateSnapshotFromVolumeRecoveryPoint operation.
", + "ListVolumes": "Lists the iSCSI stored volumes of a gateway. Results are sorted by volume ARN. The response includes only the volume ARNs. If you want additional volume information, use the DescribeStorediSCSIVolumes API.
The operation supports pagination. By default, the operation returns a maximum of up to 100 volumes. You can optionally specify the Limit field in the body to limit the number of volumes in the response. If the number of volumes returned in the response is truncated, the response includes a Marker field. You can use this Marker value in your subsequent request to retrieve the next set of volumes.
Removes one or more tags from the specified resource.
", + "ResetCache": "Resets all cache disks that have encountered a error and makes the disks available for reconfiguration as cache storage. If your cache disk encounters a error, the gateway prevents read and write operations on virtual tapes in the gateway. For example, an error can occur when a disk is corrupted or removed from the gateway. When a cache is reset, the gateway loses its cache storage. At this point you can reconfigure the disks as cache disks.
If the cache disk you are resetting contains data that has not been uploaded to Amazon S3 yet, that data can be lost. After you reset cache disks, there will be no configured cache disks left in the gateway, so you must configure at least one new cache disk for your gateway to function properly.
Retrieves an archived virtual tape from the virtual tape shelf (VTS) to a gateway-VTL. Virtual tapes archived in the VTS are not associated with any gateway. However after a tape is retrieved, it is associated with a gateway, even though it is also listed in the VTS.
Once a tape is successfully retrieved to a gateway, it cannot be retrieved again to another gateway. You must archive the tape again before you can retrieve it to another gateway.
", + "RetrieveTapeRecoveryPoint": "Retrieves the recovery point for the specified virtual tape.
A recovery point is a point in time view of a virtual tape at which all the data on the tape is consistent. If your gateway crashes, virtual tapes that have recovery points can be recovered to a new gateway.
The virtual tape can be retrieved to only one gateway. The retrieved tape is read-only. The virtual tape can be retrieved to only a gateway-VTL. There is no charge for retrieving recovery points.
Sets the password for your VM local console. When you log in to the local console for the first time, you log in to the VM with the default credentials. We recommend that you set a new password. You don't need to know the default password to set a new password.
", + "ShutdownGateway": "Shuts down a gateway. To specify which gateway to shut down, use the Amazon Resource Name (ARN) of the gateway in the body of your request.
The operation shuts down the gateway service component running in the storage gateway's virtual machine (VM) and not the VM.
If you want to shut down the VM, it is recommended that you first shut down the gateway component in the VM to avoid unpredictable conditions.
After the gateway is shutdown, you cannot call any other API except StartGateway, DescribeGatewayInformation, and ListGateways. For more information, see ActivateGateway. Your applications cannot read from or write to the gateway's storage volumes, and there are no snapshots taken.
When you make a shutdown request, you will get a 200 OK success response immediately. However, it might take some time for the gateway to shut down. You can call the DescribeGatewayInformation API to check the status. For more information, see ActivateGateway.
If do not intend to use the gateway again, you must delete the gateway (using DeleteGateway) to no longer pay software charges associated with the gateway.
", + "StartGateway": "Starts a gateway that you previously shut down (see ShutdownGateway). After the gateway starts, you can then make other API calls, your applications can read from or write to the gateway's storage volumes and you will be able to take snapshot backups.
When you make a request, you will get a 200 OK success response immediately. However, it might take some time for the gateway to be ready. You should call DescribeGatewayInformation and check the status before making any additional API calls. For more information, see ActivateGateway.
To specify which gateway to start, use the Amazon Resource Name (ARN) of the gateway in your request.
", + "UpdateBandwidthRateLimit": "Updates the bandwidth rate limits of a gateway. You can update both the upload and download bandwidth rate limit or specify only one of the two. If you don't set a bandwidth rate limit, the existing rate limit remains.
By default, a gateway's bandwidth rate limits are not set. If you don't set any limit, the gateway does not have any limitations on its bandwidth usage and could potentially use the maximum available bandwidth.
To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request.
", + "UpdateChapCredentials": "Updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target. By default, a gateway does not have CHAP enabled; however, for added security, you might use it.
When you update CHAP credentials, all existing connections on the target are closed and initiators must reconnect with the new credentials.
Updates a gateway's metadata, which includes the gateway's name and time zone. To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request.
For Gateways activated after September 2, 2015, the gateway's ARN contains the gateway ID rather than the gateway name. However, changing the name of the gateway has no effect on the gateway's ARN.
Updates the gateway virtual machine (VM) software. The request immediately triggers the software update.
When you make this request, you get a 200 OK success response immediately. However, it might take some time for the update to complete. You can call DescribeGatewayInformation to verify the gateway is in the STATE_RUNNING state.
A software update forces a system restart of your gateway. You can minimize the chance of any disruption to your applications by increasing your iSCSI Initiators' timeouts. For more information about increasing iSCSI Initiator timeouts for Windows and Linux, see Customizing Your Windows iSCSI Settings and Customizing Your Linux iSCSI Settings, respectively.
Updates a gateway's weekly maintenance start time information, including day and time of the week. The maintenance time is the time in your gateway's time zone.
", + "UpdateSnapshotSchedule": "Updates a snapshot schedule configured for a gateway volume.
The default snapshot schedule for volume is once every 24 hours, starting at the creation time of the volume. You can use this API to change the snapshot schedule configured for the volume.
In the request you must identify the gateway volume whose snapshot schedule you want to update, and the schedule information, including when you want the snapshot to begin on a day and the frequency (in hours) of snapshots.
", + "UpdateVTLDeviceType": "Updates the type of medium changer in a gateway-VTL. When you activate a gateway-VTL, you select a medium changer type for the gateway-VTL. This operation enables you to select a different type of medium changer after a gateway-VTL is activated.
" + }, + "shapes": { + "ActivateGatewayInput": { + "base": "A JSON object containing one or more of the following fields:
AWS Storage Gateway returns the Amazon Resource Name (ARN) of the activated gateway. It is a string made of information such as your account, gateway name, and region. This ARN is used to reference the gateway in other API operations as well as resource-based authorization.
For gateways activated prior to September 02, 2015 the gateway ARN contains the gateway name rather than the gateway id. Changing the name of the gateway has no effect on the gateway ARN.
Your gateway activation key. You can obtain the activation key by sending an HTTP GET request with redirects enabled to the gateway IP address (port 80). The redirect URL returned in the response provides you the activation key for your gateway in the query string parameter activationKey. It may also include other activation-related parameters, however, these are merely defaults -- the arguments you pass to the ActivateGateway API call determine the actual configuration of your gateway.
AddTagsToResourceInput
", + "refs": { + } + }, + "AddTagsToResourceOutput": { + "base": "AddTagsToResourceOutput
", + "refs": { + } + }, + "AddUploadBufferInput": { + "base": null, + "refs": { + } + }, + "AddUploadBufferOutput": { + "base": null, + "refs": { + } + }, + "AddWorkingStorageInput": { + "base": "A JSON object containing one or more of the following fields:
", + "refs": { + } + }, + "AddWorkingStorageOutput": { + "base": "A JSON object containing the of the gateway for which working storage was configured.
", + "refs": { + } + }, + "BandwidthDownloadRateLimit": { + "base": null, + "refs": { + "DescribeBandwidthRateLimitOutput$AverageDownloadRateLimitInBitsPerSec": "The average download bandwidth rate limit in bits per second. This field does not appear in the response if the download rate limit is not set.
", + "UpdateBandwidthRateLimitInput$AverageDownloadRateLimitInBitsPerSec": "The average download bandwidth rate limit in bits per second.
" + } + }, + "BandwidthType": { + "base": null, + "refs": { + "DeleteBandwidthRateLimitInput$BandwidthType": null + } + }, + "BandwidthUploadRateLimit": { + "base": null, + "refs": { + "DescribeBandwidthRateLimitOutput$AverageUploadRateLimitInBitsPerSec": "The average upload bandwidth rate limit in bits per second. This field does not appear in the response if the upload rate limit is not set.
", + "UpdateBandwidthRateLimitInput$AverageUploadRateLimitInBitsPerSec": "The average upload bandwidth rate limit in bits per second.
" + } + }, + "CachediSCSIVolume": { + "base": null, + "refs": { + "CachediSCSIVolumes$member": null + } + }, + "CachediSCSIVolumes": { + "base": null, + "refs": { + "DescribeCachediSCSIVolumesOutput$CachediSCSIVolumes": "An array of objects where each object contains metadata about one cached volume.
" + } + }, + "CancelArchivalInput": { + "base": "CancelArchivalInput
", + "refs": { + } + }, + "CancelArchivalOutput": { + "base": "CancelArchivalOutput
", + "refs": { + } + }, + "CancelRetrievalInput": { + "base": "CancelRetrievalInput
", + "refs": { + } + }, + "CancelRetrievalOutput": { + "base": "CancelRetrievalOutput
", + "refs": { + } + }, + "ChapCredentials": { + "base": null, + "refs": { + "DescribeChapCredentialsOutput$ChapCredentials": "An array of ChapInfo objects that represent CHAP credentials. Each object in the array contains CHAP credential information for one target-initiator pair. If no CHAP credentials are set, an empty array is returned. CHAP credential information is provided in a JSON object with the following fields:
InitiatorName: The iSCSI initiator that connects to the target.
SecretToAuthenticateInitiator: The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target.
SecretToAuthenticateTarget: The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client).
TargetARN: The Amazon Resource Name (ARN) of the storage volume.
Describes Challenge-Handshake Authentication Protocol (CHAP) information that supports authentication between your gateway and iSCSI initiators.
", + "refs": { + "ChapCredentials$member": null + } + }, + "ChapSecret": { + "base": null, + "refs": { + "ChapInfo$SecretToAuthenticateInitiator": "The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target.
", + "ChapInfo$SecretToAuthenticateTarget": "The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client).
", + "UpdateChapCredentialsInput$SecretToAuthenticateInitiator": "The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target.
The secret key must be between 12 and 16 bytes when encoded in UTF-8.
The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client).
Byte constraints: Minimum bytes of 12. Maximum bytes of 16.
The secret key must be between 12 and 16 bytes when encoded in UTF-8.
A unique identifier that you use to retry a request. If you retry a request, use the same ClientToken you specified in the initial request.
Using the same ClientToken prevents creating the tape multiple times.
A JSON object containing one or more of the following fields:
", + "refs": { + } + }, + "CreateSnapshotOutput": { + "base": "A JSON object containing the following fields:
", + "refs": { + } + }, + "CreateStorediSCSIVolumeInput": { + "base": "A JSON object containing one or more of the following fields:
A JSON object containing the following fields:
", + "refs": { + } + }, + "CreateTapeWithBarcodeInput": { + "base": "CreateTapeWithBarcodeInput
", + "refs": { + } + }, + "CreateTapeWithBarcodeOutput": { + "base": "CreateTapeOutput
", + "refs": { + } + }, + "CreateTapesInput": { + "base": "CreateTapesInput
", + "refs": { + } + }, + "CreateTapesOutput": { + "base": "CreateTapeOutput
", + "refs": { + } + }, + "DayOfWeek": { + "base": null, + "refs": { + "DescribeMaintenanceStartTimeOutput$DayOfWeek": null, + "UpdateMaintenanceStartTimeInput$DayOfWeek": "The maintenance start time day of the week.
" + } + }, + "DeleteBandwidthRateLimitInput": { + "base": null, + "refs": { + } + }, + "DeleteBandwidthRateLimitOutput": { + "base": "A JSON object containing the of the gateway whose bandwidth rate information was deleted.
", + "refs": { + } + }, + "DeleteChapCredentialsInput": { + "base": "A JSON object containing one or more of the following fields:
", + "refs": { + } + }, + "DeleteChapCredentialsOutput": { + "base": "A JSON object containing the following fields:
", + "refs": { + } + }, + "DeleteGatewayInput": { + "base": "A JSON object containing the id of the gateway to delete.
", + "refs": { + } + }, + "DeleteGatewayOutput": { + "base": "A JSON object containing the id of the deleted gateway.
", + "refs": { + } + }, + "DeleteSnapshotScheduleInput": { + "base": null, + "refs": { + } + }, + "DeleteSnapshotScheduleOutput": { + "base": null, + "refs": { + } + }, + "DeleteTapeArchiveInput": { + "base": "DeleteTapeArchiveInput
", + "refs": { + } + }, + "DeleteTapeArchiveOutput": { + "base": "DeleteTapeArchiveOutput
", + "refs": { + } + }, + "DeleteTapeInput": { + "base": "DeleteTapeInput
", + "refs": { + } + }, + "DeleteTapeOutput": { + "base": "DeleteTapeOutput
", + "refs": { + } + }, + "DeleteVolumeInput": { + "base": "A JSON object containing the DeleteVolumeInput$VolumeARN to delete.
", + "refs": { + } + }, + "DeleteVolumeOutput": { + "base": "A JSON object containing the of the storage volume that was deleted
", + "refs": { + } + }, + "DescribeBandwidthRateLimitInput": { + "base": "A JSON object containing the of the gateway.
", + "refs": { + } + }, + "DescribeBandwidthRateLimitOutput": { + "base": "A JSON object containing the following fields:
", + "refs": { + } + }, + "DescribeCacheInput": { + "base": null, + "refs": { + } + }, + "DescribeCacheOutput": { + "base": null, + "refs": { + } + }, + "DescribeCachediSCSIVolumesInput": { + "base": null, + "refs": { + } + }, + "DescribeCachediSCSIVolumesOutput": { + "base": "A JSON object containing the following fields:
", + "refs": { + } + }, + "DescribeChapCredentialsInput": { + "base": "A JSON object containing the Amazon Resource Name (ARN) of the iSCSI volume target.
", + "refs": { + } + }, + "DescribeChapCredentialsOutput": { + "base": "A JSON object containing a .
", + "refs": { + } + }, + "DescribeGatewayInformationInput": { + "base": "A JSON object containing the id of the gateway.
", + "refs": { + } + }, + "DescribeGatewayInformationOutput": { + "base": "A JSON object containing the following fields:
", + "refs": { + } + }, + "DescribeMaintenanceStartTimeInput": { + "base": "A JSON object containing the of the gateway.
", + "refs": { + } + }, + "DescribeMaintenanceStartTimeOutput": { + "base": null, + "refs": { + } + }, + "DescribeSnapshotScheduleInput": { + "base": "A JSON object containing the DescribeSnapshotScheduleInput$VolumeARN of the volume.
", + "refs": { + } + }, + "DescribeSnapshotScheduleOutput": { + "base": null, + "refs": { + } + }, + "DescribeStorediSCSIVolumesInput": { + "base": "A JSON object containing a list of DescribeStorediSCSIVolumesInput$VolumeARNs.
", + "refs": { + } + }, + "DescribeStorediSCSIVolumesOutput": { + "base": null, + "refs": { + } + }, + "DescribeTapeArchivesInput": { + "base": "DescribeTapeArchivesInput
", + "refs": { + } + }, + "DescribeTapeArchivesOutput": { + "base": "DescribeTapeArchivesOutput
", + "refs": { + } + }, + "DescribeTapeRecoveryPointsInput": { + "base": "DescribeTapeRecoveryPointsInput
", + "refs": { + } + }, + "DescribeTapeRecoveryPointsOutput": { + "base": "DescribeTapeRecoveryPointsOutput
", + "refs": { + } + }, + "DescribeTapesInput": { + "base": "DescribeTapesInput
", + "refs": { + } + }, + "DescribeTapesOutput": { + "base": "DescribeTapesOutput
", + "refs": { + } + }, + "DescribeUploadBufferInput": { + "base": null, + "refs": { + } + }, + "DescribeUploadBufferOutput": { + "base": null, + "refs": { + } + }, + "DescribeVTLDevicesInput": { + "base": "DescribeVTLDevicesInput
", + "refs": { + } + }, + "DescribeVTLDevicesOutput": { + "base": "DescribeVTLDevicesOutput
", + "refs": { + } + }, + "DescribeWorkingStorageInput": { + "base": "A JSON object containing the of the gateway.
", + "refs": { + } + }, + "DescribeWorkingStorageOutput": { + "base": "A JSON object containing the following fields:
", + "refs": { + } + }, + "Description": { + "base": null, + "refs": { + "DescribeSnapshotScheduleOutput$Description": null, + "UpdateSnapshotScheduleInput$Description": "Optional description of the snapshot that overwrites the existing description.
" + } + }, + "DeviceType": { + "base": null, + "refs": { + "UpdateVTLDeviceTypeInput$DeviceType": "The type of medium changer you want to select.
Valid Values: \"STK-L700\", \"AWS-Gateway-VTL\"
" + } + }, + "DeviceiSCSIAttributes": { + "base": "Lists iSCSI information about a VTL device.
", + "refs": { + "VTLDevice$DeviceiSCSIAttributes": "A list of iSCSI information about a VTL device.
" + } + }, + "DisableGatewayInput": { + "base": "DisableGatewayInput
", + "refs": { + } + }, + "DisableGatewayOutput": { + "base": "DisableGatewayOutput
", + "refs": { + } + }, + "Disk": { + "base": null, + "refs": { + "Disks$member": null + } + }, + "DiskAllocationType": { + "base": null, + "refs": { + "Disk$DiskAllocationType": null + } + }, + "DiskId": { + "base": null, + "refs": { + "CreateStorediSCSIVolumeInput$DiskId": "The unique identifier for the gateway local disk that is configured as a stored volume. Use ListLocalDisks to list disk IDs for a gateway.
", + "Disk$DiskId": null, + "DiskIds$member": null, + "StorediSCSIVolume$VolumeDiskId": null + } + }, + "DiskIds": { + "base": null, + "refs": { + "AddCacheInput$DiskIds": null, + "AddUploadBufferInput$DiskIds": null, + "AddWorkingStorageInput$DiskIds": "An array of strings that identify disks that are to be configured as working storage. Each string have a minimum length of 1 and maximum length of 300. You can get the disk IDs from the ListLocalDisks API.
", + "DescribeCacheOutput$DiskIds": null, + "DescribeUploadBufferOutput$DiskIds": null, + "DescribeWorkingStorageOutput$DiskIds": "An array of the gateway's local disk IDs that are configured as working storage. Each local disk ID is specified as a string (minimum length of 1 and maximum length of 300). If no local disks are configured as working storage, then the DiskIds array is empty.
" + } + }, + "Disks": { + "base": null, + "refs": { + "ListLocalDisksOutput$Disks": null + } + }, + "DoubleObject": { + "base": null, + "refs": { + "CachediSCSIVolume$VolumeProgress": null, + "StorediSCSIVolume$VolumeProgress": null, + "Tape$Progress": "For archiving virtual tapes, indicates how much data remains to be uploaded before archiving is complete.
Range: 0 (not started) to 100 (complete).
" + } + }, + "ErrorCode": { + "base": null, + "refs": { + "StorageGatewayError$errorCode": "Additional information about the error.
" + } + }, + "GatewayARN": { + "base": "The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
", + "refs": { + "ActivateGatewayOutput$GatewayARN": null, + "AddCacheInput$GatewayARN": null, + "AddCacheOutput$GatewayARN": null, + "AddUploadBufferInput$GatewayARN": null, + "AddUploadBufferOutput$GatewayARN": null, + "AddWorkingStorageInput$GatewayARN": null, + "AddWorkingStorageOutput$GatewayARN": null, + "CancelArchivalInput$GatewayARN": null, + "CancelRetrievalInput$GatewayARN": null, + "CreateCachediSCSIVolumeInput$GatewayARN": null, + "CreateStorediSCSIVolumeInput$GatewayARN": null, + "CreateTapeWithBarcodeInput$GatewayARN": "The unique Amazon Resource Name (ARN) that represents the gateway to associate the virtual tape with. Use the ListGateways operation to return a list of gateways for your account and region.
", + "CreateTapesInput$GatewayARN": "The unique Amazon Resource Name (ARN) that represents the gateway to associate the virtual tapes with. Use the ListGateways operation to return a list of gateways for your account and region.
", + "DeleteBandwidthRateLimitInput$GatewayARN": null, + "DeleteBandwidthRateLimitOutput$GatewayARN": null, + "DeleteGatewayInput$GatewayARN": null, + "DeleteGatewayOutput$GatewayARN": null, + "DeleteTapeInput$GatewayARN": "The unique Amazon Resource Name (ARN) of the gateway that the virtual tape to delete is associated with. Use the ListGateways operation to return a list of gateways for your account and region.
", + "DescribeBandwidthRateLimitInput$GatewayARN": null, + "DescribeBandwidthRateLimitOutput$GatewayARN": null, + "DescribeCacheInput$GatewayARN": null, + "DescribeCacheOutput$GatewayARN": null, + "DescribeGatewayInformationInput$GatewayARN": null, + "DescribeGatewayInformationOutput$GatewayARN": null, + "DescribeMaintenanceStartTimeInput$GatewayARN": null, + "DescribeMaintenanceStartTimeOutput$GatewayARN": null, + "DescribeTapeRecoveryPointsInput$GatewayARN": null, + "DescribeTapeRecoveryPointsOutput$GatewayARN": null, + "DescribeTapesInput$GatewayARN": null, + "DescribeUploadBufferInput$GatewayARN": null, + "DescribeUploadBufferOutput$GatewayARN": null, + "DescribeVTLDevicesInput$GatewayARN": null, + "DescribeVTLDevicesOutput$GatewayARN": null, + "DescribeWorkingStorageInput$GatewayARN": null, + "DescribeWorkingStorageOutput$GatewayARN": null, + "DisableGatewayInput$GatewayARN": null, + "DisableGatewayOutput$GatewayARN": "The unique Amazon Resource Name of the disabled gateway.
", + "GatewayInfo$GatewayARN": "The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
", + "ListLocalDisksInput$GatewayARN": null, + "ListLocalDisksOutput$GatewayARN": null, + "ListVolumeRecoveryPointsInput$GatewayARN": null, + "ListVolumeRecoveryPointsOutput$GatewayARN": null, + "ListVolumesInput$GatewayARN": null, + "ListVolumesOutput$GatewayARN": null, + "ResetCacheInput$GatewayARN": null, + "ResetCacheOutput$GatewayARN": null, + "RetrieveTapeArchiveInput$GatewayARN": "The Amazon Resource Name (ARN) of the gateway you want to retrieve the virtual tape to. Use the ListGateways operation to return a list of gateways for your account and region.
You retrieve archived virtual tapes to only one gateway and the gateway must be a gateway-VTL.
", + "RetrieveTapeRecoveryPointInput$GatewayARN": null, + "SetLocalConsolePasswordInput$GatewayARN": null, + "SetLocalConsolePasswordOutput$GatewayARN": null, + "ShutdownGatewayInput$GatewayARN": null, + "ShutdownGatewayOutput$GatewayARN": null, + "StartGatewayInput$GatewayARN": null, + "StartGatewayOutput$GatewayARN": null, + "TapeArchive$RetrievedTo": "The Amazon Resource Name (ARN) of the gateway-VTL that the virtual tape is being retrieved to.
The virtual tape is retrieved from the virtual tape shelf (VTS).
", + "TapeInfo$GatewayARN": "The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
", + "UpdateBandwidthRateLimitInput$GatewayARN": null, + "UpdateBandwidthRateLimitOutput$GatewayARN": null, + "UpdateGatewayInformationInput$GatewayARN": null, + "UpdateGatewayInformationOutput$GatewayARN": null, + "UpdateGatewaySoftwareNowInput$GatewayARN": null, + "UpdateGatewaySoftwareNowOutput$GatewayARN": null, + "UpdateMaintenanceStartTimeInput$GatewayARN": null, + "UpdateMaintenanceStartTimeOutput$GatewayARN": null, + "VolumeInfo$GatewayARN": null + } + }, + "GatewayId": { + "base": null, + "refs": { + "DescribeGatewayInformationOutput$GatewayId": "The unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations.
", + "GatewayInfo$GatewayId": "The unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations.
", + "VolumeInfo$GatewayId": "The unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations.
Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).
" + } + }, + "GatewayInfo": { + "base": "Describes a gateway object.
", + "refs": { + "Gateways$member": null + } + }, + "GatewayName": { + "base": "The name you configured for your gateway.
", + "refs": { + "ActivateGatewayInput$GatewayName": "The name you configured for your gateway.
", + "UpdateGatewayInformationInput$GatewayName": null + } + }, + "GatewayNetworkInterfaces": { + "base": null, + "refs": { + "DescribeGatewayInformationOutput$GatewayNetworkInterfaces": "A NetworkInterface array that contains descriptions of the gateway network interfaces.
" + } + }, + "GatewayOperationalState": { + "base": null, + "refs": { + "GatewayInfo$GatewayOperationalState": "The state of the gateway.
Valid Values: DISABLED or ACTIVE
" + } + }, + "GatewayState": { + "base": null, + "refs": { + "DescribeGatewayInformationOutput$GatewayState": "A value that indicates the operating state of the gateway.
" + } + }, + "GatewayTimezone": { + "base": null, + "refs": { + "ActivateGatewayInput$GatewayTimezone": "A value that indicates the time zone you want to set for the gateway. The time zone is used, for example, for scheduling snapshots and your gateway's maintenance schedule.
", + "DescribeGatewayInformationOutput$GatewayTimezone": "A value that indicates the time zone configured for the gateway.
", + "DescribeMaintenanceStartTimeOutput$Timezone": null, + "DescribeSnapshotScheduleOutput$Timezone": null, + "UpdateGatewayInformationInput$GatewayTimezone": null + } + }, + "GatewayType": { + "base": null, + "refs": { + "ActivateGatewayInput$GatewayType": "A value that defines the type of gateway to activate. The type specified is critical to all later functions of the gateway and cannot be changed after activation. The default value is STORED.
The type of the gateway.
", + "GatewayInfo$GatewayType": "The type of the gateway.
" + } + }, + "Gateways": { + "base": null, + "refs": { + "ListGatewaysOutput$Gateways": null + } + }, + "HourOfDay": { + "base": null, + "refs": { + "DescribeMaintenanceStartTimeOutput$HourOfDay": null, + "DescribeSnapshotScheduleOutput$StartAt": null, + "UpdateMaintenanceStartTimeInput$HourOfDay": "The hour component of the maintenance start time represented as hh, where hh is the hour (00 to 23). The hour of the day is in the time zone of the gateway.
", + "UpdateSnapshotScheduleInput$StartAt": "The hour of the day at which the snapshot schedule begins represented as hh, where hh is the hour (0 to 23). The hour of the day is in the time zone of the gateway.
" + } + }, + "Initiator": { + "base": null, + "refs": { + "Initiators$member": null + } + }, + "Initiators": { + "base": null, + "refs": { + "ListVolumeInitiatorsOutput$Initiators": "The host names and port numbers of all iSCSI initiators that are connected to the gateway.
" + } + }, + "InternalServerError": { + "base": "An internal server error has occurred during the request. For more information, see the error and message fields.
", + "refs": { + } + }, + "InvalidGatewayRequestException": { + "base": "An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
", + "refs": { + } + }, + "IqnName": { + "base": null, + "refs": { + "ChapInfo$InitiatorName": "The iSCSI initiator that connects to the target.
", + "DeleteChapCredentialsInput$InitiatorName": "The iSCSI initiator that connects to the target.
", + "DeleteChapCredentialsOutput$InitiatorName": "The iSCSI initiator that connects to the target.
", + "UpdateChapCredentialsInput$InitiatorName": "The iSCSI initiator that connects to the target.
", + "UpdateChapCredentialsOutput$InitiatorName": "The iSCSI initiator that connects to the target. This is the same initiator name specified in the request.
" + } + }, + "LastSoftwareUpdate": { + "base": null, + "refs": { + "DescribeGatewayInformationOutput$LastSoftwareUpdate": "The date on which the last software update was applied to the gateway. If the gateway has never been updated, this field does not return a value in the response.
" + } + }, + "ListGatewaysInput": { + "base": "A JSON object containing zero or more of the following fields:
", + "refs": { + } + }, + "ListGatewaysOutput": { + "base": null, + "refs": { + } + }, + "ListLocalDisksInput": { + "base": "A JSON object containing the of the gateway.
", + "refs": { + } + }, + "ListLocalDisksOutput": { + "base": null, + "refs": { + } + }, + "ListTagsForResourceInput": { + "base": "ListTagsForResourceInput
", + "refs": { + } + }, + "ListTagsForResourceOutput": { + "base": "ListTagsForResourceOutput
", + "refs": { + } + }, + "ListTapesInput": { + "base": "A JSON object that contains one or more of the following fields:
", + "refs": { + } + }, + "ListTapesOutput": { + "base": "A JSON object containing the following fields:
", + "refs": { + } + }, + "ListVolumeInitiatorsInput": { + "base": "ListVolumeInitiatorsInput
", + "refs": { + } + }, + "ListVolumeInitiatorsOutput": { + "base": "ListVolumeInitiatorsOutput
", + "refs": { + } + }, + "ListVolumeRecoveryPointsInput": { + "base": null, + "refs": { + } + }, + "ListVolumeRecoveryPointsOutput": { + "base": null, + "refs": { + } + }, + "ListVolumesInput": { + "base": "A JSON object that contains one or more of the following fields:
", + "refs": { + } + }, + "ListVolumesOutput": { + "base": null, + "refs": { + } + }, + "LocalConsolePassword": { + "base": null, + "refs": { + "SetLocalConsolePasswordInput$LocalConsolePassword": "The password you want to set for your VM local console.
" + } + }, + "Marker": { + "base": null, + "refs": { + "DescribeTapeArchivesInput$Marker": "An opaque string that indicates the position at which to begin describing virtual tapes.
", + "DescribeTapeArchivesOutput$Marker": "An opaque string that indicates the position at which the virtual tapes that were fetched for description ended. Use this marker in your next request to fetch the next set of virtual tapes in the virtual tape shelf (VTS). If there are no more virtual tapes to describe, this field does not appear in the response.
", + "DescribeTapeRecoveryPointsInput$Marker": "An opaque string that indicates the position at which to begin describing the virtual tape recovery points.
", + "DescribeTapeRecoveryPointsOutput$Marker": "An opaque string that indicates the position at which the virtual tape recovery points that were listed for description ended.
Use this marker in your next request to list the next set of virtual tape recovery points in the list. If there are no more recovery points to describe, this field does not appear in the response.
", + "DescribeTapesInput$Marker": "A marker value, obtained in a previous call to DescribeTapes. This marker indicates which page of results to retrieve.
If not specified, the first page of results is retrieved.
", + "DescribeTapesOutput$Marker": "An opaque string which can be used as part of a subsequent DescribeTapes call to retrieve the next page of results.
If a response does not contain a marker, then there are no more results to be retrieved.
", + "DescribeVTLDevicesInput$Marker": "An opaque string that indicates the position at which to begin describing the VTL devices.
", + "DescribeVTLDevicesOutput$Marker": "An opaque string that indicates the position at which the VTL devices that were fetched for description ended. Use the marker in your next request to fetch the next set of VTL devices in the list. If there are no more VTL devices to describe, this field does not appear in the response.
", + "ListGatewaysInput$Marker": "An opaque string that indicates the position at which to begin the returned list of gateways.
", + "ListGatewaysOutput$Marker": null, + "ListTagsForResourceInput$Marker": "An opaque string that indicates the position at which to begin returning the list of tags.
", + "ListTagsForResourceOutput$Marker": "An opaque string that indicates the position at which to stop returning the list of tags.
", + "ListTapesInput$Marker": "A string that indicates the position at which to begin the returned list of tapes.
", + "ListTapesOutput$Marker": "A string that indicates the position at which to begin returning the next list of tapes. Use the marker in your next request to continue pagination of tapes. If there are no more tapes to list, this element does not appear in the response body.
", + "ListVolumesInput$Marker": "A string that indicates the position at which to begin the returned list of volumes. Obtain the marker from the response of a previous List iSCSI Volumes request.
", + "ListVolumesOutput$Marker": null + } + }, + "MediumChangerType": { + "base": null, + "refs": { + "ActivateGatewayInput$MediumChangerType": "The value that indicates the type of medium changer to use for gateway-VTL. This field is optional.
Valid Values: \"STK-L700\", \"AWS-Gateway-VTL\"
" + } + }, + "MinuteOfHour": { + "base": null, + "refs": { + "DescribeMaintenanceStartTimeOutput$MinuteOfHour": null, + "UpdateMaintenanceStartTimeInput$MinuteOfHour": "The minute component of the maintenance start time represented as mm, where mm is the minute (00 to 59). The minute of the hour is in the time zone of the gateway.
" + } + }, + "NetworkInterface": { + "base": "Describes a gateway's network interface.
", + "refs": { + "GatewayNetworkInterfaces$member": null + } + }, + "NetworkInterfaceId": { + "base": null, + "refs": { + "CreateCachediSCSIVolumeInput$NetworkInterfaceId": null, + "CreateStorediSCSIVolumeInput$NetworkInterfaceId": "The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use DescribeGatewayInformation to get a list of the network interfaces available on a gateway.
Valid Values: A valid IP address.
", + "DeviceiSCSIAttributes$NetworkInterfaceId": "The network interface identifier of the VTL device.
", + "VolumeiSCSIAttributes$NetworkInterfaceId": "The network interface identifier.
" + } + }, + "NextUpdateAvailabilityDate": { + "base": null, + "refs": { + "DescribeGatewayInformationOutput$NextUpdateAvailabilityDate": "The date on which an update to the gateway is available. This date is in the time zone of the gateway. If the gateway is not available for an update this field is not returned in the response.
" + } + }, + "NumTapesToCreate": { + "base": null, + "refs": { + "CreateTapesInput$NumTapesToCreate": "The number of virtual tapes that you want to create.
" + } + }, + "PositiveIntObject": { + "base": null, + "refs": { + "DescribeTapeArchivesInput$Limit": "Specifies that the number of virtual tapes descried be limited to the specified number.
", + "DescribeTapeRecoveryPointsInput$Limit": "Specifies that the number of virtual tape recovery points that are described be limited to the specified number.
", + "DescribeTapesInput$Limit": "Specifies that the number of virtual tapes described be limited to the specified number.
Amazon Web Services may impose its own limit, if this field is not set.
Specifies that the number of VTL devices described be limited to the specified number.
", + "ListGatewaysInput$Limit": "Specifies that the list of gateways returned be limited to the specified number of items.
", + "ListTagsForResourceInput$Limit": "Specifies that the list of tags returned be limited to the specified number of items.
", + "ListTapesInput$Limit": "An optional number limit for the tapes in the list returned by this call.
", + "ListVolumesInput$Limit": "Specifies that the list of volumes returned be limited to the specified number of items.
", + "VolumeiSCSIAttributes$LunNumber": "The logical disk number.
" + } + }, + "RecurrenceInHours": { + "base": null, + "refs": { + "DescribeSnapshotScheduleOutput$RecurrenceInHours": null, + "UpdateSnapshotScheduleInput$RecurrenceInHours": "Frequency of snapshots. Specify the number of hours between snapshots.
" + } + }, + "RegionId": { + "base": null, + "refs": { + "ActivateGatewayInput$GatewayRegion": "A value that indicates the region where you want to store the snapshot backups. The gateway region specified must be the same region as the region in your Host header in the request. For more information about available regions and endpoints for AWS Storage Gateway, see Regions and Endpoints in the Amazon Web Services Glossary.
Valid Values: \"us-east-1\", \"us-west-1\", \"us-west-2\", \"eu-west-1\", \"eu-central-1\", \"ap-northeast-1\", \"ap-northeast-2\", \"ap-southeast-1\", \"ap-southeast-2\", \"sa-east-1\"
" + } + }, + "RemoveTagsFromResourceInput": { + "base": "RemoveTagsFromResourceInput
", + "refs": { + } + }, + "RemoveTagsFromResourceOutput": { + "base": "RemoveTagsFromResourceOutput
", + "refs": { + } + }, + "ResetCacheInput": { + "base": null, + "refs": { + } + }, + "ResetCacheOutput": { + "base": null, + "refs": { + } + }, + "ResourceARN": { + "base": null, + "refs": { + "AddTagsToResourceInput$ResourceARN": "The Amazon Resource Name (ARN) of the resource you want to add tags to.
", + "AddTagsToResourceOutput$ResourceARN": "The Amazon Resource Name (ARN) of the resource you want to add tags to.
", + "ListTagsForResourceInput$ResourceARN": "The Amazon Resource Name (ARN) of the resource for which you want to list tags.
", + "ListTagsForResourceOutput$ResourceARN": "he Amazon Resource Name (ARN) of the resource for which you want to list tags.
", + "RemoveTagsFromResourceInput$ResourceARN": "The Amazon Resource Name (ARN) of the resource you want to remove the tags from.
", + "RemoveTagsFromResourceOutput$ResourceARN": "The Amazon Resource Name (ARN) of the resource that the tags were removed from.
" + } + }, + "RetrieveTapeArchiveInput": { + "base": "RetrieveTapeArchiveInput
", + "refs": { + } + }, + "RetrieveTapeArchiveOutput": { + "base": "RetrieveTapeArchiveOutput
", + "refs": { + } + }, + "RetrieveTapeRecoveryPointInput": { + "base": "RetrieveTapeRecoveryPointInput
", + "refs": { + } + }, + "RetrieveTapeRecoveryPointOutput": { + "base": "RetrieveTapeRecoveryPointOutput
", + "refs": { + } + }, + "SetLocalConsolePasswordInput": { + "base": "SetLocalConsolePasswordInput
", + "refs": { + } + }, + "SetLocalConsolePasswordOutput": { + "base": null, + "refs": { + } + }, + "ShutdownGatewayInput": { + "base": "A JSON object containing the of the gateway to shut down.
", + "refs": { + } + }, + "ShutdownGatewayOutput": { + "base": "A JSON object containing the of the gateway that was shut down.
", + "refs": { + } + }, + "SnapshotDescription": { + "base": null, + "refs": { + "CreateSnapshotFromVolumeRecoveryPointInput$SnapshotDescription": null, + "CreateSnapshotInput$SnapshotDescription": "Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the Description field, and in the AWS Storage Gateway snapshot Details pane, Description field
" + } + }, + "SnapshotId": { + "base": null, + "refs": { + "CachediSCSIVolume$SourceSnapshotId": null, + "CreateCachediSCSIVolumeInput$SnapshotId": null, + "CreateSnapshotFromVolumeRecoveryPointOutput$SnapshotId": null, + "CreateSnapshotOutput$SnapshotId": "The snapshot ID that is used to refer to the snapshot in future operations such as describing snapshots (Amazon Elastic Compute Cloud API DescribeSnapshots) or creating a volume from a snapshot (CreateStorediSCSIVolume).
The snapshot ID (e.g. \"snap-1122aabb\") of the snapshot to restore as the new stored volume. Specify this field if you want to create the iSCSI storage volume from a snapshot otherwise do not include this field. To list snapshots for your account use DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.
", + "StorediSCSIVolume$SourceSnapshotId": null + } + }, + "StartGatewayInput": { + "base": "A JSON object containing the of the gateway to start.
", + "refs": { + } + }, + "StartGatewayOutput": { + "base": "A JSON object containing the of the gateway that was restarted.
", + "refs": { + } + }, + "StorageGatewayError": { + "base": "Provides additional information about an error that was returned by the service as an or. See the errorCode and errorDetails members for more information about the error.
A StorageGatewayError that provides more information about the cause of the error.
", + "InvalidGatewayRequestException$error": "A StorageGatewayError that provides more detail about the cause of the error.
" + } + }, + "StorediSCSIVolume": { + "base": null, + "refs": { + "StorediSCSIVolumes$member": null + } + }, + "StorediSCSIVolumes": { + "base": null, + "refs": { + "DescribeStorediSCSIVolumesOutput$StorediSCSIVolumes": null + } + }, + "Tag": { + "base": null, + "refs": { + "Tags$member": null + } + }, + "TagKey": { + "base": null, + "refs": { + "Tag$Key": null, + "TagKeys$member": null + } + }, + "TagKeys": { + "base": null, + "refs": { + "RemoveTagsFromResourceInput$TagKeys": "The keys of the tags you want to remove from the specified resource. A tag is composed of a key/value pair.
" + } + }, + "TagValue": { + "base": null, + "refs": { + "Tag$Value": null + } + }, + "Tags": { + "base": null, + "refs": { + "AddTagsToResourceInput$Tags": "The key-value pair that represents the tag you want to add to the resource. The value can be an empty string.
Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @.
An array that contains the tags for the specified resource.
" + } + }, + "Tape": { + "base": "Describes a virtual tape object.
", + "refs": { + "Tapes$member": null + } + }, + "TapeARN": { + "base": null, + "refs": { + "CancelArchivalInput$TapeARN": "The Amazon Resource Name (ARN) of the virtual tape you want to cancel archiving for.
", + "CancelArchivalOutput$TapeARN": "The Amazon Resource Name (ARN) of the virtual tape for which archiving was canceled.
", + "CancelRetrievalInput$TapeARN": "The Amazon Resource Name (ARN) of the virtual tape you want to cancel retrieval for.
", + "CancelRetrievalOutput$TapeARN": "The Amazon Resource Name (ARN) of the virtual tape for which retrieval was canceled.
", + "CreateTapeWithBarcodeOutput$TapeARN": "A unique Amazon Resource Name (ARN) that represents the virtual tape that was created.
", + "DeleteTapeArchiveInput$TapeARN": "The Amazon Resource Name (ARN) of the virtual tape to delete from the virtual tape shelf (VTS).
", + "DeleteTapeArchiveOutput$TapeARN": "The Amazon Resource Name (ARN) of the virtual tape that was deleted from the virtual tape shelf (VTS).
", + "DeleteTapeInput$TapeARN": "The Amazon Resource Name (ARN) of the virtual tape to delete.
", + "DeleteTapeOutput$TapeARN": "The Amazon Resource Name (ARN) of the deleted virtual tape.
", + "RetrieveTapeArchiveInput$TapeARN": "The Amazon Resource Name (ARN) of the virtual tape you want to retrieve from the virtual tape shelf (VTS).
", + "RetrieveTapeArchiveOutput$TapeARN": "The Amazon Resource Name (ARN) of the retrieved virtual tape.
", + "RetrieveTapeRecoveryPointInput$TapeARN": "The Amazon Resource Name (ARN) of the virtual tape for which you want to retrieve the recovery point.
", + "RetrieveTapeRecoveryPointOutput$TapeARN": "The Amazon Resource Name (ARN) of the virtual tape for which the recovery point was retrieved.
", + "Tape$TapeARN": "The Amazon Resource Name (ARN) of the virtual tape.
", + "TapeARNs$member": null, + "TapeArchive$TapeARN": "The Amazon Resource Name (ARN) of an archived virtual tape.
", + "TapeInfo$TapeARN": "The Amazon Resource Name (ARN) of a virtual tape.
", + "TapeRecoveryPointInfo$TapeARN": "The Amazon Resource Name (ARN) of the virtual tape.
" + } + }, + "TapeARNs": { + "base": "The Amazon Resource Name (ARN) of each of the tapes you want to list. If you don't specify a tape ARN, the response lists all tapes in both your VTL and VTS.
", + "refs": { + "CreateTapesOutput$TapeARNs": "A list of unique Amazon Resource Names (ARNs) that represents the virtual tapes that were created.
", + "DescribeTapeArchivesInput$TapeARNs": "Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe.
", + "DescribeTapesInput$TapeARNs": "Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe. If this parameter is not specified, AWS Storage Gateway returns a description of all virtual tapes associated with the specified gateway.
", + "ListTapesInput$TapeARNs": null + } + }, + "TapeArchive": { + "base": "Represents a virtual tape that is archived in the virtual tape shelf (VTS).
", + "refs": { + "TapeArchives$member": null + } + }, + "TapeArchiveStatus": { + "base": null, + "refs": { + "TapeArchive$TapeStatus": "The current state of the archived virtual tape.
" + } + }, + "TapeArchives": { + "base": null, + "refs": { + "DescribeTapeArchivesOutput$TapeArchives": "An array of virtual tape objects in the virtual tape shelf (VTS). The description includes of the Amazon Resource Name(ARN) of the virtual tapes. The information returned includes the Amazon Resource Names (ARNs) of the tapes, size of the tapes, status of the tapes, progress of the description and tape barcode.
" + } + }, + "TapeBarcode": { + "base": null, + "refs": { + "CreateTapeWithBarcodeInput$TapeBarcode": "The barcode that you want to assign to the tape.
", + "Tape$TapeBarcode": "The barcode that identifies a specific virtual tape.
", + "TapeArchive$TapeBarcode": "The barcode that identifies the archived virtual tape.
", + "TapeInfo$TapeBarcode": "The barcode that identifies a specific virtual tape.
" + } + }, + "TapeBarcodePrefix": { + "base": null, + "refs": { + "CreateTapesInput$TapeBarcodePrefix": "A prefix that you append to the barcode of the virtual tape you are creating. This prefix makes the barcode unique.
The prefix must be 1 to 4 characters in length and must be one of the uppercase letters from A to Z.
The value that indicates the type of tape drive to use for gateway-VTL. This field is optional.
Valid Values: \"IBM-ULT3580-TD5\"
" + } + }, + "TapeInfo": { + "base": "Describes a virtual tape.
", + "refs": { + "TapeInfos$member": null + } + }, + "TapeInfos": { + "base": "An array of TapeInfo objects, where each object describes an a single tape. If there not tapes in the tape library or VTS, then the TapeInfos is an empty array.
Describes a recovery point.
", + "refs": { + "TapeRecoveryPointInfos$member": null + } + }, + "TapeRecoveryPointInfos": { + "base": null, + "refs": { + "DescribeTapeRecoveryPointsOutput$TapeRecoveryPointInfos": "An array of TapeRecoveryPointInfos that are available for the specified gateway.
" + } + }, + "TapeRecoveryPointStatus": { + "base": null, + "refs": { + "TapeRecoveryPointInfo$TapeStatus": null + } + }, + "TapeSize": { + "base": null, + "refs": { + "CreateTapeWithBarcodeInput$TapeSizeInBytes": "The size, in bytes, of the virtual tape that you want to create.
The size must be aligned by gigabyte (1024*1024*1024 byte).
The size, in bytes, of the virtual tapes that you want to create.
The size must be aligned by gigabyte (1024*1024*1024 byte).
The size, in bytes, of the virtual tape.
", + "TapeArchive$TapeSizeInBytes": "The size, in bytes, of the archived virtual tape.
", + "TapeInfo$TapeSizeInBytes": "The size, in bytes, of a virtual tape.
", + "TapeRecoveryPointInfo$TapeSizeInBytes": "The size, in bytes, of the virtual tapes to recover.
" + } + }, + "TapeStatus": { + "base": null, + "refs": { + "Tape$TapeStatus": "The current state of the virtual tape.
", + "TapeInfo$TapeStatus": "The status of the tape.
" + } + }, + "Tapes": { + "base": null, + "refs": { + "DescribeTapesOutput$Tapes": "An array of virtual tape descriptions.
" + } + }, + "TargetARN": { + "base": null, + "refs": { + "ChapInfo$TargetARN": "The Amazon Resource Name (ARN) of the volume.
Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).
", + "CreateCachediSCSIVolumeOutput$TargetARN": null, + "CreateStorediSCSIVolumeOutput$TargetARN": "he Amazon Resource Name (ARN) of the volume target that includes the iSCSI name that initiators can use to connect to the target.
", + "DeleteChapCredentialsInput$TargetARN": "The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified VolumeARN.
", + "DeleteChapCredentialsOutput$TargetARN": "The Amazon Resource Name (ARN) of the target.
", + "DescribeChapCredentialsInput$TargetARN": "The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified VolumeARN.
", + "DeviceiSCSIAttributes$TargetARN": "Specifies the unique Amazon Resource Name(ARN) that encodes the iSCSI qualified name(iqn) of a tape drive or media changer target.
", + "UpdateChapCredentialsInput$TargetARN": "The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return the TargetARN for specified VolumeARN.
", + "UpdateChapCredentialsOutput$TargetARN": "The Amazon Resource Name (ARN) of the target. This is the same target specified in the request.
", + "VolumeiSCSIAttributes$TargetARN": "The Amazon Resource Name (ARN) of the volume target.
" + } + }, + "TargetName": { + "base": null, + "refs": { + "CreateCachediSCSIVolumeInput$TargetName": null, + "CreateStorediSCSIVolumeInput$TargetName": "The name of the iSCSI target used by initiators to connect to the target and as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume. The target name must be unique across all volumes of a gateway.
The time that the archiving of the virtual tape was completed.
The string format of the completion time is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z' format.
", + "TapeRecoveryPointInfo$TapeRecoveryPointTime": "The time when the point-in-time view of the virtual tape was replicated for later recovery.
The string format of the tape recovery point time is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z' format.
" + } + }, + "UpdateBandwidthRateLimitInput": { + "base": "A JSON object containing one or more of the following fields:
UpdateBandwidthRateLimitInput$AverageDownloadRateLimitInBitsPerSec
UpdateBandwidthRateLimitInput$AverageUploadRateLimitInBitsPerSec
A JSON object containing the of the gateway whose throttle information was updated.
", + "refs": { + } + }, + "UpdateChapCredentialsInput": { + "base": "A JSON object containing one or more of the following fields:
A JSON object containing the following fields:
", + "refs": { + } + }, + "UpdateGatewayInformationInput": { + "base": null, + "refs": { + } + }, + "UpdateGatewayInformationOutput": { + "base": "A JSON object containing the ARN of the gateway that was updated.
", + "refs": { + } + }, + "UpdateGatewaySoftwareNowInput": { + "base": "A JSON object containing the of the gateway to update.
", + "refs": { + } + }, + "UpdateGatewaySoftwareNowOutput": { + "base": "A JSON object containing the of the gateway that was updated.
", + "refs": { + } + }, + "UpdateMaintenanceStartTimeInput": { + "base": "A JSON object containing the following fields:
A JSON object containing the of the gateway whose maintenance start time is updated.
", + "refs": { + } + }, + "UpdateSnapshotScheduleInput": { + "base": "A JSON object containing one or more of the following fields:
A JSON object containing the of the updated storage volume.
", + "refs": { + } + }, + "UpdateVTLDeviceTypeInput": { + "base": null, + "refs": { + } + }, + "UpdateVTLDeviceTypeOutput": { + "base": "UpdateVTLDeviceTypeOutput
", + "refs": { + } + }, + "VTLDevice": { + "base": "Represents a device object associated with a gateway-VTL.
", + "refs": { + "VTLDevices$member": null + } + }, + "VTLDeviceARN": { + "base": null, + "refs": { + "Tape$VTLDevice": "The virtual tape library (VTL) device that the virtual tape is associated with.
", + "UpdateVTLDeviceTypeInput$VTLDeviceARN": "The Amazon Resource Name (ARN) of the medium changer you want to select.
", + "UpdateVTLDeviceTypeOutput$VTLDeviceARN": "The Amazon Resource Name (ARN) of the medium changer you have selected.
", + "VTLDevice$VTLDeviceARN": "Specifies the unique Amazon Resource Name (ARN) of the device (tape drive or media changer).
", + "VTLDeviceARNs$member": null + } + }, + "VTLDeviceARNs": { + "base": null, + "refs": { + "DescribeVTLDevicesInput$VTLDeviceARNs": "An array of strings, where each string represents the Amazon Resource Name (ARN) of a VTL device.
All of the specified VTL devices must be from the same gateway. If no VTL devices are specified, the result will contain all devices on the specified gateway.
An array of VTL device objects composed of the Amazon Resource Name(ARN) of the VTL devices.
" + } + }, + "VolumeARN": { + "base": null, + "refs": { + "CachediSCSIVolume$VolumeARN": null, + "CreateCachediSCSIVolumeOutput$VolumeARN": null, + "CreateSnapshotFromVolumeRecoveryPointInput$VolumeARN": null, + "CreateSnapshotFromVolumeRecoveryPointOutput$VolumeARN": null, + "CreateSnapshotInput$VolumeARN": "The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.
", + "CreateSnapshotOutput$VolumeARN": "The Amazon Resource Name (ARN) of the volume of which the snapshot was taken.
", + "CreateStorediSCSIVolumeOutput$VolumeARN": "The Amazon Resource Name (ARN) of the configured volume.
", + "DeleteSnapshotScheduleInput$VolumeARN": null, + "DeleteSnapshotScheduleOutput$VolumeARN": null, + "DeleteVolumeInput$VolumeARN": "The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.
", + "DeleteVolumeOutput$VolumeARN": "The Amazon Resource Name (ARN) of the storage volume that was deleted. It is the same ARN you provided in the request.
", + "DescribeSnapshotScheduleInput$VolumeARN": "The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.
", + "DescribeSnapshotScheduleOutput$VolumeARN": null, + "ListVolumeInitiatorsInput$VolumeARN": "The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes for the gateway.
", + "StorediSCSIVolume$VolumeARN": null, + "UpdateSnapshotScheduleInput$VolumeARN": "The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.
", + "UpdateSnapshotScheduleOutput$VolumeARN": "", + "VolumeARNs$member": null, + "VolumeInfo$VolumeARN": "The Amazon Resource Name (ARN) for the storage volume. For example, the following is a valid ARN:
arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB
Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).
", + "VolumeRecoveryPointInfo$VolumeARN": null + } + }, + "VolumeARNs": { + "base": null, + "refs": { + "DescribeCachediSCSIVolumesInput$VolumeARNs": null, + "DescribeStorediSCSIVolumesInput$VolumeARNs": "An array of strings where each string represents the Amazon Resource Name (ARN) of a stored volume. All of the specified stored volumes must from the same gateway. Use ListVolumes to get volume ARNs for a gateway.
" + } + }, + "VolumeId": { + "base": null, + "refs": { + "CachediSCSIVolume$VolumeId": null, + "StorediSCSIVolume$VolumeId": null, + "VolumeInfo$VolumeId": "The unique identifier assigned to the volume. This ID becomes part of the volume Amazon Resource Name (ARN), which you use as input for other operations.
Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).
" + } + }, + "VolumeInfo": { + "base": "Describes a storage volume object.
", + "refs": { + "VolumeInfos$member": null + } + }, + "VolumeInfos": { + "base": null, + "refs": { + "ListVolumesOutput$VolumeInfos": null + } + }, + "VolumeRecoveryPointInfo": { + "base": null, + "refs": { + "VolumeRecoveryPointInfos$member": null + } + }, + "VolumeRecoveryPointInfos": { + "base": null, + "refs": { + "ListVolumeRecoveryPointsOutput$VolumeRecoveryPointInfos": null + } + }, + "VolumeStatus": { + "base": null, + "refs": { + "CachediSCSIVolume$VolumeStatus": null, + "StorediSCSIVolume$VolumeStatus": null + } + }, + "VolumeType": { + "base": null, + "refs": { + "CachediSCSIVolume$VolumeType": null, + "StorediSCSIVolume$VolumeType": null, + "VolumeInfo$VolumeType": null + } + }, + "VolumeiSCSIAttributes": { + "base": "Lists iSCSI information about a volume.
", + "refs": { + "CachediSCSIVolume$VolumeiSCSIAttributes": null, + "StorediSCSIVolume$VolumeiSCSIAttributes": null + } + }, + "boolean": { + "base": null, + "refs": { + "CreateStorediSCSIVolumeInput$PreserveExistingData": "Specify this field as true if you want to preserve the data on the local disk. Otherwise, specifying this field as false creates an empty volume.
Valid Values: true, false
", + "DeviceiSCSIAttributes$ChapEnabled": "Indicates whether mutual CHAP is enabled for the iSCSI target.
", + "StorediSCSIVolume$PreservedExistingData": null, + "VolumeiSCSIAttributes$ChapEnabled": "Indicates whether mutual CHAP is enabled for the iSCSI target.
" + } + }, + "double": { + "base": null, + "refs": { + "DescribeCacheOutput$CacheUsedPercentage": null, + "DescribeCacheOutput$CacheDirtyPercentage": null, + "DescribeCacheOutput$CacheHitPercentage": null, + "DescribeCacheOutput$CacheMissPercentage": null + } + }, + "errorDetails": { + "base": null, + "refs": { + "StorageGatewayError$errorDetails": "Human-readable text that provides detail about the error that occurred.
" + } + }, + "integer": { + "base": null, + "refs": { + "DeviceiSCSIAttributes$NetworkInterfacePort": "The port used to communicate with iSCSI VTL device targets.
", + "VolumeiSCSIAttributes$NetworkInterfacePort": "The port used to communicate with iSCSI targets.
" + } + }, + "long": { + "base": null, + "refs": { + "CachediSCSIVolume$VolumeSizeInBytes": null, + "CreateCachediSCSIVolumeInput$VolumeSizeInBytes": null, + "CreateStorediSCSIVolumeOutput$VolumeSizeInBytes": "The size of the volume in bytes.
", + "DescribeCacheOutput$CacheAllocatedInBytes": null, + "DescribeUploadBufferOutput$UploadBufferUsedInBytes": null, + "DescribeUploadBufferOutput$UploadBufferAllocatedInBytes": null, + "DescribeWorkingStorageOutput$WorkingStorageUsedInBytes": "The total working storage in bytes in use by the gateway. If no working storage is configured for the gateway, this field returns 0.
", + "DescribeWorkingStorageOutput$WorkingStorageAllocatedInBytes": "The total working storage in bytes allocated for the gateway. If no working storage is configured for the gateway, this field returns 0.
", + "Disk$DiskSizeInBytes": null, + "StorediSCSIVolume$VolumeSizeInBytes": null, + "VolumeInfo$VolumeSizeInBytes": "The size, in bytes, of the volume.
Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).
", + "VolumeRecoveryPointInfo$VolumeSizeInBytes": null, + "VolumeRecoveryPointInfo$VolumeUsageInBytes": null + } + }, + "string": { + "base": null, + "refs": { + "CreateSnapshotFromVolumeRecoveryPointOutput$VolumeRecoveryPointTime": null, + "DescribeGatewayInformationOutput$GatewayName": "The name you configured for your gateway.
", + "Disk$DiskPath": null, + "Disk$DiskNode": null, + "Disk$DiskStatus": null, + "Disk$DiskAllocationResource": null, + "GatewayInfo$GatewayName": "The name of the gateway.
", + "InternalServerError$message": "A human-readable message describing the error that occurred.
", + "InvalidGatewayRequestException$message": "A human-readable message describing the error that occurred.
", + "NetworkInterface$Ipv4Address": "The Internet Protocol version 4 (IPv4) address of the interface.
", + "NetworkInterface$MacAddress": "The Media Access Control (MAC) address of the interface.
This is currently unsupported and will not be returned in output.
The Internet Protocol version 6 (IPv6) address of the interface. Currently not supported.
", + "UpdateGatewayInformationOutput$GatewayName": null, + "VolumeRecoveryPointInfo$VolumeRecoveryPointTime": null, + "errorDetails$key": null, + "errorDetails$value": null + } + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/storagegateway/2013-06-30/examples-1.json b/vendor/github.com/aws/aws-sdk-go/models/apis/storagegateway/2013-06-30/examples-1.json new file mode 100644 index 000000000..0ea7e3b0b --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/storagegateway/2013-06-30/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/storagegateway/2013-06-30/paginators-1.json b/vendor/github.com/aws/aws-sdk-go/models/apis/storagegateway/2013-06-30/paginators-1.json new file mode 100644 index 000000000..286915c63 --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/storagegateway/2013-06-30/paginators-1.json @@ -0,0 +1,52 @@ +{ + "pagination": { + "DescribeCachediSCSIVolumes": { + "result_key": "CachediSCSIVolumes" + }, + "DescribeStorediSCSIVolumes": { + "result_key": "StorediSCSIVolumes" + }, + "DescribeTapeArchives": { + "input_token": "Marker", + "limit_key": "Limit", + "output_token": "Marker", + "result_key": "TapeArchives" + }, + "DescribeTapeRecoveryPoints": { + "input_token": "Marker", + "limit_key": "Limit", + "output_token": "Marker", + "result_key": "TapeRecoveryPointInfos" + }, + "DescribeTapes": { + "input_token": "Marker", + "limit_key": "Limit", + "output_token": "Marker", + "result_key": "Tapes" + }, + "DescribeVTLDevices": { + "input_token": "Marker", + "limit_key": "Limit", + "output_token": "Marker", + "result_key": "VTLDevices" + }, + "ListGateways": { + "input_token": "Marker", + "limit_key": "Limit", + "output_token": "Marker", + "result_key": "Gateways" + }, + "ListLocalDisks": { + "result_key": "Disks" + }, + "ListVolumeRecoveryPoints": { + "result_key": "VolumeRecoveryPointInfos" + }, + "ListVolumes": { + "input_token": "Marker", + "limit_key": "Limit", + "output_token": "Marker", + "result_key": "VolumeInfos" + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/streams.dynamodb/2012-08-10/api-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/streams.dynamodb/2012-08-10/api-2.json new file mode 100644 index 000000000..6c2839083 --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/streams.dynamodb/2012-08-10/api-2.json @@ -0,0 +1,397 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2012-08-10", + "endpointPrefix":"streams.dynamodb", + "jsonVersion":"1.0", + "protocol":"json", + "serviceFullName":"Amazon DynamoDB Streams", + "signatureVersion":"v4", + "signingName":"dynamodb", + "targetPrefix":"DynamoDBStreams_20120810" + }, + "operations":{ + "DescribeStream":{ + "name":"DescribeStream", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeStreamInput"}, + "output":{"shape":"DescribeStreamOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerError"} + ] + }, + "GetRecords":{ + "name":"GetRecords", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetRecordsInput"}, + "output":{"shape":"GetRecordsOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalServerError"}, + {"shape":"ExpiredIteratorException"}, + {"shape":"TrimmedDataAccessException"} + ] + }, + "GetShardIterator":{ + "name":"GetShardIterator", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetShardIteratorInput"}, + "output":{"shape":"GetShardIteratorOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerError"}, + {"shape":"TrimmedDataAccessException"} + ] + }, + "ListStreams":{ + "name":"ListStreams", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListStreamsInput"}, + "output":{"shape":"ListStreamsOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerError"} + ] + } + }, + "shapes":{ + "AttributeMap":{ + "type":"map", + "key":{"shape":"AttributeName"}, + "value":{"shape":"AttributeValue"} + }, + "AttributeName":{ + "type":"string", + "max":65535 + }, + "AttributeValue":{ + "type":"structure", + "members":{ + "S":{"shape":"StringAttributeValue"}, + "N":{"shape":"NumberAttributeValue"}, + "B":{"shape":"BinaryAttributeValue"}, + "SS":{"shape":"StringSetAttributeValue"}, + "NS":{"shape":"NumberSetAttributeValue"}, + "BS":{"shape":"BinarySetAttributeValue"}, + "M":{"shape":"MapAttributeValue"}, + "L":{"shape":"ListAttributeValue"}, + "NULL":{"shape":"NullAttributeValue"}, + "BOOL":{"shape":"BooleanAttributeValue"} + } + }, + "BinaryAttributeValue":{"type":"blob"}, + "BinarySetAttributeValue":{ + "type":"list", + "member":{"shape":"BinaryAttributeValue"} + }, + "BooleanAttributeValue":{"type":"boolean"}, + "Date":{"type":"timestamp"}, + "DescribeStreamInput":{ + "type":"structure", + "required":["StreamArn"], + "members":{ + "StreamArn":{"shape":"StreamArn"}, + "Limit":{"shape":"PositiveIntegerObject"}, + "ExclusiveStartShardId":{"shape":"ShardId"} + } + }, + "DescribeStreamOutput":{ + "type":"structure", + "members":{ + "StreamDescription":{"shape":"StreamDescription"} + } + }, + "ErrorMessage":{"type":"string"}, + "ExpiredIteratorException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true + }, + "GetRecordsInput":{ + "type":"structure", + "required":["ShardIterator"], + "members":{ + "ShardIterator":{"shape":"ShardIterator"}, + "Limit":{"shape":"PositiveIntegerObject"} + } + }, + "GetRecordsOutput":{ + "type":"structure", + "members":{ + "Records":{"shape":"RecordList"}, + "NextShardIterator":{"shape":"ShardIterator"} + } + }, + "GetShardIteratorInput":{ + "type":"structure", + "required":[ + "StreamArn", + "ShardId", + "ShardIteratorType" + ], + "members":{ + "StreamArn":{"shape":"StreamArn"}, + "ShardId":{"shape":"ShardId"}, + "ShardIteratorType":{"shape":"ShardIteratorType"}, + "SequenceNumber":{"shape":"SequenceNumber"} + } + }, + "GetShardIteratorOutput":{ + "type":"structure", + "members":{ + "ShardIterator":{"shape":"ShardIterator"} + } + }, + "InternalServerError":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true, + "fault":true + }, + "KeySchema":{ + "type":"list", + "member":{"shape":"KeySchemaElement"}, + "max":2, + "min":1 + }, + "KeySchemaAttributeName":{ + "type":"string", + "max":255, + "min":1 + }, + "KeySchemaElement":{ + "type":"structure", + "required":[ + "AttributeName", + "KeyType" + ], + "members":{ + "AttributeName":{"shape":"KeySchemaAttributeName"}, + "KeyType":{"shape":"KeyType"} + } + }, + "KeyType":{ + "type":"string", + "enum":[ + "HASH", + "RANGE" + ] + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true + }, + "ListAttributeValue":{ + "type":"list", + "member":{"shape":"AttributeValue"} + }, + "ListStreamsInput":{ + "type":"structure", + "members":{ + "TableName":{"shape":"TableName"}, + "Limit":{"shape":"PositiveIntegerObject"}, + "ExclusiveStartStreamArn":{"shape":"StreamArn"} + } + }, + "ListStreamsOutput":{ + "type":"structure", + "members":{ + "Streams":{"shape":"StreamList"}, + "LastEvaluatedStreamArn":{"shape":"StreamArn"} + } + }, + "MapAttributeValue":{ + "type":"map", + "key":{"shape":"AttributeName"}, + "value":{"shape":"AttributeValue"} + }, + "NullAttributeValue":{"type":"boolean"}, + "NumberAttributeValue":{"type":"string"}, + "NumberSetAttributeValue":{ + "type":"list", + "member":{"shape":"NumberAttributeValue"} + }, + "OperationType":{ + "type":"string", + "enum":[ + "INSERT", + "MODIFY", + "REMOVE" + ] + }, + "PositiveIntegerObject":{ + "type":"integer", + "min":1 + }, + "PositiveLongObject":{ + "type":"long", + "min":1 + }, + "Record":{ + "type":"structure", + "members":{ + "eventID":{"shape":"String"}, + "eventName":{"shape":"OperationType"}, + "eventVersion":{"shape":"String"}, + "eventSource":{"shape":"String"}, + "awsRegion":{"shape":"String"}, + "dynamodb":{"shape":"StreamRecord"} + } + }, + "RecordList":{ + "type":"list", + "member":{"shape":"Record"} + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true + }, + "SequenceNumber":{ + "type":"string", + "max":40, + "min":21 + }, + "SequenceNumberRange":{ + "type":"structure", + "members":{ + "StartingSequenceNumber":{"shape":"SequenceNumber"}, + "EndingSequenceNumber":{"shape":"SequenceNumber"} + } + }, + "Shard":{ + "type":"structure", + "members":{ + "ShardId":{"shape":"ShardId"}, + "SequenceNumberRange":{"shape":"SequenceNumberRange"}, + "ParentShardId":{"shape":"ShardId"} + } + }, + "ShardDescriptionList":{ + "type":"list", + "member":{"shape":"Shard"} + }, + "ShardId":{ + "type":"string", + "max":65, + "min":28 + }, + "ShardIterator":{ + "type":"string", + "max":2048, + "min":1 + }, + "ShardIteratorType":{ + "type":"string", + "enum":[ + "TRIM_HORIZON", + "LATEST", + "AT_SEQUENCE_NUMBER", + "AFTER_SEQUENCE_NUMBER" + ] + }, + "Stream":{ + "type":"structure", + "members":{ + "StreamArn":{"shape":"StreamArn"}, + "TableName":{"shape":"TableName"}, + "StreamLabel":{"shape":"String"} + } + }, + "StreamArn":{ + "type":"string", + "max":1024, + "min":37 + }, + "StreamDescription":{ + "type":"structure", + "members":{ + "StreamArn":{"shape":"StreamArn"}, + "StreamLabel":{"shape":"String"}, + "StreamStatus":{"shape":"StreamStatus"}, + "StreamViewType":{"shape":"StreamViewType"}, + "CreationRequestDateTime":{"shape":"Date"}, + "TableName":{"shape":"TableName"}, + "KeySchema":{"shape":"KeySchema"}, + "Shards":{"shape":"ShardDescriptionList"}, + "LastEvaluatedShardId":{"shape":"ShardId"} + } + }, + "StreamList":{ + "type":"list", + "member":{"shape":"Stream"} + }, + "StreamRecord":{ + "type":"structure", + "members":{ + "ApproximateCreationDateTime":{"shape":"Date"}, + "Keys":{"shape":"AttributeMap"}, + "NewImage":{"shape":"AttributeMap"}, + "OldImage":{"shape":"AttributeMap"}, + "SequenceNumber":{"shape":"SequenceNumber"}, + "SizeBytes":{"shape":"PositiveLongObject"}, + "StreamViewType":{"shape":"StreamViewType"} + } + }, + "StreamStatus":{ + "type":"string", + "enum":[ + "ENABLING", + "ENABLED", + "DISABLING", + "DISABLED" + ] + }, + "StreamViewType":{ + "type":"string", + "enum":[ + "NEW_IMAGE", + "OLD_IMAGE", + "NEW_AND_OLD_IMAGES", + "KEYS_ONLY" + ] + }, + "String":{"type":"string"}, + "StringAttributeValue":{"type":"string"}, + "StringSetAttributeValue":{ + "type":"list", + "member":{"shape":"StringAttributeValue"} + }, + "TableName":{ + "type":"string", + "max":255, + "min":3, + "pattern":"[a-zA-Z0-9_.-]+" + }, + "TrimmedDataAccessException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/streams.dynamodb/2012-08-10/docs-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/streams.dynamodb/2012-08-10/docs-2.json new file mode 100644 index 000000000..583c171b5 --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/streams.dynamodb/2012-08-10/docs-2.json @@ -0,0 +1,354 @@ +{ + "version": "2.0", + "service": "Amazon DynamoDB Streams provides API actions for accessing streams and processing stream records. To learn more about application development with Streams, see Capturing Table Activity with DynamoDB Streams in the Amazon DynamoDB Developer Guide.
The following are short descriptions of each low-level DynamoDB Streams action:
DescribeStream - Returns detailed information about a particular stream.
GetRecords - Retrieves the stream records from within a shard.
GetShardIterator - Returns information on how to retrieve the streams record from a shard with a given shard ID.
ListStreams - Returns a list of all the streams associated with the current AWS account and endpoint.
Returns information about a stream, including the current status of the stream, its Amazon Resource Name (ARN), the composition of its shards, and its corresponding DynamoDB table.
You can call DescribeStream at a maximum rate of 10 times per second.
Each shard in the stream has a SequenceNumberRange associated with it. If the SequenceNumberRange has a StartingSequenceNumber but no EndingSequenceNumber, then the shard is still open (able to receive more stream records). If both StartingSequenceNumber and EndingSequenceNumber are present, then that shard is closed and can no longer receive more data.
Retrieves the stream records from a given shard.
Specify a shard iterator using the ShardIterator parameter. The shard iterator specifies the position in the shard from which you want to start reading stream records sequentially. If there are no stream records available in the portion of the shard that the iterator points to, GetRecords returns an empty list. Note that it might take multiple calls to get to a portion of the shard that contains stream records.
GetRecords can retrieve a maximum of 1 MB of data or 1000 stream records, whichever comes first.
Returns a shard iterator. A shard iterator provides information about how to retrieve the stream records from within a shard. Use the shard iterator in a subsequent GetRecords request to read the stream records from the shard.
A shard iterator expires 15 minutes after it is returned to the requester.
Returns an array of stream ARNs associated with the current account and endpoint. If the TableName parameter is present, then ListStreams will return only the streams ARNs for that table.
You can call ListStreams at a maximum rate of 5 times per second.
The primary key attribute(s) for the DynamoDB item that was modified.
", + "StreamRecord$NewImage": "The item in the DynamoDB table as it appeared after it was modified.
", + "StreamRecord$OldImage": "The item in the DynamoDB table as it appeared before it was modified.
" + } + }, + "AttributeName": { + "base": null, + "refs": { + "AttributeMap$key": null, + "MapAttributeValue$key": null + } + }, + "AttributeValue": { + "base": "Represents the data for an attribute. You can set one, and only one, of the elements.
Each attribute in an item is a name-value pair. An attribute can be single-valued or multi-valued set. For example, a book item can have title and authors attributes. Each book has one title but can have many authors. The multi-valued attribute is a set; duplicate values are not allowed.
", + "refs": { + "AttributeMap$value": null, + "ListAttributeValue$member": null, + "MapAttributeValue$value": null + } + }, + "BinaryAttributeValue": { + "base": null, + "refs": { + "AttributeValue$B": "A Binary data type.
", + "BinarySetAttributeValue$member": null + } + }, + "BinarySetAttributeValue": { + "base": null, + "refs": { + "AttributeValue$BS": "A Binary Set data type.
" + } + }, + "BooleanAttributeValue": { + "base": null, + "refs": { + "AttributeValue$BOOL": "A Boolean data type.
" + } + }, + "Date": { + "base": null, + "refs": { + "StreamDescription$CreationRequestDateTime": "The date and time when the request to create this stream was issued.
", + "StreamRecord$ApproximateCreationDateTime": "The approximate date and time when the stream record was created, in UNIX epoch time format.
" + } + }, + "DescribeStreamInput": { + "base": "Represents the input of a DescribeStream operation.
", + "refs": { + } + }, + "DescribeStreamOutput": { + "base": "Represents the output of a DescribeStream operation.
", + "refs": { + } + }, + "ErrorMessage": { + "base": null, + "refs": { + "ExpiredIteratorException$message": "The provided iterator exceeds the maximum age allowed.
", + "InternalServerError$message": "The server encountered an internal error trying to fulfill the request.
", + "LimitExceededException$message": "Too many operations for a given subscriber.
", + "ResourceNotFoundException$message": "The resource which is being requested does not exist.
", + "TrimmedDataAccessException$message": "\"The data you are trying to access has been trimmed.
" + } + }, + "ExpiredIteratorException": { + "base": "The shard iterator has expired and can no longer be used to retrieve stream records. A shard iterator expires 15 minutes after it is retrieved using the GetShardIterator action.
", + "refs": { + } + }, + "GetRecordsInput": { + "base": "Represents the input of a GetRecords operation.
", + "refs": { + } + }, + "GetRecordsOutput": { + "base": "Represents the output of a GetRecords operation.
", + "refs": { + } + }, + "GetShardIteratorInput": { + "base": "Represents the input of a GetShardIterator operation.
", + "refs": { + } + }, + "GetShardIteratorOutput": { + "base": "Represents the output of a GetShardIterator operation.
", + "refs": { + } + }, + "InternalServerError": { + "base": "An error occurred on the server side.
", + "refs": { + } + }, + "KeySchema": { + "base": null, + "refs": { + "StreamDescription$KeySchema": "The key attribute(s) of the stream's DynamoDB table.
" + } + }, + "KeySchemaAttributeName": { + "base": null, + "refs": { + "KeySchemaElement$AttributeName": "The name of a key attribute.
" + } + }, + "KeySchemaElement": { + "base": "Represents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index.
A KeySchemaElement represents exactly one attribute of the primary key. For example, a simple primary key (partition key) would be represented by one KeySchemaElement. A composite primary key (partition key and sort key) would require one KeySchemaElement for the partition key, and another KeySchemaElement for the sort key.
The partition key of an item is also known as its hash attribute. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
The sort key of an item is also known as its range attribute. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
The attribute data, consisting of the data type and the attribute value itself.
" + } + }, + "LimitExceededException": { + "base": "Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.
", + "refs": { + } + }, + "ListAttributeValue": { + "base": null, + "refs": { + "AttributeValue$L": "A List data type.
" + } + }, + "ListStreamsInput": { + "base": "Represents the input of a ListStreams operation.
", + "refs": { + } + }, + "ListStreamsOutput": { + "base": "Represents the output of a ListStreams operation.
", + "refs": { + } + }, + "MapAttributeValue": { + "base": null, + "refs": { + "AttributeValue$M": "A Map data type.
" + } + }, + "NullAttributeValue": { + "base": null, + "refs": { + "AttributeValue$NULL": "A Null data type.
" + } + }, + "NumberAttributeValue": { + "base": null, + "refs": { + "AttributeValue$N": "A Number data type.
", + "NumberSetAttributeValue$member": null + } + }, + "NumberSetAttributeValue": { + "base": null, + "refs": { + "AttributeValue$NS": "A Number Set data type.
" + } + }, + "OperationType": { + "base": null, + "refs": { + "Record$eventName": "The type of data modification that was performed on the DynamoDB table:
INSERT - a new item was added to the table.
MODIFY - one or more of an existing item's attributes were modified.
REMOVE - the item was deleted from the table
The maximum number of shard objects to return. The upper limit is 100.
", + "GetRecordsInput$Limit": "The maximum number of records to return from the shard. The upper limit is 1000.
", + "ListStreamsInput$Limit": "The maximum number of streams to return. The upper limit is 100.
" + } + }, + "PositiveLongObject": { + "base": null, + "refs": { + "StreamRecord$SizeBytes": "The size of the stream record, in bytes.
" + } + }, + "Record": { + "base": "A description of a unique event within a stream.
", + "refs": { + "RecordList$member": null + } + }, + "RecordList": { + "base": null, + "refs": { + "GetRecordsOutput$Records": "The stream records from the shard, which were retrieved using the shard iterator.
" + } + }, + "ResourceNotFoundException": { + "base": "The operation tried to access a nonexistent stream.
", + "refs": { + } + }, + "SequenceNumber": { + "base": null, + "refs": { + "GetShardIteratorInput$SequenceNumber": "The sequence number of a stream record in the shard from which to start reading.
", + "SequenceNumberRange$StartingSequenceNumber": "The first sequence number.
", + "SequenceNumberRange$EndingSequenceNumber": "The last sequence number.
", + "StreamRecord$SequenceNumber": "The sequence number of the stream record.
" + } + }, + "SequenceNumberRange": { + "base": "The beginning and ending sequence numbers for the stream records contained within a shard.
", + "refs": { + "Shard$SequenceNumberRange": "The range of possible sequence numbers for the shard.
" + } + }, + "Shard": { + "base": "A uniquely identified group of stream records within a stream.
", + "refs": { + "ShardDescriptionList$member": null + } + }, + "ShardDescriptionList": { + "base": null, + "refs": { + "StreamDescription$Shards": "The shards that comprise the stream.
" + } + }, + "ShardId": { + "base": null, + "refs": { + "DescribeStreamInput$ExclusiveStartShardId": "The shard ID of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedShardId in the previous operation.
The identifier of the shard. The iterator will be returned for this shard ID.
", + "Shard$ShardId": "The system-generated identifier for this shard.
", + "Shard$ParentShardId": "The shard ID of the current shard's parent.
", + "StreamDescription$LastEvaluatedShardId": "The shard ID of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.
If LastEvaluatedShardId is empty, then the \"last page\" of results has been processed and there is currently no more data to be retrieved.
If LastEvaluatedShardId is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedShardId is empty.
A shard iterator that was retrieved from a previous GetShardIterator operation. This iterator can be used to access the stream records in this shard.
", + "GetRecordsOutput$NextShardIterator": "The next position in the shard from which to start sequentially reading stream records. If set to null, the shard has been closed and the requested iterator will not return any more data.
The position in the shard from which to start reading stream records sequentially. A shard iterator specifies this position using the sequence number of a stream record in a shard.
" + } + }, + "ShardIteratorType": { + "base": null, + "refs": { + "GetShardIteratorInput$ShardIteratorType": "Determines how the shard iterator is used to start reading stream records from the shard:
AT_SEQUENCE_NUMBER - Start reading exactly from the position denoted by a specific sequence number.
AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a specific sequence number.
TRIM_HORIZON - Start reading at the last (untrimmed) stream record, which is the oldest record in the shard. In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream.
LATEST - Start reading just after the most recent stream record in the shard, so that you always read the most recent data in the shard.
Represents all of the data describing a particular stream.
", + "refs": { + "StreamList$member": null + } + }, + "StreamArn": { + "base": null, + "refs": { + "DescribeStreamInput$StreamArn": "The Amazon Resource Name (ARN) for the stream.
", + "GetShardIteratorInput$StreamArn": "The Amazon Resource Name (ARN) for the stream.
", + "ListStreamsInput$ExclusiveStartStreamArn": "The ARN (Amazon Resource Name) of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedStreamArn in the previous operation.
The stream ARN of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.
If LastEvaluatedStreamArn is empty, then the \"last page\" of results has been processed and there is no more data to be retrieved.
If LastEvaluatedStreamArn is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedStreamArn is empty.
The Amazon Resource Name (ARN) for the stream.
", + "StreamDescription$StreamArn": "The Amazon Resource Name (ARN) for the stream.
" + } + }, + "StreamDescription": { + "base": "Represents all of the data describing a particular stream.
", + "refs": { + "DescribeStreamOutput$StreamDescription": "A complete description of the stream, including its creation date and time, the DynamoDB table associated with the stream, the shard IDs within the stream, and the beginning and ending sequence numbers of stream records within the shards.
" + } + }, + "StreamList": { + "base": null, + "refs": { + "ListStreamsOutput$Streams": "A list of stream descriptors associated with the current account and endpoint.
" + } + }, + "StreamRecord": { + "base": "A description of a single data modification that was performed on an item in a DynamoDB table.
", + "refs": { + "Record$dynamodb": "The main body of the stream record, containing all of the DynamoDB-specific fields.
" + } + }, + "StreamStatus": { + "base": null, + "refs": { + "StreamDescription$StreamStatus": "Indicates the current status of the stream:
ENABLING - Streams is currently being enabled on the DynamoDB table.
ENABLED - the stream is enabled.
DISABLING - Streams is currently being disabled on the DynamoDB table.
DISABLED - the stream is disabled.
Indicates the format of the records within this stream:
KEYS_ONLY - only the key attributes of items that were modified in the DynamoDB table.
NEW_IMAGE - entire items from the table, as they appeared after they were modified.
OLD_IMAGE - entire items from the table, as they appeared before they were modified.
NEW_AND_OLD_IMAGES - both the new and the old images of the items from the table.
The type of data from the modified DynamoDB item that was captured in this stream record:
KEYS_ONLY - only the key attributes of the modified item.
NEW_IMAGE - the entire item, as it appeared after it was modified.
OLD_IMAGE - the entire item, as it appeared before it was modified.
NEW_AND_OLD_IMAGES - both the new and the old item images of the item.
A globally unique identifier for the event that was recorded in this stream record.
", + "Record$eventVersion": "The version number of the stream record format. This number is updated whenever the structure of Record is modified.
Client applications must not assume that eventVersion will remain at a particular value, as this number is subject to change at any time. In general, eventVersion will only increase as the low-level DynamoDB Streams API evolves.
", + "Record$eventSource": "The AWS service from which the stream record originated. For DynamoDB Streams, this is aws:dynamodb.
", + "Record$awsRegion": "The region in which the GetRecords request was received.
", + "Stream$StreamLabel": "A timestamp, in ISO 8601 format, for this stream.
Note that LatestStreamLabel is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique:
the AWS customer ID.
the table name
the StreamLabel
A timestamp, in ISO 8601 format, for this stream.
Note that LatestStreamLabel is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique:
the AWS customer ID.
the table name
the StreamLabel
A String data type.
", + "StringSetAttributeValue$member": null + } + }, + "StringSetAttributeValue": { + "base": null, + "refs": { + "AttributeValue$SS": "A String Set data type.
" + } + }, + "TableName": { + "base": null, + "refs": { + "ListStreamsInput$TableName": "If this parameter is provided, then only the streams associated with this table name are returned.
", + "Stream$TableName": "The DynamoDB table with which the stream is associated.
", + "StreamDescription$TableName": "The DynamoDB table with which the stream is associated.
" + } + }, + "TrimmedDataAccessException": { + "base": "The operation attempted to read past the oldest stream record in a shard.
In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream. You might receive a TrimmedDataAccessException if:
You request a shard iterator with a sequence number older than the trim point (24 hours).
You obtain a shard iterator, but before you use the iterator in a GetRecords request, a stream record in the shard exceeds the 24 hour period and is trimmed. This causes the iterator to access a record that no longer exists.
The AWS Security Token Service (STS) is a web service that enables you to request temporary, limited-privilege credentials for AWS Identity and Access Management (IAM) users or for users that you authenticate (federated users). This guide provides descriptions of the STS API. For more detailed information about using this service, go to Temporary Security Credentials.
As an alternative to using the API, you can use one of the AWS SDKs, which consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to STS. For example, the SDKs take care of cryptographically signing requests, managing errors, and retrying requests automatically. For information about the AWS SDKs, including how to download and install them, see the Tools for Amazon Web Services page.
For information about setting up signatures and authorization through the API, go to Signing AWS API Requests in the AWS General Reference. For general information about the Query API, go to Making Query Requests in Using IAM. For information about using security tokens with other AWS products, go to AWS Services That Work with IAM in the IAM User Guide.
If you're new to AWS and need additional technical information about a specific AWS product, you can find the product's technical documentation at http://aws.amazon.com/documentation/.
Endpoints
The AWS Security Token Service (STS) has a default endpoint of https://sts.amazonaws.com that maps to the US East (N. Virginia) region. Additional regions are available and are activated by default. For more information, see Activating and Deactivating AWS STS in an AWS Region in the IAM User Guide.
For information about STS endpoints, see Regions and Endpoints in the AWS General Reference.
Recording API requests
STS supports AWS CloudTrail, which is a service that records AWS calls for your AWS account and delivers log files to an Amazon S3 bucket. By using information collected by CloudTrail, you can determine what requests were successfully made to STS, who made the request, when it was made, and so on. To learn more about CloudTrail, including how to turn it on and find your log files, see the AWS CloudTrail User Guide.
", + "operations": { + "AssumeRole": "Returns a set of temporary security credentials (consisting of an access key ID, a secret access key, and a security token) that you can use to access AWS resources that you might not normally have access to. Typically, you use AssumeRole for cross-account access or federation. For a comparison of AssumeRole with the other APIs that produce temporary credentials, see Requesting Temporary Security Credentials and Comparing the AWS STS APIs in the IAM User Guide.
Important: You cannot call AssumeRole by using AWS root account credentials; access is denied. You must use credentials for an IAM user or an IAM role to call AssumeRole.
For cross-account access, imagine that you own multiple accounts and need to access resources in each account. You could create long-term credentials in each account to access those resources. However, managing all those credentials and remembering which one can access which account can be time consuming. Instead, you can create one set of long-term credentials in one account and then use temporary security credentials to access all the other accounts by assuming roles in those accounts. For more information about roles, see IAM Roles (Delegation and Federation) in the IAM User Guide.
For federation, you can, for example, grant single sign-on access to the AWS Management Console. If you already have an identity and authentication system in your corporate network, you don't have to recreate user identities in AWS in order to grant those user identities access to AWS. Instead, after a user has been authenticated, you call AssumeRole (and specify the role with the appropriate permissions) to get temporary security credentials for that user. With those temporary security credentials, you construct a sign-in URL that users can use to access the console. For more information, see Common Scenarios for Temporary Credentials in the IAM User Guide.
The temporary security credentials are valid for the duration that you specified when calling AssumeRole, which can be from 900 seconds (15 minutes) to a maximum of 3600 seconds (1 hour). The default is 1 hour.
The temporary security credentials created by AssumeRole can be used to make API calls to any AWS service with the following exception: you cannot call the STS service's GetFederationToken or GetSessionToken APIs.
Optionally, you can pass an IAM access policy to this operation. If you choose not to pass a policy, the temporary security credentials that are returned by the operation have the permissions that are defined in the access policy of the role that is being assumed. If you pass a policy to this operation, the temporary security credentials that are returned by the operation have the permissions that are allowed by both the access policy of the role that is being assumed, and the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, see Permissions for AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity in the IAM User Guide.
To assume a role, your AWS account must be trusted by the role. The trust relationship is defined in the role's trust policy when the role is created. That trust policy states which accounts are allowed to delegate access to this account's role.
The user who wants to access the role must also have permissions delegated from the role's administrator. If the user is in a different account than the role, then the user's administrator must attach a policy that allows the user to call AssumeRole on the ARN of the role in the other account. If the user is in the same account as the role, then you can either attach a policy to the user (identical to the previous different account user), or you can add the user as a principal directly in the role's trust policy
Using MFA with AssumeRole
You can optionally include multi-factor authentication (MFA) information when you call AssumeRole. This is useful for cross-account scenarios in which you want to make sure that the user who is assuming the role has been authenticated using an AWS MFA device. In that scenario, the trust policy of the role being assumed includes a condition that tests for MFA authentication; if the caller does not include valid MFA information, the request to assume the role is denied. The condition in a trust policy that tests for MFA authentication might look like the following example.
\"Condition\": {\"Bool\": {\"aws:MultiFactorAuthPresent\": true}}
For more information, see Configuring MFA-Protected API Access in the IAM User Guide guide.
To use MFA with AssumeRole, you pass values for the SerialNumber and TokenCode parameters. The SerialNumber value identifies the user's hardware or virtual MFA device. The TokenCode is the time-based one-time password (TOTP) that the MFA devices produces.
Returns a set of temporary security credentials for users who have been authenticated via a SAML authentication response. This operation provides a mechanism for tying an enterprise identity store or directory to role-based AWS access without user-specific credentials or configuration. For a comparison of AssumeRoleWithSAML with the other APIs that produce temporary credentials, see Requesting Temporary Security Credentials and Comparing the AWS STS APIs in the IAM User Guide.
The temporary security credentials returned by this operation consist of an access key ID, a secret access key, and a security token. Applications can use these temporary security credentials to sign calls to AWS services.
The temporary security credentials are valid for the duration that you specified when calling AssumeRole, or until the time specified in the SAML authentication response's SessionNotOnOrAfter value, whichever is shorter. The duration can be from 900 seconds (15 minutes) to a maximum of 3600 seconds (1 hour). The default is 1 hour.
The temporary security credentials created by AssumeRoleWithSAML can be used to make API calls to any AWS service with the following exception: you cannot call the STS service's GetFederationToken or GetSessionToken APIs.
Optionally, you can pass an IAM access policy to this operation. If you choose not to pass a policy, the temporary security credentials that are returned by the operation have the permissions that are defined in the access policy of the role that is being assumed. If you pass a policy to this operation, the temporary security credentials that are returned by the operation have the permissions that are allowed by both the access policy of the role that is being assumed, and the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, see Permissions for AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity in the IAM User Guide.
Before your application can call AssumeRoleWithSAML, you must configure your SAML identity provider (IdP) to issue the claims required by AWS. Additionally, you must use AWS Identity and Access Management (IAM) to create a SAML provider entity in your AWS account that represents your identity provider, and create an IAM role that specifies this SAML provider in its trust policy.
Calling AssumeRoleWithSAML does not require the use of AWS security credentials. The identity of the caller is validated by using keys in the metadata document that is uploaded for the SAML provider entity for your identity provider.
Calling AssumeRoleWithSAML can result in an entry in your AWS CloudTrail logs. The entry includes the value in the NameID element of the SAML assertion. We recommend that you use a NameIDType that is not associated with any personally identifiable information (PII). For example, you could instead use the Persistent Identifier (urn:oasis:names:tc:SAML:2.0:nameid-format:persistent).
For more information, see the following resources:
About SAML 2.0-based Federation in the IAM User Guide.
Creating SAML Identity Providers in the IAM User Guide.
Configuring a Relying Party and Claims in the IAM User Guide.
Creating a Role for SAML 2.0 Federation in the IAM User Guide.
Returns a set of temporary security credentials for users who have been authenticated in a mobile or web application with a web identity provider, such as Amazon Cognito, Login with Amazon, Facebook, Google, or any OpenID Connect-compatible identity provider.
For mobile applications, we recommend that you use Amazon Cognito. You can use Amazon Cognito with the AWS SDK for iOS and the AWS SDK for Android to uniquely identify a user and supply the user with a consistent identity throughout the lifetime of an application.
To learn more about Amazon Cognito, see Amazon Cognito Overview in the AWS SDK for Android Developer Guide guide and Amazon Cognito Overview in the AWS SDK for iOS Developer Guide.
Calling AssumeRoleWithWebIdentity does not require the use of AWS security credentials. Therefore, you can distribute an application (for example, on mobile devices) that requests temporary security credentials without including long-term AWS credentials in the application, and without deploying server-based proxy services that use long-term AWS credentials. Instead, the identity of the caller is validated by using a token from the web identity provider. For a comparison of AssumeRoleWithWebIdentity with the other APIs that produce temporary credentials, see Requesting Temporary Security Credentials and Comparing the AWS STS APIs in the IAM User Guide.
The temporary security credentials returned by this API consist of an access key ID, a secret access key, and a security token. Applications can use these temporary security credentials to sign calls to AWS service APIs.
The credentials are valid for the duration that you specified when calling AssumeRoleWithWebIdentity, which can be from 900 seconds (15 minutes) to a maximum of 3600 seconds (1 hour). The default is 1 hour.
The temporary security credentials created by AssumeRoleWithWebIdentity can be used to make API calls to any AWS service with the following exception: you cannot call the STS service's GetFederationToken or GetSessionToken APIs.
Optionally, you can pass an IAM access policy to this operation. If you choose not to pass a policy, the temporary security credentials that are returned by the operation have the permissions that are defined in the access policy of the role that is being assumed. If you pass a policy to this operation, the temporary security credentials that are returned by the operation have the permissions that are allowed by both the access policy of the role that is being assumed, and the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, see Permissions for AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity in the IAM User Guide.
Before your application can call AssumeRoleWithWebIdentity, you must have an identity token from a supported identity provider and create a role that the application can assume. The role that your application assumes must trust the identity provider that is associated with the identity token. In other words, the identity provider must be specified in the role's trust policy.
Calling AssumeRoleWithWebIdentity can result in an entry in your AWS CloudTrail logs. The entry includes the Subject of the provided Web Identity Token. We recommend that you avoid using any personally identifiable information (PII) in this field. For example, you could instead use a GUID or a pairwise identifier, as suggested in the OIDC specification.
For more information about how to use web identity federation and the AssumeRoleWithWebIdentity API, see the following resources:
Using Web Identity Federation APIs for Mobile Apps and Federation Through a Web-based Identity Provider.
Web Identity Federation Playground. This interactive website lets you walk through the process of authenticating via Login with Amazon, Facebook, or Google, getting temporary security credentials, and then using those credentials to make a request to AWS.
AWS SDK for iOS and AWS SDK for Android. These toolkits contain sample apps that show how to invoke the identity providers, and then how to use the information from these providers to get and use temporary security credentials.
Web Identity Federation with Mobile Applications. This article discusses web identity federation and shows an example of how to use web identity federation to get access to content in Amazon S3.
Decodes additional information about the authorization status of a request from an encoded message returned in response to an AWS request.
For example, if a user is not authorized to perform an action that he or she has requested, the request returns a Client.UnauthorizedOperation response (an HTTP 403 response). Some AWS actions additionally return an encoded message that can provide details about this authorization failure.
Only certain AWS actions return an encoded authorization message. The documentation for an individual action indicates whether that action returns an encoded message in addition to returning an HTTP code.
The message is encoded because the details of the authorization status can constitute privileged information that the user who requested the action should not see. To decode an authorization status message, a user must be granted permissions via an IAM policy to request the DecodeAuthorizationMessage (sts:DecodeAuthorizationMessage) action.
The decoded message includes the following type of information:
Whether the request was denied due to an explicit deny or due to the absence of an explicit allow. For more information, see Determining Whether a Request is Allowed or Denied in the IAM User Guide.
The principal who made the request.
The requested action.
The requested resource.
The values of condition keys in the context of the user's request.
Returns details about the IAM identity whose credentials are used to call the API.
", + "GetFederationToken": "Returns a set of temporary security credentials (consisting of an access key ID, a secret access key, and a security token) for a federated user. A typical use is in a proxy application that gets temporary security credentials on behalf of distributed applications inside a corporate network. Because you must call the GetFederationToken action using the long-term security credentials of an IAM user, this call is appropriate in contexts where those credentials can be safely stored, usually in a server-based application. For a comparison of GetFederationToken with the other APIs that produce temporary credentials, see Requesting Temporary Security Credentials and Comparing the AWS STS APIs in the IAM User Guide.
If you are creating a mobile-based or browser-based app that can authenticate users using a web identity provider like Login with Amazon, Facebook, Google, or an OpenID Connect-compatible identity provider, we recommend that you use Amazon Cognito or AssumeRoleWithWebIdentity. For more information, see Federation Through a Web-based Identity Provider.
The GetFederationToken action must be called by using the long-term AWS security credentials of an IAM user. You can also call GetFederationToken using the security credentials of an AWS root account, but we do not recommended it. Instead, we recommend that you create an IAM user for the purpose of the proxy application and then attach a policy to the IAM user that limits federated users to only the actions and resources that they need access to. For more information, see IAM Best Practices in the IAM User Guide.
The temporary security credentials that are obtained by using the long-term credentials of an IAM user are valid for the specified duration, from 900 seconds (15 minutes) up to a maximium of 129600 seconds (36 hours). The default is 43200 seconds (12 hours). Temporary credentials that are obtained by using AWS root account credentials have a maximum duration of 3600 seconds (1 hour).
The temporary security credentials created by GetFederationToken can be used to make API calls to any AWS service with the following exceptions:
You cannot use these credentials to call any IAM APIs.
You cannot call any STS APIs.
Permissions
The permissions for the temporary security credentials returned by GetFederationToken are determined by a combination of the following:
The policy or policies that are attached to the IAM user whose credentials are used to call GetFederationToken.
The policy that is passed as a parameter in the call.
The passed policy is attached to the temporary security credentials that result from the GetFederationToken API call--that is, to the federated user. When the federated user makes an AWS request, AWS evaluates the policy attached to the federated user in combination with the policy or policies attached to the IAM user whose credentials were used to call GetFederationToken. AWS allows the federated user's request only when both the federated user and the IAM user are explicitly allowed to perform the requested action. The passed policy cannot grant more permissions than those that are defined in the IAM user policy.
A typical use case is that the permissions of the IAM user whose credentials are used to call GetFederationToken are designed to allow access to all the actions and resources that any federated user will need. Then, for individual users, you pass a policy to the operation that scopes down the permissions to a level that's appropriate to that individual user, using a policy that allows only a subset of permissions that are granted to the IAM user.
If you do not pass a policy, the resulting temporary security credentials have no effective permissions. The only exception is when the temporary security credentials are used to access a resource that has a resource-based policy that specifically allows the federated user to access the resource.
For more information about how permissions work, see Permissions for GetFederationToken. For information about using GetFederationToken to create temporary security credentials, see GetFederationToken—Federation Through a Custom Identity Broker.
Returns a set of temporary credentials for an AWS account or IAM user. The credentials consist of an access key ID, a secret access key, and a security token. Typically, you use GetSessionToken if you want to use MFA to protect programmatic calls to specific AWS APIs like Amazon EC2 StopInstances. MFA-enabled IAM users would need to call GetSessionToken and submit an MFA code that is associated with their MFA device. Using the temporary security credentials that are returned from the call, IAM users can then make programmatic calls to APIs that require MFA authentication. If you do not supply a correct MFA code, then the API returns an access denied error. For a comparison of GetSessionToken with the other APIs that produce temporary credentials, see Requesting Temporary Security Credentials and Comparing the AWS STS APIs in the IAM User Guide.
The GetSessionToken action must be called by using the long-term AWS security credentials of the AWS account or an IAM user. Credentials that are created by IAM users are valid for the duration that you specify, from 900 seconds (15 minutes) up to a maximum of 129600 seconds (36 hours), with a default of 43200 seconds (12 hours); credentials that are created by using account credentials can range from 900 seconds (15 minutes) up to a maximum of 3600 seconds (1 hour), with a default of 1 hour.
The temporary security credentials created by GetSessionToken can be used to make API calls to any AWS service with the following exceptions:
You cannot call any IAM APIs unless MFA authentication information is included in the request.
You cannot call any STS API except AssumeRole.
We recommend that you do not call GetSessionToken with root account credentials. Instead, follow our best practices by creating one or more IAM users, giving them the necessary permissions, and using IAM users for everyday interaction with AWS.
The permissions associated with the temporary security credentials returned by GetSessionToken are based on the permissions associated with account or IAM user whose credentials are used to call the action. If GetSessionToken is called using root account credentials, the temporary credentials have root account permissions. Similarly, if GetSessionToken is called using the credentials of an IAM user, the temporary credentials have the same permissions as the IAM user.
For more information about using GetSessionToken to create temporary credentials, go to Temporary Credentials for Users in Untrusted Environments in the IAM User Guide.
Contains the response to a successful AssumeRole request, including temporary AWS credentials that can be used to make AWS requests.
", + "refs": { + } + }, + "AssumeRoleWithSAMLRequest": { + "base": null, + "refs": { + } + }, + "AssumeRoleWithSAMLResponse": { + "base": "Contains the response to a successful AssumeRoleWithSAML request, including temporary AWS credentials that can be used to make AWS requests.
", + "refs": { + } + }, + "AssumeRoleWithWebIdentityRequest": { + "base": null, + "refs": { + } + }, + "AssumeRoleWithWebIdentityResponse": { + "base": "Contains the response to a successful AssumeRoleWithWebIdentity request, including temporary AWS credentials that can be used to make AWS requests.
", + "refs": { + } + }, + "AssumedRoleUser": { + "base": "The identifiers for the temporary security credentials that the operation returns.
", + "refs": { + "AssumeRoleResponse$AssumedRoleUser": "The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you can use to refer to the resulting temporary security credentials. For example, you can reference these credentials as a principal in a resource-based policy by using the ARN or assumed role ID. The ARN and ID include the RoleSessionName that you specified when you called AssumeRole.
The identifiers for the temporary security credentials that the operation returns.
", + "AssumeRoleWithWebIdentityResponse$AssumedRoleUser": "The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you can use to refer to the resulting temporary security credentials. For example, you can reference these credentials as a principal in a resource-based policy by using the ARN or assumed role ID. The ARN and ID include the RoleSessionName that you specified when you called AssumeRole.
The value of the Recipient attribute of the SubjectConfirmationData element of the SAML assertion.
The intended audience (also known as client ID) of the web identity token. This is traditionally the client identifier issued to the application that requested the web identity token.
" + } + }, + "Credentials": { + "base": "AWS credentials for API authentication.
", + "refs": { + "AssumeRoleResponse$Credentials": "The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.
Note: The size of the security token that STS APIs return is not fixed. We strongly recommend that you make no assumptions about the maximum size. As of this writing, the typical size is less than 4096 bytes, but that can vary. Also, future updates to AWS might require larger sizes.
", + "AssumeRoleWithSAMLResponse$Credentials": "The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.
Note: The size of the security token that STS APIs return is not fixed. We strongly recommend that you make no assumptions about the maximum size. As of this writing, the typical size is less than 4096 bytes, but that can vary. Also, future updates to AWS might require larger sizes.
", + "AssumeRoleWithWebIdentityResponse$Credentials": "The temporary security credentials, which include an access key ID, a secret access key, and a security token.
Note: The size of the security token that STS APIs return is not fixed. We strongly recommend that you make no assumptions about the maximum size. As of this writing, the typical size is less than 4096 bytes, but that can vary. Also, future updates to AWS might require larger sizes.
", + "GetFederationTokenResponse$Credentials": "The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.
Note: The size of the security token that STS APIs return is not fixed. We strongly recommend that you make no assumptions about the maximum size. As of this writing, the typical size is less than 4096 bytes, but that can vary. Also, future updates to AWS might require larger sizes.
", + "GetSessionTokenResponse$Credentials": "The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.
Note: The size of the security token that STS APIs return is not fixed. We strongly recommend that you make no assumptions about the maximum size. As of this writing, the typical size is less than 4096 bytes, but that can vary. Also, future updates to AWS might require larger sizes.
" + } + }, + "DecodeAuthorizationMessageRequest": { + "base": null, + "refs": { + } + }, + "DecodeAuthorizationMessageResponse": { + "base": "A document that contains additional information about the authorization status of a request from an encoded message that is returned in response to an AWS request.
", + "refs": { + } + }, + "ExpiredTokenException": { + "base": "The web identity token that was passed is expired or is not valid. Get a new identity token from the identity provider and then retry the request.
", + "refs": { + } + }, + "FederatedUser": { + "base": "Identifiers for the federated user that is associated with the credentials.
", + "refs": { + "GetFederationTokenResponse$FederatedUser": "Identifiers for the federated user associated with the credentials (such as arn:aws:sts::123456789012:federated-user/Bob or 123456789012:Bob). You can use the federated user's ARN in your resource-based policies, such as an Amazon S3 bucket policy.
Contains the response to a successful GetCallerIdentity request, including information about the entity making the request.
", + "refs": { + } + }, + "GetFederationTokenRequest": { + "base": null, + "refs": { + } + }, + "GetFederationTokenResponse": { + "base": "Contains the response to a successful GetFederationToken request, including temporary AWS credentials that can be used to make AWS requests.
", + "refs": { + } + }, + "GetSessionTokenRequest": { + "base": null, + "refs": { + } + }, + "GetSessionTokenResponse": { + "base": "Contains the response to a successful GetSessionToken request, including temporary AWS credentials that can be used to make AWS requests.
", + "refs": { + } + }, + "IDPCommunicationErrorException": { + "base": "The request could not be fulfilled because the non-AWS identity provider (IDP) that was asked to verify the incoming identity token could not be reached. This is often a transient error caused by network conditions. Retry the request a limited number of times so that you don't exceed the request rate. If the error persists, the non-AWS identity provider might be down or not responding.
", + "refs": { + } + }, + "IDPRejectedClaimException": { + "base": "The identity provider (IdP) reported that authentication failed. This might be because the claim is invalid.
If this error is returned for the AssumeRoleWithWebIdentity operation, it can also mean that the claim has expired or has been explicitly revoked.
The error returned if the message passed to DecodeAuthorizationMessage was invalid. This can happen if the token contains invalid characters, such as linebreaks.
The web identity token that was passed could not be validated by AWS. Get a new identity token from the identity provider and then retry the request.
", + "refs": { + } + }, + "Issuer": { + "base": null, + "refs": { + "AssumeRoleWithSAMLResponse$Issuer": "The value of the Issuer element of the SAML assertion.
The issuing authority of the web identity token presented. For OpenID Connect ID Tokens this contains the value of the iss field. For OAuth 2.0 access tokens, this contains the value of the ProviderId parameter that was passed in the AssumeRoleWithWebIdentity request.
The request was rejected because the policy document was malformed. The error message describes the specific error.
", + "refs": { + } + }, + "NameQualifier": { + "base": null, + "refs": { + "AssumeRoleWithSAMLResponse$NameQualifier": "A hash value based on the concatenation of the Issuer response value, the AWS account ID, and the friendly name (the last part of the ARN) of the SAML provider in IAM. The combination of NameQualifier and Subject can be used to uniquely identify a federated user.
The following pseudocode shows how the hash value is calculated:
BASE64 ( SHA1 ( \"https://example.com/saml\" + \"123456789012\" + \"/MySAMLIdP\" ) )
The request was rejected because the policy document was too large. The error message describes how big the policy document is, in packed form, as a percentage of what the API allows.
", + "refs": { + } + }, + "RegionDisabledException": { + "base": "STS is not activated in the requested region for the account that is being asked to generate credentials. The account administrator must use the IAM console to activate STS in that region. For more information, see Activating and Deactivating AWS STS in an AWS Region in the IAM User Guide.
", + "refs": { + } + }, + "SAMLAssertionType": { + "base": null, + "refs": { + "AssumeRoleWithSAMLRequest$SAMLAssertion": "The base-64 encoded SAML authentication response provided by the IdP.
For more information, see Configuring a Relying Party and Adding Claims in the Using IAM guide.
" + } + }, + "Subject": { + "base": null, + "refs": { + "AssumeRoleWithSAMLResponse$Subject": "The value of the NameID element in the Subject element of the SAML assertion.
The format of the name ID, as defined by the Format attribute in the NameID element of the SAML assertion. Typical examples of the format are transient or persistent.
If the format includes the prefix urn:oasis:names:tc:SAML:2.0:nameid-format, that prefix is removed. For example, urn:oasis:names:tc:SAML:2.0:nameid-format:transient is returned as transient. If the format includes any other prefix, the format is returned with no modifications.
The access key ID that identifies the temporary security credentials.
" + } + }, + "accessKeySecretType": { + "base": null, + "refs": { + "Credentials$SecretAccessKey": "The secret access key that can be used to sign requests.
" + } + }, + "accountType": { + "base": null, + "refs": { + "GetCallerIdentityResponse$Account": "The AWS account ID number of the account that owns or contains the calling entity.
" + } + }, + "arnType": { + "base": null, + "refs": { + "AssumeRoleRequest$RoleArn": "The Amazon Resource Name (ARN) of the role to assume.
", + "AssumeRoleWithSAMLRequest$RoleArn": "The Amazon Resource Name (ARN) of the role that the caller is assuming.
", + "AssumeRoleWithSAMLRequest$PrincipalArn": "The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP.
", + "AssumeRoleWithWebIdentityRequest$RoleArn": "The Amazon Resource Name (ARN) of the role that the caller is assuming.
", + "AssumedRoleUser$Arn": "The ARN of the temporary security credentials that are returned from the AssumeRole action. For more information about ARNs and how to use them in policies, see IAM Identifiers in Using IAM.
", + "FederatedUser$Arn": "The ARN that specifies the federated user that is associated with the credentials. For more information about ARNs and how to use them in policies, see IAM Identifiers in Using IAM.
", + "GetCallerIdentityResponse$Arn": "The AWS ARN associated with the calling entity.
" + } + }, + "assumedRoleIdType": { + "base": null, + "refs": { + "AssumedRoleUser$AssumedRoleId": "A unique identifier that contains the role ID and the role session name of the role that is being assumed. The role ID is generated by AWS when the role is created.
" + } + }, + "clientTokenType": { + "base": null, + "refs": { + "AssumeRoleWithWebIdentityRequest$WebIdentityToken": "The OAuth 2.0 access token or OpenID Connect ID token that is provided by the identity provider. Your application must get this token by authenticating the user who is using your application with a web identity provider before the application makes an AssumeRoleWithWebIdentity call.
The date on which the current credentials expire.
" + } + }, + "decodedMessageType": { + "base": null, + "refs": { + "DecodeAuthorizationMessageResponse$DecodedMessage": "An XML document that contains the decoded message.
" + } + }, + "durationSecondsType": { + "base": null, + "refs": { + "GetFederationTokenRequest$DurationSeconds": "The duration, in seconds, that the session should last. Acceptable durations for federation sessions range from 900 seconds (15 minutes) to 129600 seconds (36 hours), with 43200 seconds (12 hours) as the default. Sessions obtained using AWS account (root) credentials are restricted to a maximum of 3600 seconds (one hour). If the specified duration is longer than one hour, the session obtained by using AWS account (root) credentials defaults to one hour.
", + "GetSessionTokenRequest$DurationSeconds": "The duration, in seconds, that the credentials should remain valid. Acceptable durations for IAM user sessions range from 900 seconds (15 minutes) to 129600 seconds (36 hours), with 43200 seconds (12 hours) as the default. Sessions for AWS account owners are restricted to a maximum of 3600 seconds (one hour). If the duration is longer than one hour, the session for AWS account owners defaults to one hour.
" + } + }, + "encodedMessageType": { + "base": null, + "refs": { + "DecodeAuthorizationMessageRequest$EncodedMessage": "The encoded message that was returned with the response.
" + } + }, + "expiredIdentityTokenMessage": { + "base": null, + "refs": { + "ExpiredTokenException$message": null + } + }, + "externalIdType": { + "base": null, + "refs": { + "AssumeRoleRequest$ExternalId": "A unique identifier that is used by third parties when assuming roles in their customers' accounts. For each role that the third party can assume, they should instruct their customers to ensure the role's trust policy checks for the external ID that the third party generated. Each time the third party assumes the role, they should pass the customer's external ID. The external ID is useful in order to help third parties bind a role to the customer who created it. For more information about the external ID, see How to Use an External ID When Granting Access to Your AWS Resources to a Third Party in the IAM User Guide.
The format for this parameter, as described by its regex pattern, is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include any of the following characters: =,.@:\\/-
" + } + }, + "federatedIdType": { + "base": null, + "refs": { + "FederatedUser$FederatedUserId": "The string that identifies the federated user associated with the credentials, similar to the unique ID of an IAM user.
" + } + }, + "idpCommunicationErrorMessage": { + "base": null, + "refs": { + "IDPCommunicationErrorException$message": null + } + }, + "idpRejectedClaimMessage": { + "base": null, + "refs": { + "IDPRejectedClaimException$message": null + } + }, + "invalidAuthorizationMessage": { + "base": null, + "refs": { + "InvalidAuthorizationMessageException$message": null + } + }, + "invalidIdentityTokenMessage": { + "base": null, + "refs": { + "InvalidIdentityTokenException$message": null + } + }, + "malformedPolicyDocumentMessage": { + "base": null, + "refs": { + "MalformedPolicyDocumentException$message": null + } + }, + "nonNegativeIntegerType": { + "base": null, + "refs": { + "AssumeRoleResponse$PackedPolicySize": "A percentage value that indicates the size of the policy in packed form. The service rejects any policy with a packed size greater than 100 percent, which means the policy exceeded the allowed space.
", + "AssumeRoleWithSAMLResponse$PackedPolicySize": "A percentage value that indicates the size of the policy in packed form. The service rejects any policy with a packed size greater than 100 percent, which means the policy exceeded the allowed space.
", + "AssumeRoleWithWebIdentityResponse$PackedPolicySize": "A percentage value that indicates the size of the policy in packed form. The service rejects any policy with a packed size greater than 100 percent, which means the policy exceeded the allowed space.
", + "GetFederationTokenResponse$PackedPolicySize": "A percentage value indicating the size of the policy in packed form. The service rejects policies for which the packed size is greater than 100 percent of the allowed value.
" + } + }, + "packedPolicyTooLargeMessage": { + "base": null, + "refs": { + "PackedPolicyTooLargeException$message": null + } + }, + "regionDisabledMessage": { + "base": null, + "refs": { + "RegionDisabledException$message": null + } + }, + "roleDurationSecondsType": { + "base": null, + "refs": { + "AssumeRoleRequest$DurationSeconds": "The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds.
", + "AssumeRoleWithSAMLRequest$DurationSeconds": "The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds. An expiration can also be specified in the SAML authentication response's SessionNotOnOrAfter value. The actual expiration time is whichever value is shorter.
The maximum duration for a session is 1 hour, and the minimum duration is 15 minutes, even if values outside this range are specified.
The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds.
" + } + }, + "roleSessionNameType": { + "base": null, + "refs": { + "AssumeRoleRequest$RoleSessionName": "An identifier for the assumed role session.
Use the role session name to uniquely identify a session when the same role is assumed by different principals or for different reasons. In cross-account scenarios, the role session name is visible to, and can be logged by the account that owns the role. The role session name is also used in the ARN of the assumed role principal. This means that subsequent cross-account API requests using the temporary security credentials will expose the role session name to the external account in their CloudTrail logs.
The format for this parameter, as described by its regex pattern, is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "AssumeRoleWithWebIdentityRequest$RoleSessionName": "An identifier for the assumed role session. Typically, you pass the name or identifier that is associated with the user who is using your application. That way, the temporary security credentials that your application will use are associated with that user. This session name is included as part of the ARN and assumed role ID in the AssumedRoleUser response element.
The format for this parameter, as described by its regex pattern, is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
" + } + }, + "serialNumberType": { + "base": null, + "refs": { + "AssumeRoleRequest$SerialNumber": "The identification number of the MFA device that is associated with the user who is making the AssumeRole call. Specify this value if the trust policy of the role being assumed includes a condition that requires MFA authentication. The value is either the serial number for a hardware device (such as GAHT12345678) or an Amazon Resource Name (ARN) for a virtual device (such as arn:aws:iam::123456789012:mfa/user).
The format for this parameter, as described by its regex pattern, is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
", + "GetSessionTokenRequest$SerialNumber": "The identification number of the MFA device that is associated with the IAM user who is making the GetSessionToken call. Specify this value if the IAM user has a policy that requires MFA authentication. The value is either the serial number for a hardware device (such as GAHT12345678) or an Amazon Resource Name (ARN) for a virtual device (such as arn:aws:iam::123456789012:mfa/user). You can find the device for an IAM user by going to the AWS Management Console and viewing the user's security credentials.
The format for this parameter, as described by its regex pattern, is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
" + } + }, + "sessionPolicyDocumentType": { + "base": null, + "refs": { + "AssumeRoleRequest$Policy": "An IAM policy in JSON format.
This parameter is optional. If you pass a policy, the temporary security credentials that are returned by the operation have the permissions that are allowed by both (the intersection of) the access policy of the role that is being assumed, and the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, see Permissions for AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity in the IAM User Guide.
The format for this parameter, as described by its regex pattern, is a string of characters up to 2048 characters in length. The characters can be any ASCII character from the space character to the end of the valid character list (\\u0020-\\u00FF). It can also include the tab (\\u0009), linefeed (\\u000A), and carriage return (\\u000D) characters.
The policy plain text must be 2048 bytes or shorter. However, an internal conversion compresses it into a packed binary format with a separate limit. The PackedPolicySize response element indicates by percentage how close to the upper size limit the policy is, with 100% equaling the maximum allowed size.
An IAM policy in JSON format.
The policy parameter is optional. If you pass a policy, the temporary security credentials that are returned by the operation have the permissions that are allowed by both the access policy of the role that is being assumed, and the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, Permissions for AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity in the IAM User Guide.
The format for this parameter, as described by its regex pattern, is a string of characters up to 2048 characters in length. The characters can be any ASCII character from the space character to the end of the valid character list (\\u0020-\\u00FF). It can also include the tab (\\u0009), linefeed (\\u000A), and carriage return (\\u000D) characters.
The policy plain text must be 2048 bytes or shorter. However, an internal conversion compresses it into a packed binary format with a separate limit. The PackedPolicySize response element indicates by percentage how close to the upper size limit the policy is, with 100% equaling the maximum allowed size.
An IAM policy in JSON format.
The policy parameter is optional. If you pass a policy, the temporary security credentials that are returned by the operation have the permissions that are allowed by both the access policy of the role that is being assumed, and the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, see Permissions for AssumeRoleWithWebIdentity in the IAM User Guide.
The format for this parameter, as described by its regex pattern, is a string of characters up to 2048 characters in length. The characters can be any ASCII character from the space character to the end of the valid character list (\\u0020-\\u00FF). It can also include the tab (\\u0009), linefeed (\\u000A), and carriage return (\\u000D) characters.
The policy plain text must be 2048 bytes or shorter. However, an internal conversion compresses it into a packed binary format with a separate limit. The PackedPolicySize response element indicates by percentage how close to the upper size limit the policy is, with 100% equaling the maximum allowed size.
An IAM policy in JSON format that is passed with the GetFederationToken call and evaluated along with the policy or policies that are attached to the IAM user whose credentials are used to call GetFederationToken. The passed policy is used to scope down the permissions that are available to the IAM user, by allowing only a subset of the permissions that are granted to the IAM user. The passed policy cannot grant more permissions than those granted to the IAM user. The final permissions for the federated user are the most restrictive set based on the intersection of the passed policy and the IAM user policy.
If you do not pass a policy, the resulting temporary security credentials have no effective permissions. The only exception is when the temporary security credentials are used to access a resource that has a resource-based policy that specifically allows the federated user to access the resource.
The format for this parameter, as described by its regex pattern, is a string of characters up to 2048 characters in length. The characters can be any ASCII character from the space character to the end of the valid character list (\\u0020-\\u00FF). It can also include the tab (\\u0009), linefeed (\\u000A), and carriage return (\\u000D) characters.
The policy plain text must be 2048 bytes or shorter. However, an internal conversion compresses it into a packed binary format with a separate limit. The PackedPolicySize response element indicates by percentage how close to the upper size limit the policy is, with 100% equaling the maximum allowed size.
For more information about how permissions work, see Permissions for GetFederationToken.
" + } + }, + "tokenCodeType": { + "base": null, + "refs": { + "AssumeRoleRequest$TokenCode": "The value provided by the MFA device, if the trust policy of the role being assumed requires MFA (that is, if the policy includes a condition that tests for MFA). If the role being assumed requires MFA and if the TokenCode value is missing or expired, the AssumeRole call returns an \"access denied\" error.
The format for this parameter, as described by its regex pattern, is a sequence of six numeric digits.
", + "GetSessionTokenRequest$TokenCode": "The value provided by the MFA device, if MFA is required. If any policy requires the IAM user to submit an MFA code, specify this value. If MFA authentication is required, and the user does not provide a code when requesting a set of temporary security credentials, the user will receive an \"access denied\" response when requesting resources that require MFA authentication.
The format for this parameter, as described by its regex pattern, is a sequence of six numeric digits.
" + } + }, + "tokenType": { + "base": null, + "refs": { + "Credentials$SessionToken": "The token that users must pass to the service API to use the temporary credentials.
" + } + }, + "urlType": { + "base": null, + "refs": { + "AssumeRoleWithWebIdentityRequest$ProviderId": "The fully qualified host component of the domain name of the identity provider.
Specify this value only for OAuth 2.0 access tokens. Currently www.amazon.com and graph.facebook.com are the only supported identity providers for OAuth 2.0 access tokens. Do not include URL schemes and port numbers.
Do not specify this value for OpenID Connect ID tokens.
" + } + }, + "userIdType": { + "base": null, + "refs": { + "GetCallerIdentityResponse$UserId": "The unique identifier of the calling entity. The exact value depends on the type of entity making the call. The values returned are those listed in the aws:userid column in the Principal table found on the Policy Variables reference page in the IAM User Guide.
" + } + }, + "userNameType": { + "base": null, + "refs": { + "GetFederationTokenRequest$Name": "The name of the federated user. The name is used as an identifier for the temporary security credentials (such as Bob). For example, you can reference the federated user name in a resource-based policy, such as in an Amazon S3 bucket policy.
The format for this parameter, as described by its regex pattern, is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
" + } + }, + "webIdentitySubjectType": { + "base": null, + "refs": { + "AssumeRoleWithWebIdentityResponse$SubjectFromWebIdentityToken": "The unique user identifier that is returned by the identity provider. This identifier is associated with the WebIdentityToken that was submitted with the AssumeRoleWithWebIdentity call. The identifier is typically unique to the user and the application that acquired the WebIdentityToken (pairwise identifier). For OpenID Connect ID tokens, this field contains the value returned by the identity provider as the token's sub (Subject) claim.
Adds one or more attachments to an attachment set. If an AttachmentSetId is not specified, a new attachment set is created, and the ID of the set is returned in the response. If an AttachmentSetId is specified, the attachments are added to the specified set, if it exists.
An attachment set is a temporary container for attachments that are to be added to a case or case communication. The set is available for one hour after it is created; the ExpiryTime returned in the response indicates when the set expires. The maximum number of attachments in a set is 3, and the maximum size of any attachment in the set is 5 MB.
Adds additional customer communication to an AWS Support case. You use the CaseId value to identify the case to add communication to. You can list a set of email addresses to copy on the communication using the CcEmailAddresses value. The CommunicationBody value contains the text of the communication.
The response indicates the success or failure of the request.
This operation implements a subset of the features of the AWS Support Center.
", + "CreateCase": "Creates a new case in the AWS Support Center. This operation is modeled on the behavior of the AWS Support Center Create Case page. Its parameters require you to specify the following information:
ServiceCode by calling DescribeServices. ServiceCode value. You also obtain the category code for a service by calling DescribeServices. Each AWS service defines its own set of category codes. To add additional communication or attachments to an existing case, use AddCommunicationToCase.
A successful CreateCase request returns an AWS Support case number. Case numbers are used by the DescribeCases operation to retrieve existing AWS Support cases.
", + "DescribeAttachment": "Returns the attachment that has the specified ID. Attachment IDs are generated by the case management system when you add an attachment to a case or case communication. Attachment IDs are returned in the AttachmentDetails objects that are returned by the DescribeCommunications operation.
", + "DescribeCases": "Returns a list of cases that you specify by passing one or more case IDs. In addition, you can filter the cases by date by setting values for the AfterTime and BeforeTime request parameters. You can set values for the IncludeResolvedCases and IncludeCommunications request parameters to control how much information is returned.
Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request for data might cause an error.
The response returns the following in JSON format:
NextToken values, which specify where to paginate the returned records represented by the CaseDetails objects.Returns communications (and attachments) for one or more support cases. You can use the AfterTime and BeforeTime parameters to filter by date. You can use the CaseId parameter to restrict the results to a particular case.
Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request for data might cause an error.
You can use the MaxResults and NextToken parameters to control the pagination of the result set. Set MaxResults to the number of cases you want displayed on each page, and use NextToken to specify the resumption of pagination.
Returns the current list of AWS services and a list of service categories that applies to each one. You then use service names and categories in your CreateCase requests. Each AWS service has its own set of categories.
The service codes and category codes correspond to the values that are displayed in the Service and Category drop-down lists on the AWS Support Center Create Case page. The values in those fields, however, do not necessarily match the service codes and categories returned by the DescribeServices request. Always use the service codes and categories obtained programmatically. This practice ensures that you always have the most recent set of service and category codes.
Returns the list of severity levels that you can assign to an AWS Support case. The severity level for a case is also a field in the CaseDetails data type included in any CreateCase request.
", + "DescribeTrustedAdvisorCheckRefreshStatuses": "Returns the refresh status of the Trusted Advisor checks that have the specified check IDs. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.
", + "DescribeTrustedAdvisorCheckResult": "Returns the results of the Trusted Advisor check that has the specified check ID. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.
The response contains a TrustedAdvisorCheckResult object, which contains these three objects:
In addition, the response contains these fields:
Returns the summaries of the results of the Trusted Advisor checks that have the specified check IDs. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.
The response contains an array of TrustedAdvisorCheckSummary objects.
", + "DescribeTrustedAdvisorChecks": "Returns information about all available Trusted Advisor checks, including name, ID, category, description, and metadata. You must specify a language code; English (\"en\") and Japanese (\"ja\") are currently supported. The response contains a TrustedAdvisorCheckDescription for each check.
", + "RefreshTrustedAdvisorCheck": "Requests a refresh of the Trusted Advisor check that has the specified check ID. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.
The response contains a TrustedAdvisorCheckRefreshStatus object, which contains these fields:
Takes a CaseId and returns the initial state of the case along with the state of the case after the call to ResolveCase completed.
The AWS Support API reference is intended for programmers who need detailed information about the AWS Support operations and data types. This service enables you to manage your AWS Support cases programmatically. It uses HTTP methods that return results in JSON format.
The AWS Support service also exposes a set of Trusted Advisor features. You can retrieve a list of checks and their descriptions, get check results, specify checks to refresh, and get the refresh status of checks.
The following list describes the AWS Support case management operations:
The following list describes the operations available from the AWS Support service for Trusted Advisor:
CheckId for a specific check returned by DescribeTrustedAdvisorChecks, you can call DescribeTrustedAdvisorCheckResult to obtain the results for the check you specified.For authentication of requests, AWS Support uses Signature Version 4 Signing Process.
See About the AWS Support API in the AWS Support User Guide for information about how to use this service to create and manage your support cases, and how to call Trusted Advisor for results of checks on your resources.
", + "shapes": { + "AddAttachmentsToSetRequest": { + "base": null, + "refs": { + } + }, + "AddAttachmentsToSetResponse": { + "base": "The ID and expiry time of the attachment set returned by the AddAttachmentsToSet operation.
", + "refs": { + } + }, + "AddCommunicationToCaseRequest": { + "base": "To be written.
", + "refs": { + } + }, + "AddCommunicationToCaseResponse": { + "base": "The result of the AddCommunicationToCase operation.
", + "refs": { + } + }, + "AfterTime": { + "base": null, + "refs": { + "DescribeCasesRequest$afterTime": "The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
", + "DescribeCommunicationsRequest$afterTime": "The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
" + } + }, + "Attachment": { + "base": "An attachment to a case communication. The attachment consists of the file name and the content of the file.
", + "refs": { + "Attachments$member": null, + "DescribeAttachmentResponse$attachment": "The attachment content and file name.
" + } + }, + "AttachmentDetails": { + "base": "The file name and ID of an attachment to a case communication. You can use the ID to retrieve the attachment with the DescribeAttachment operation.
", + "refs": { + "AttachmentSet$member": null + } + }, + "AttachmentId": { + "base": null, + "refs": { + "AttachmentDetails$attachmentId": "The ID of the attachment.
", + "DescribeAttachmentRequest$attachmentId": "The ID of the attachment to return. Attachment IDs are returned by the DescribeCommunications operation.
" + } + }, + "AttachmentIdNotFound": { + "base": "An attachment with the specified ID could not be found.
", + "refs": { + } + }, + "AttachmentLimitExceeded": { + "base": "The limit for the number of attachment sets created in a short period of time has been exceeded.
", + "refs": { + } + }, + "AttachmentSet": { + "base": null, + "refs": { + "Communication$attachmentSet": "Information about the attachments to the case communication.
" + } + }, + "AttachmentSetExpired": { + "base": "The expiration time of the attachment set has passed. The set expires 1 hour after it is created.
", + "refs": { + } + }, + "AttachmentSetId": { + "base": null, + "refs": { + "AddAttachmentsToSetRequest$attachmentSetId": "The ID of the attachment set. If an AttachmentSetId is not specified, a new attachment set is created, and the ID of the set is returned in the response. If an AttachmentSetId is specified, the attachments are added to the specified set, if it exists.
The ID of the attachment set. If an AttachmentSetId was not specified, a new attachment set is created, and the ID of the set is returned in the response. If an AttachmentSetId was specified, the attachments are added to the specified set, if it exists.
The ID of a set of one or more attachments for the communication to add to the case. Create the set by calling AddAttachmentsToSet
", + "CreateCaseRequest$attachmentSetId": "The ID of a set of one or more attachments for the case. Create the set by using AddAttachmentsToSet.
" + } + }, + "AttachmentSetIdNotFound": { + "base": "An attachment set with the specified ID could not be found.
", + "refs": { + } + }, + "AttachmentSetSizeLimitExceeded": { + "base": "A limit for the size of an attachment set has been exceeded. The limits are 3 attachments and 5 MB per attachment.
", + "refs": { + } + }, + "Attachments": { + "base": null, + "refs": { + "AddAttachmentsToSetRequest$attachments": "One or more attachments to add to the set. The limit is 3 attachments per set, and the size limit is 5 MB per attachment.
" + } + }, + "BeforeTime": { + "base": null, + "refs": { + "DescribeCasesRequest$beforeTime": "The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
", + "DescribeCommunicationsRequest$beforeTime": "The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
" + } + }, + "Boolean": { + "base": null, + "refs": { + "TrustedAdvisorCheckSummary$hasFlaggedResources": "Specifies whether the Trusted Advisor check has flagged resources.
", + "TrustedAdvisorResourceDetail$isSuppressed": "Specifies whether the AWS resource was ignored by Trusted Advisor because it was marked as suppressed by the user.
" + } + }, + "CaseCreationLimitExceeded": { + "base": "The case creation limit for the account has been exceeded.
", + "refs": { + } + }, + "CaseDetails": { + "base": "A JSON-formatted object that contains the metadata for a support case. It is contained the response from a DescribeCases request. CaseDetails contains the following fields:
Attachments, Body, CaseId, SubmittedBy, and TimeCreated.The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47
", + "CaseDetails$caseId": "The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47
", + "CaseIdList$member": null, + "Communication$caseId": "The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47
", + "CreateCaseResponse$caseId": "The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47
", + "DescribeCommunicationsRequest$caseId": "The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47
", + "ResolveCaseRequest$caseId": "The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47
" + } + }, + "CaseIdList": { + "base": null, + "refs": { + "DescribeCasesRequest$caseIdList": "A list of ID numbers of the support cases you want returned. The maximum number of cases is 100.
" + } + }, + "CaseIdNotFound": { + "base": "The requested CaseId could not be located.
The details for the cases that match the request.
" + } + }, + "CaseStatus": { + "base": null, + "refs": { + "ResolveCaseResponse$initialCaseStatus": "The status of the case when the ResolveCase request was sent.
", + "ResolveCaseResponse$finalCaseStatus": "The status of the case after the ResolveCase request was processed.
" + } + }, + "Category": { + "base": "A JSON-formatted name/value pair that represents the category name and category code of the problem, selected from the DescribeServices response for each AWS service.
", + "refs": { + "CategoryList$member": null + } + }, + "CategoryCode": { + "base": null, + "refs": { + "CaseDetails$categoryCode": "The category of problem for the AWS Support case.
", + "Category$code": "The category code for the support case.
", + "CreateCaseRequest$categoryCode": "The category of problem for the AWS Support case.
" + } + }, + "CategoryList": { + "base": null, + "refs": { + "Service$categories": "A list of categories that describe the type of support issue a case describes. Categories consist of a category name and a category code. Category names and codes are passed to AWS Support when you call CreateCase.
" + } + }, + "CategoryName": { + "base": null, + "refs": { + "Category$name": "The category name for the support case.
" + } + }, + "CcEmailAddress": { + "base": null, + "refs": { + "CcEmailAddressList$member": null + } + }, + "CcEmailAddressList": { + "base": null, + "refs": { + "AddCommunicationToCaseRequest$ccEmailAddresses": "The email addresses in the CC line of an email to be added to the support case.
", + "CaseDetails$ccEmailAddresses": "The email addresses that receive copies of communication about the case.
", + "CreateCaseRequest$ccEmailAddresses": "A list of email addresses that AWS Support copies on case correspondence.
" + } + }, + "Communication": { + "base": "A communication associated with an AWS Support case. The communication consists of the case ID, the message body, attachment information, the account email address, and the date and time of the communication.
", + "refs": { + "CommunicationList$member": null + } + }, + "CommunicationBody": { + "base": null, + "refs": { + "AddCommunicationToCaseRequest$communicationBody": "The body of an email communication to add to the support case.
", + "Communication$body": "The text of the communication between the customer and AWS Support.
", + "CreateCaseRequest$communicationBody": "The communication body text when you create an AWS Support case by calling CreateCase.
" + } + }, + "CommunicationList": { + "base": null, + "refs": { + "DescribeCommunicationsResponse$communications": "The communications for the case.
", + "RecentCaseCommunications$communications": "The five most recent communications associated with the case.
" + } + }, + "CreateCaseRequest": { + "base": null, + "refs": { + } + }, + "CreateCaseResponse": { + "base": "The AWS Support case ID returned by a successful completion of the CreateCase operation.
", + "refs": { + } + }, + "Data": { + "base": null, + "refs": { + "Attachment$data": "The content of the attachment file.
" + } + }, + "DescribeAttachmentLimitExceeded": { + "base": "The limit for the number of DescribeAttachment requests in a short period of time has been exceeded.
", + "refs": { + } + }, + "DescribeAttachmentRequest": { + "base": null, + "refs": { + } + }, + "DescribeAttachmentResponse": { + "base": "The content and file name of the attachment returned by the DescribeAttachment operation.
", + "refs": { + } + }, + "DescribeCasesRequest": { + "base": null, + "refs": { + } + }, + "DescribeCasesResponse": { + "base": "Returns an array of CaseDetails objects and a NextToken that defines a point for pagination in the result set.
The communications returned by the DescribeCommunications operation.
", + "refs": { + } + }, + "DescribeServicesRequest": { + "base": null, + "refs": { + } + }, + "DescribeServicesResponse": { + "base": "The list of AWS services returned by the DescribeServices operation.
", + "refs": { + } + }, + "DescribeSeverityLevelsRequest": { + "base": null, + "refs": { + } + }, + "DescribeSeverityLevelsResponse": { + "base": "The list of severity levels returned by the DescribeSeverityLevels operation.
", + "refs": { + } + }, + "DescribeTrustedAdvisorCheckRefreshStatusesRequest": { + "base": null, + "refs": { + } + }, + "DescribeTrustedAdvisorCheckRefreshStatusesResponse": { + "base": "The statuses of the Trusted Advisor checks returned by the DescribeTrustedAdvisorCheckRefreshStatuses operation.
", + "refs": { + } + }, + "DescribeTrustedAdvisorCheckResultRequest": { + "base": null, + "refs": { + } + }, + "DescribeTrustedAdvisorCheckResultResponse": { + "base": "The result of the Trusted Advisor check returned by the DescribeTrustedAdvisorCheckResult operation.
", + "refs": { + } + }, + "DescribeTrustedAdvisorCheckSummariesRequest": { + "base": null, + "refs": { + } + }, + "DescribeTrustedAdvisorCheckSummariesResponse": { + "base": "The summaries of the Trusted Advisor checks returned by the DescribeTrustedAdvisorCheckSummaries operation.
", + "refs": { + } + }, + "DescribeTrustedAdvisorChecksRequest": { + "base": null, + "refs": { + } + }, + "DescribeTrustedAdvisorChecksResponse": { + "base": "Information about the Trusted Advisor checks returned by the DescribeTrustedAdvisorChecks operation.
", + "refs": { + } + }, + "DisplayId": { + "base": null, + "refs": { + "CaseDetails$displayId": "The ID displayed for the case in the AWS Support Center. This is a numeric string.
", + "DescribeCasesRequest$displayId": "The ID displayed for a case in the AWS Support Center user interface.
" + } + }, + "Double": { + "base": null, + "refs": { + "TrustedAdvisorCostOptimizingSummary$estimatedMonthlySavings": "The estimated monthly savings that might be realized if the recommended actions are taken.
", + "TrustedAdvisorCostOptimizingSummary$estimatedPercentMonthlySavings": "The estimated percentage of savings that might be realized if the recommended actions are taken.
" + } + }, + "ErrorMessage": { + "base": null, + "refs": { + "AttachmentIdNotFound$message": "An attachment with the specified ID could not be found.
", + "AttachmentLimitExceeded$message": "The limit for the number of attachment sets created in a short period of time has been exceeded.
", + "AttachmentSetExpired$message": "The expiration time of the attachment set has passed. The set expires 1 hour after it is created.
", + "AttachmentSetIdNotFound$message": "An attachment set with the specified ID could not be found.
", + "AttachmentSetSizeLimitExceeded$message": "A limit for the size of an attachment set has been exceeded. The limits are 3 attachments and 5 MB per attachment.
", + "CaseCreationLimitExceeded$message": "An error message that indicates that you have exceeded the number of cases you can have open.
", + "CaseIdNotFound$message": "The requested CaseId could not be located.
The limit for the number of DescribeAttachment requests in a short period of time has been exceeded.
", + "InternalServerError$message": "An internal server error occurred.
" + } + }, + "ExpiryTime": { + "base": null, + "refs": { + "AddAttachmentsToSetResponse$expiryTime": "The time and date when the attachment set expires.
" + } + }, + "FileName": { + "base": null, + "refs": { + "Attachment$fileName": "The name of the attachment file.
", + "AttachmentDetails$fileName": "The file name of the attachment.
" + } + }, + "IncludeCommunications": { + "base": null, + "refs": { + "DescribeCasesRequest$includeCommunications": "Specifies whether communications should be included in the DescribeCases results. The default is true.
" + } + }, + "IncludeResolvedCases": { + "base": null, + "refs": { + "DescribeCasesRequest$includeResolvedCases": "Specifies whether resolved support cases should be included in the DescribeCases results. The default is false.
" + } + }, + "InternalServerError": { + "base": "An internal server error occurred.
", + "refs": { + } + }, + "IssueType": { + "base": null, + "refs": { + "CreateCaseRequest$issueType": "The type of issue for the case. You can specify either \"customer-service\" or \"technical.\" If you do not indicate a value, the default is \"technical.\"
" + } + }, + "Language": { + "base": null, + "refs": { + "CaseDetails$language": "The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be passed explicitly for operations that take them.
", + "CreateCaseRequest$language": "The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be passed explicitly for operations that take them.
", + "DescribeCasesRequest$language": "The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be passed explicitly for operations that take them.
", + "DescribeServicesRequest$language": "The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be passed explicitly for operations that take them.
", + "DescribeSeverityLevelsRequest$language": "The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be passed explicitly for operations that take them.
" + } + }, + "Long": { + "base": null, + "refs": { + "TrustedAdvisorCheckRefreshStatus$millisUntilNextRefreshable": "The amount of time, in milliseconds, until the Trusted Advisor check is eligible for refresh.
", + "TrustedAdvisorResourcesSummary$resourcesProcessed": "The number of AWS resources that were analyzed by the Trusted Advisor check.
", + "TrustedAdvisorResourcesSummary$resourcesFlagged": "The number of AWS resources that were flagged (listed) by the Trusted Advisor check.
", + "TrustedAdvisorResourcesSummary$resourcesIgnored": "The number of AWS resources ignored by Trusted Advisor because information was unavailable.
", + "TrustedAdvisorResourcesSummary$resourcesSuppressed": "The number of AWS resources ignored by Trusted Advisor because they were marked as suppressed by the user.
" + } + }, + "MaxResults": { + "base": null, + "refs": { + "DescribeCasesRequest$maxResults": "The maximum number of results to return before paginating.
", + "DescribeCommunicationsRequest$maxResults": "The maximum number of results to return before paginating.
" + } + }, + "NextToken": { + "base": null, + "refs": { + "DescribeCasesRequest$nextToken": "A resumption point for pagination.
", + "DescribeCasesResponse$nextToken": "A resumption point for pagination.
", + "DescribeCommunicationsRequest$nextToken": "A resumption point for pagination.
", + "DescribeCommunicationsResponse$nextToken": "A resumption point for pagination.
", + "RecentCaseCommunications$nextToken": "A resumption point for pagination.
" + } + }, + "RecentCaseCommunications": { + "base": "The five most recent communications associated with the case.
", + "refs": { + "CaseDetails$recentCommunications": "The five most recent communications between you and AWS Support Center, including the IDs of any attachments to the communications. Also includes a nextToken that you can use to retrieve earlier communications.
The current refresh status of a Trusted Advisor check.
", + "refs": { + } + }, + "ResolveCaseRequest": { + "base": null, + "refs": { + } + }, + "ResolveCaseResponse": { + "base": "The status of the case returned by the ResolveCase operation.
", + "refs": { + } + }, + "Result": { + "base": null, + "refs": { + "AddCommunicationToCaseResponse$result": "True if AddCommunicationToCase succeeds. Otherwise, returns an error.
" + } + }, + "Service": { + "base": "Information about an AWS service returned by the DescribeServices operation.
", + "refs": { + "ServiceList$member": null + } + }, + "ServiceCode": { + "base": null, + "refs": { + "CaseDetails$serviceCode": "The code for the AWS service returned by the call to DescribeServices.
", + "CreateCaseRequest$serviceCode": "The code for the AWS service returned by the call to DescribeServices.
", + "Service$code": "The code for an AWS service returned by the DescribeServices response. The Name element contains the corresponding friendly name.
A JSON-formatted list of service codes available for AWS services.
" + } + }, + "ServiceList": { + "base": null, + "refs": { + "DescribeServicesResponse$services": "A JSON-formatted list of AWS services.
" + } + }, + "ServiceName": { + "base": null, + "refs": { + "Service$name": "The friendly name for an AWS service. The Code element contains the corresponding code.
The code for the severity level returned by the call to DescribeSeverityLevels.
", + "CreateCaseRequest$severityCode": "The code for the severity level returned by the call to DescribeSeverityLevels.
The availability of severity levels depends on each customer's support subscription. In other words, your subscription may not necessarily require the urgent level of response time.
A code and name pair that represent a severity level that can be applied to a support case.
", + "refs": { + "SeverityLevelsList$member": null + } + }, + "SeverityLevelCode": { + "base": null, + "refs": { + "SeverityLevel$code": "One of four values: \"low,\" \"medium,\" \"high,\" and \"urgent\". These values correspond to response times returned to the caller in SeverityLevel.name.
The name of the severity level that corresponds to the severity level code.
" + } + }, + "SeverityLevelsList": { + "base": null, + "refs": { + "DescribeSeverityLevelsResponse$severityLevels": "The available severity levels for the support case. Available severity levels are defined by your service level agreement with AWS.
" + } + }, + "Status": { + "base": null, + "refs": { + "CaseDetails$status": "The status of the case.
" + } + }, + "String": { + "base": null, + "refs": { + "DescribeTrustedAdvisorCheckResultRequest$checkId": "The unique identifier for the Trusted Advisor check.
", + "DescribeTrustedAdvisorCheckResultRequest$language": "The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be passed explicitly for operations that take them.
", + "DescribeTrustedAdvisorChecksRequest$language": "The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be passed explicitly for operations that take them.
", + "RefreshTrustedAdvisorCheckRequest$checkId": "The unique identifier for the Trusted Advisor check.
", + "StringList$member": null, + "TrustedAdvisorCheckDescription$id": "The unique identifier for the Trusted Advisor check.
", + "TrustedAdvisorCheckDescription$name": "The display name for the Trusted Advisor check.
", + "TrustedAdvisorCheckDescription$description": "The description of the Trusted Advisor check, which includes the alert criteria and recommended actions (contains HTML markup).
", + "TrustedAdvisorCheckDescription$category": "The category of the Trusted Advisor check.
", + "TrustedAdvisorCheckRefreshStatus$checkId": "The unique identifier for the Trusted Advisor check.
", + "TrustedAdvisorCheckRefreshStatus$status": "The status of the Trusted Advisor check for which a refresh has been requested: \"none\", \"enqueued\", \"processing\", \"success\", or \"abandoned\".
", + "TrustedAdvisorCheckResult$checkId": "The unique identifier for the Trusted Advisor check.
", + "TrustedAdvisorCheckResult$timestamp": "The time of the last refresh of the check.
", + "TrustedAdvisorCheckResult$status": "The alert status of the check: \"ok\" (green), \"warning\" (yellow), \"error\" (red), or \"not_available\".
", + "TrustedAdvisorCheckSummary$checkId": "The unique identifier for the Trusted Advisor check.
", + "TrustedAdvisorCheckSummary$timestamp": "The time of the last refresh of the check.
", + "TrustedAdvisorCheckSummary$status": "The alert status of the check: \"ok\" (green), \"warning\" (yellow), \"error\" (red), or \"not_available\".
", + "TrustedAdvisorResourceDetail$status": "The status code for the resource identified in the Trusted Advisor check.
", + "TrustedAdvisorResourceDetail$region": "The AWS region in which the identified resource is located.
", + "TrustedAdvisorResourceDetail$resourceId": "The unique identifier for the identified resource.
" + } + }, + "StringList": { + "base": null, + "refs": { + "DescribeTrustedAdvisorCheckRefreshStatusesRequest$checkIds": "The IDs of the Trusted Advisor checks.
", + "DescribeTrustedAdvisorCheckSummariesRequest$checkIds": "The IDs of the Trusted Advisor checks.
", + "TrustedAdvisorCheckDescription$metadata": "The column headings for the data returned by the Trusted Advisor check. The order of the headings corresponds to the order of the data in the Metadata element of the TrustedAdvisorResourceDetail for the check. Metadata contains all the data that is shown in the Excel download, even in those cases where the UI shows just summary data.
", + "TrustedAdvisorResourceDetail$metadata": "Additional information about the identified resource. The exact metadata and its order can be obtained by inspecting the TrustedAdvisorCheckDescription object returned by the call to DescribeTrustedAdvisorChecks. Metadata contains all the data that is shown in the Excel download, even in those cases where the UI shows just summary data.
" + } + }, + "Subject": { + "base": null, + "refs": { + "CaseDetails$subject": "The subject line for the case in the AWS Support Center.
", + "CreateCaseRequest$subject": "The title of the AWS Support case.
" + } + }, + "SubmittedBy": { + "base": null, + "refs": { + "CaseDetails$submittedBy": "The email address of the account that submitted the case.
", + "Communication$submittedBy": "The email address of the account that submitted the AWS Support case.
" + } + }, + "TimeCreated": { + "base": null, + "refs": { + "CaseDetails$timeCreated": "The time that the case was case created in the AWS Support Center.
", + "Communication$timeCreated": "The time the communication was created.
" + } + }, + "TrustedAdvisorCategorySpecificSummary": { + "base": "The container for summary information that relates to the category of the Trusted Advisor check.
", + "refs": { + "TrustedAdvisorCheckResult$categorySpecificSummary": "Summary information that relates to the category of the check. Cost Optimizing is the only category that is currently supported.
", + "TrustedAdvisorCheckSummary$categorySpecificSummary": "Summary information that relates to the category of the check. Cost Optimizing is the only category that is currently supported.
" + } + }, + "TrustedAdvisorCheckDescription": { + "base": "The description and metadata for a Trusted Advisor check.
", + "refs": { + "TrustedAdvisorCheckList$member": null + } + }, + "TrustedAdvisorCheckList": { + "base": null, + "refs": { + "DescribeTrustedAdvisorChecksResponse$checks": "Information about all available Trusted Advisor checks.
" + } + }, + "TrustedAdvisorCheckRefreshStatus": { + "base": "The refresh status of a Trusted Advisor check.
", + "refs": { + "RefreshTrustedAdvisorCheckResponse$status": "The current refresh status for a check, including the amount of time until the check is eligible for refresh.
", + "TrustedAdvisorCheckRefreshStatusList$member": null + } + }, + "TrustedAdvisorCheckRefreshStatusList": { + "base": null, + "refs": { + "DescribeTrustedAdvisorCheckRefreshStatusesResponse$statuses": "The refresh status of the specified Trusted Advisor checks.
" + } + }, + "TrustedAdvisorCheckResult": { + "base": "The results of a Trusted Advisor check returned by DescribeTrustedAdvisorCheckResult.
", + "refs": { + "DescribeTrustedAdvisorCheckResultResponse$result": "The detailed results of the Trusted Advisor check.
" + } + }, + "TrustedAdvisorCheckSummary": { + "base": "A summary of a Trusted Advisor check result, including the alert status, last refresh, and number of resources examined.
", + "refs": { + "TrustedAdvisorCheckSummaryList$member": null + } + }, + "TrustedAdvisorCheckSummaryList": { + "base": null, + "refs": { + "DescribeTrustedAdvisorCheckSummariesResponse$summaries": "The summary information for the requested Trusted Advisor checks.
" + } + }, + "TrustedAdvisorCostOptimizingSummary": { + "base": "The estimated cost savings that might be realized if the recommended actions are taken.
", + "refs": { + "TrustedAdvisorCategorySpecificSummary$costOptimizing": "The summary information about cost savings for a Trusted Advisor check that is in the Cost Optimizing category.
" + } + }, + "TrustedAdvisorResourceDetail": { + "base": "Contains information about a resource identified by a Trusted Advisor check.
", + "refs": { + "TrustedAdvisorResourceDetailList$member": null + } + }, + "TrustedAdvisorResourceDetailList": { + "base": null, + "refs": { + "TrustedAdvisorCheckResult$flaggedResources": "The details about each resource listed in the check result.
" + } + }, + "TrustedAdvisorResourcesSummary": { + "base": "Details about AWS resources that were analyzed in a call to Trusted Advisor DescribeTrustedAdvisorCheckSummaries.
", + "refs": { + "TrustedAdvisorCheckResult$resourcesSummary": null, + "TrustedAdvisorCheckSummary$resourcesSummary": null + } + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/support/2013-04-15/paginators-1.json b/vendor/github.com/aws/aws-sdk-go/models/apis/support/2013-04-15/paginators-1.json new file mode 100644 index 000000000..1368630c8 --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/support/2013-04-15/paginators-1.json @@ -0,0 +1,25 @@ +{ + "pagination": { + "DescribeCases": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "cases" + }, + "DescribeCommunications": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "communications" + }, + "DescribeServices": { + "result_key": "services" + }, + "DescribeTrustedAdvisorCheckRefreshStatuses": { + "result_key": "statuses" + }, + "DescribeTrustedAdvisorCheckSummaries": { + "result_key": "summaries" + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/swf/2012-01-25/api-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/swf/2012-01-25/api-2.json new file mode 100644 index 000000000..63486b94d --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/swf/2012-01-25/api-2.json @@ -0,0 +1,2838 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2012-01-25", + "endpointPrefix":"swf", + "jsonVersion":"1.0", + "serviceAbbreviation":"Amazon SWF", + "serviceFullName":"Amazon Simple Workflow Service", + "signatureVersion":"v4", + "targetPrefix":"SimpleWorkflowService", + "timestampFormat":"unixTimestamp", + "protocol":"json" + }, + "operations":{ + "CountClosedWorkflowExecutions":{ + "name":"CountClosedWorkflowExecutions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CountClosedWorkflowExecutionsInput"}, + "output":{"shape":"WorkflowExecutionCount"}, + "errors":[ + { + "shape":"UnknownResourceFault", + "exception":true + }, + { + "shape":"OperationNotPermittedFault", + "exception":true + } + ] + }, + "CountOpenWorkflowExecutions":{ + "name":"CountOpenWorkflowExecutions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CountOpenWorkflowExecutionsInput"}, + "output":{"shape":"WorkflowExecutionCount"}, + "errors":[ + { + "shape":"UnknownResourceFault", + "exception":true + }, + { + "shape":"OperationNotPermittedFault", + "exception":true + } + ] + }, + "CountPendingActivityTasks":{ + "name":"CountPendingActivityTasks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CountPendingActivityTasksInput"}, + "output":{"shape":"PendingTaskCount"}, + "errors":[ + { + "shape":"UnknownResourceFault", + "exception":true + }, + { + "shape":"OperationNotPermittedFault", + "exception":true + } + ] + }, + "CountPendingDecisionTasks":{ + "name":"CountPendingDecisionTasks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CountPendingDecisionTasksInput"}, + "output":{"shape":"PendingTaskCount"}, + "errors":[ + { + "shape":"UnknownResourceFault", + "exception":true + }, + { + "shape":"OperationNotPermittedFault", + "exception":true + } + ] + }, + "DeprecateActivityType":{ + "name":"DeprecateActivityType", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeprecateActivityTypeInput"}, + "errors":[ + { + "shape":"UnknownResourceFault", + "exception":true + }, + { + "shape":"TypeDeprecatedFault", + "exception":true + }, + { + "shape":"OperationNotPermittedFault", + "exception":true + } + ] + }, + "DeprecateDomain":{ + "name":"DeprecateDomain", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeprecateDomainInput"}, + "errors":[ + { + "shape":"UnknownResourceFault", + "exception":true + }, + { + "shape":"DomainDeprecatedFault", + "exception":true + }, + { + "shape":"OperationNotPermittedFault", + "exception":true + } + ] + }, + "DeprecateWorkflowType":{ + "name":"DeprecateWorkflowType", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeprecateWorkflowTypeInput"}, + "errors":[ + { + "shape":"UnknownResourceFault", + "exception":true + }, + { + "shape":"TypeDeprecatedFault", + "exception":true + }, + { + "shape":"OperationNotPermittedFault", + "exception":true + } + ] + }, + "DescribeActivityType":{ + "name":"DescribeActivityType", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeActivityTypeInput"}, + "output":{"shape":"ActivityTypeDetail"}, + "errors":[ + { + "shape":"UnknownResourceFault", + "exception":true + }, + { + "shape":"OperationNotPermittedFault", + "exception":true + } + ] + }, + "DescribeDomain":{ + "name":"DescribeDomain", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDomainInput"}, + "output":{"shape":"DomainDetail"}, + "errors":[ + { + "shape":"UnknownResourceFault", + "exception":true + }, + { + "shape":"OperationNotPermittedFault", + "exception":true + } + ] + }, + "DescribeWorkflowExecution":{ + "name":"DescribeWorkflowExecution", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeWorkflowExecutionInput"}, + "output":{"shape":"WorkflowExecutionDetail"}, + "errors":[ + { + "shape":"UnknownResourceFault", + "exception":true + }, + { + "shape":"OperationNotPermittedFault", + "exception":true + } + ] + }, + "DescribeWorkflowType":{ + "name":"DescribeWorkflowType", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeWorkflowTypeInput"}, + "output":{"shape":"WorkflowTypeDetail"}, + "errors":[ + { + "shape":"UnknownResourceFault", + "exception":true + }, + { + "shape":"OperationNotPermittedFault", + "exception":true + } + ] + }, + "GetWorkflowExecutionHistory":{ + "name":"GetWorkflowExecutionHistory", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetWorkflowExecutionHistoryInput"}, + "output":{"shape":"History"}, + "errors":[ + { + "shape":"UnknownResourceFault", + "exception":true + }, + { + "shape":"OperationNotPermittedFault", + "exception":true + } + ] + }, + "ListActivityTypes":{ + "name":"ListActivityTypes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListActivityTypesInput"}, + "output":{"shape":"ActivityTypeInfos"}, + "errors":[ + { + "shape":"OperationNotPermittedFault", + "exception":true + }, + { + "shape":"UnknownResourceFault", + "exception":true + } + ] + }, + "ListClosedWorkflowExecutions":{ + "name":"ListClosedWorkflowExecutions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListClosedWorkflowExecutionsInput"}, + "output":{"shape":"WorkflowExecutionInfos"}, + "errors":[ + { + "shape":"UnknownResourceFault", + "exception":true + }, + { + "shape":"OperationNotPermittedFault", + "exception":true + } + ] + }, + "ListDomains":{ + "name":"ListDomains", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListDomainsInput"}, + "output":{"shape":"DomainInfos"}, + "errors":[ + { + "shape":"OperationNotPermittedFault", + "exception":true + } + ] + }, + "ListOpenWorkflowExecutions":{ + "name":"ListOpenWorkflowExecutions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListOpenWorkflowExecutionsInput"}, + "output":{"shape":"WorkflowExecutionInfos"}, + "errors":[ + { + "shape":"UnknownResourceFault", + "exception":true + }, + { + "shape":"OperationNotPermittedFault", + "exception":true + } + ] + }, + "ListWorkflowTypes":{ + "name":"ListWorkflowTypes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListWorkflowTypesInput"}, + "output":{"shape":"WorkflowTypeInfos"}, + "errors":[ + { + "shape":"OperationNotPermittedFault", + "exception":true + }, + { + "shape":"UnknownResourceFault", + "exception":true + } + ] + }, + "PollForActivityTask":{ + "name":"PollForActivityTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PollForActivityTaskInput"}, + "output":{"shape":"ActivityTask"}, + "errors":[ + { + "shape":"UnknownResourceFault", + "exception":true + }, + { + "shape":"OperationNotPermittedFault", + "exception":true + }, + { + "shape":"LimitExceededFault", + "exception":true + } + ] + }, + "PollForDecisionTask":{ + "name":"PollForDecisionTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PollForDecisionTaskInput"}, + "output":{"shape":"DecisionTask"}, + "errors":[ + { + "shape":"UnknownResourceFault", + "exception":true + }, + { + "shape":"OperationNotPermittedFault", + "exception":true + }, + { + "shape":"LimitExceededFault", + "exception":true + } + ] + }, + "RecordActivityTaskHeartbeat":{ + "name":"RecordActivityTaskHeartbeat", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RecordActivityTaskHeartbeatInput"}, + "output":{"shape":"ActivityTaskStatus"}, + "errors":[ + { + "shape":"UnknownResourceFault", + "exception":true + }, + { + "shape":"OperationNotPermittedFault", + "exception":true + } + ] + }, + "RegisterActivityType":{ + "name":"RegisterActivityType", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RegisterActivityTypeInput"}, + "errors":[ + { + "shape":"TypeAlreadyExistsFault", + "exception":true + }, + { + "shape":"LimitExceededFault", + "exception":true + }, + { + "shape":"UnknownResourceFault", + "exception":true + }, + { + "shape":"OperationNotPermittedFault", + "exception":true + } + ] + }, + "RegisterDomain":{ + "name":"RegisterDomain", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RegisterDomainInput"}, + "errors":[ + { + "shape":"DomainAlreadyExistsFault", + "exception":true + }, + { + "shape":"LimitExceededFault", + "exception":true + }, + { + "shape":"OperationNotPermittedFault", + "exception":true + } + ] + }, + "RegisterWorkflowType":{ + "name":"RegisterWorkflowType", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RegisterWorkflowTypeInput"}, + "errors":[ + { + "shape":"TypeAlreadyExistsFault", + "exception":true + }, + { + "shape":"LimitExceededFault", + "exception":true + }, + { + "shape":"UnknownResourceFault", + "exception":true + }, + { + "shape":"OperationNotPermittedFault", + "exception":true + } + ] + }, + "RequestCancelWorkflowExecution":{ + "name":"RequestCancelWorkflowExecution", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RequestCancelWorkflowExecutionInput"}, + "errors":[ + { + "shape":"UnknownResourceFault", + "exception":true + }, + { + "shape":"OperationNotPermittedFault", + "exception":true + } + ] + }, + "RespondActivityTaskCanceled":{ + "name":"RespondActivityTaskCanceled", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RespondActivityTaskCanceledInput"}, + "errors":[ + { + "shape":"UnknownResourceFault", + "exception":true + }, + { + "shape":"OperationNotPermittedFault", + "exception":true + } + ] + }, + "RespondActivityTaskCompleted":{ + "name":"RespondActivityTaskCompleted", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RespondActivityTaskCompletedInput"}, + "errors":[ + { + "shape":"UnknownResourceFault", + "exception":true + }, + { + "shape":"OperationNotPermittedFault", + "exception":true + } + ] + }, + "RespondActivityTaskFailed":{ + "name":"RespondActivityTaskFailed", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RespondActivityTaskFailedInput"}, + "errors":[ + { + "shape":"UnknownResourceFault", + "exception":true + }, + { + "shape":"OperationNotPermittedFault", + "exception":true + } + ] + }, + "RespondDecisionTaskCompleted":{ + "name":"RespondDecisionTaskCompleted", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RespondDecisionTaskCompletedInput"}, + "errors":[ + { + "shape":"UnknownResourceFault", + "exception":true + }, + { + "shape":"OperationNotPermittedFault", + "exception":true + } + ] + }, + "SignalWorkflowExecution":{ + "name":"SignalWorkflowExecution", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SignalWorkflowExecutionInput"}, + "errors":[ + { + "shape":"UnknownResourceFault", + "exception":true + }, + { + "shape":"OperationNotPermittedFault", + "exception":true + } + ] + }, + "StartWorkflowExecution":{ + "name":"StartWorkflowExecution", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartWorkflowExecutionInput"}, + "output":{"shape":"Run"}, + "errors":[ + { + "shape":"UnknownResourceFault", + "exception":true + }, + { + "shape":"TypeDeprecatedFault", + "exception":true + }, + { + "shape":"WorkflowExecutionAlreadyStartedFault", + "exception":true + }, + { + "shape":"LimitExceededFault", + "exception":true + }, + { + "shape":"OperationNotPermittedFault", + "exception":true + }, + { + "shape":"DefaultUndefinedFault", + "exception":true + } + ] + }, + "TerminateWorkflowExecution":{ + "name":"TerminateWorkflowExecution", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TerminateWorkflowExecutionInput"}, + "errors":[ + { + "shape":"UnknownResourceFault", + "exception":true + }, + { + "shape":"OperationNotPermittedFault", + "exception":true + } + ] + } + }, + "shapes":{ + "ActivityId":{ + "type":"string", + "min":1, + "max":256 + }, + "ActivityTask":{ + "type":"structure", + "required":[ + "taskToken", + "activityId", + "startedEventId", + "workflowExecution", + "activityType" + ], + "members":{ + "taskToken":{"shape":"TaskToken"}, + "activityId":{"shape":"ActivityId"}, + "startedEventId":{"shape":"EventId"}, + "workflowExecution":{"shape":"WorkflowExecution"}, + "activityType":{"shape":"ActivityType"}, + "input":{"shape":"Data"} + } + }, + "ActivityTaskCancelRequestedEventAttributes":{ + "type":"structure", + "required":[ + "decisionTaskCompletedEventId", + "activityId" + ], + "members":{ + "decisionTaskCompletedEventId":{"shape":"EventId"}, + "activityId":{"shape":"ActivityId"} + } + }, + "ActivityTaskCanceledEventAttributes":{ + "type":"structure", + "required":[ + "scheduledEventId", + "startedEventId" + ], + "members":{ + "details":{"shape":"Data"}, + "scheduledEventId":{"shape":"EventId"}, + "startedEventId":{"shape":"EventId"}, + "latestCancelRequestedEventId":{"shape":"EventId"} + } + }, + "ActivityTaskCompletedEventAttributes":{ + "type":"structure", + "required":[ + "scheduledEventId", + "startedEventId" + ], + "members":{ + "result":{"shape":"Data"}, + "scheduledEventId":{"shape":"EventId"}, + "startedEventId":{"shape":"EventId"} + } + }, + "ActivityTaskFailedEventAttributes":{ + "type":"structure", + "required":[ + "scheduledEventId", + "startedEventId" + ], + "members":{ + "reason":{"shape":"FailureReason"}, + "details":{"shape":"Data"}, + "scheduledEventId":{"shape":"EventId"}, + "startedEventId":{"shape":"EventId"} + } + }, + "ActivityTaskScheduledEventAttributes":{ + "type":"structure", + "required":[ + "activityType", + "activityId", + "taskList", + "decisionTaskCompletedEventId" + ], + "members":{ + "activityType":{"shape":"ActivityType"}, + "activityId":{"shape":"ActivityId"}, + "input":{"shape":"Data"}, + "control":{"shape":"Data"}, + "scheduleToStartTimeout":{"shape":"DurationInSecondsOptional"}, + "scheduleToCloseTimeout":{"shape":"DurationInSecondsOptional"}, + "startToCloseTimeout":{"shape":"DurationInSecondsOptional"}, + "taskList":{"shape":"TaskList"}, + "taskPriority":{"shape":"TaskPriority"}, + "decisionTaskCompletedEventId":{"shape":"EventId"}, + "heartbeatTimeout":{"shape":"DurationInSecondsOptional"} + } + }, + "ActivityTaskStartedEventAttributes":{ + "type":"structure", + "required":["scheduledEventId"], + "members":{ + "identity":{"shape":"Identity"}, + "scheduledEventId":{"shape":"EventId"} + } + }, + "ActivityTaskStatus":{ + "type":"structure", + "required":["cancelRequested"], + "members":{ + "cancelRequested":{"shape":"Canceled"} + } + }, + "ActivityTaskTimedOutEventAttributes":{ + "type":"structure", + "required":[ + "timeoutType", + "scheduledEventId", + "startedEventId" + ], + "members":{ + "timeoutType":{"shape":"ActivityTaskTimeoutType"}, + "scheduledEventId":{"shape":"EventId"}, + "startedEventId":{"shape":"EventId"}, + "details":{"shape":"LimitedData"} + } + }, + "ActivityTaskTimeoutType":{ + "type":"string", + "enum":[ + "START_TO_CLOSE", + "SCHEDULE_TO_START", + "SCHEDULE_TO_CLOSE", + "HEARTBEAT" + ] + }, + "ActivityType":{ + "type":"structure", + "required":[ + "name", + "version" + ], + "members":{ + "name":{"shape":"Name"}, + "version":{"shape":"Version"} + } + }, + "ActivityTypeConfiguration":{ + "type":"structure", + "members":{ + "defaultTaskStartToCloseTimeout":{"shape":"DurationInSecondsOptional"}, + "defaultTaskHeartbeatTimeout":{"shape":"DurationInSecondsOptional"}, + "defaultTaskList":{"shape":"TaskList"}, + "defaultTaskPriority":{"shape":"TaskPriority"}, + "defaultTaskScheduleToStartTimeout":{"shape":"DurationInSecondsOptional"}, + "defaultTaskScheduleToCloseTimeout":{"shape":"DurationInSecondsOptional"} + } + }, + "ActivityTypeDetail":{ + "type":"structure", + "required":[ + "typeInfo", + "configuration" + ], + "members":{ + "typeInfo":{"shape":"ActivityTypeInfo"}, + "configuration":{"shape":"ActivityTypeConfiguration"} + } + }, + "ActivityTypeInfo":{ + "type":"structure", + "required":[ + "activityType", + "status", + "creationDate" + ], + "members":{ + "activityType":{"shape":"ActivityType"}, + "status":{"shape":"RegistrationStatus"}, + "description":{"shape":"Description"}, + "creationDate":{"shape":"Timestamp"}, + "deprecationDate":{"shape":"Timestamp"} + } + }, + "ActivityTypeInfoList":{ + "type":"list", + "member":{"shape":"ActivityTypeInfo"} + }, + "ActivityTypeInfos":{ + "type":"structure", + "required":["typeInfos"], + "members":{ + "typeInfos":{"shape":"ActivityTypeInfoList"}, + "nextPageToken":{"shape":"PageToken"} + } + }, + "Arn":{ + "type":"string", + "min":1, + "max":1224 + }, + "CancelTimerDecisionAttributes":{ + "type":"structure", + "required":["timerId"], + "members":{ + "timerId":{"shape":"TimerId"} + } + }, + "CancelTimerFailedCause":{ + "type":"string", + "enum":[ + "TIMER_ID_UNKNOWN", + "OPERATION_NOT_PERMITTED" + ] + }, + "CancelTimerFailedEventAttributes":{ + "type":"structure", + "required":[ + "timerId", + "cause", + "decisionTaskCompletedEventId" + ], + "members":{ + "timerId":{"shape":"TimerId"}, + "cause":{"shape":"CancelTimerFailedCause"}, + "decisionTaskCompletedEventId":{"shape":"EventId"} + } + }, + "CancelWorkflowExecutionDecisionAttributes":{ + "type":"structure", + "members":{ + "details":{"shape":"Data"} + } + }, + "CancelWorkflowExecutionFailedCause":{ + "type":"string", + "enum":[ + "UNHANDLED_DECISION", + "OPERATION_NOT_PERMITTED" + ] + }, + "CancelWorkflowExecutionFailedEventAttributes":{ + "type":"structure", + "required":[ + "cause", + "decisionTaskCompletedEventId" + ], + "members":{ + "cause":{"shape":"CancelWorkflowExecutionFailedCause"}, + "decisionTaskCompletedEventId":{"shape":"EventId"} + } + }, + "Canceled":{"type":"boolean"}, + "CauseMessage":{ + "type":"string", + "max":1728 + }, + "ChildPolicy":{ + "type":"string", + "enum":[ + "TERMINATE", + "REQUEST_CANCEL", + "ABANDON" + ] + }, + "ChildWorkflowExecutionCanceledEventAttributes":{ + "type":"structure", + "required":[ + "workflowExecution", + "workflowType", + "initiatedEventId", + "startedEventId" + ], + "members":{ + "workflowExecution":{"shape":"WorkflowExecution"}, + "workflowType":{"shape":"WorkflowType"}, + "details":{"shape":"Data"}, + "initiatedEventId":{"shape":"EventId"}, + "startedEventId":{"shape":"EventId"} + } + }, + "ChildWorkflowExecutionCompletedEventAttributes":{ + "type":"structure", + "required":[ + "workflowExecution", + "workflowType", + "initiatedEventId", + "startedEventId" + ], + "members":{ + "workflowExecution":{"shape":"WorkflowExecution"}, + "workflowType":{"shape":"WorkflowType"}, + "result":{"shape":"Data"}, + "initiatedEventId":{"shape":"EventId"}, + "startedEventId":{"shape":"EventId"} + } + }, + "ChildWorkflowExecutionFailedEventAttributes":{ + "type":"structure", + "required":[ + "workflowExecution", + "workflowType", + "initiatedEventId", + "startedEventId" + ], + "members":{ + "workflowExecution":{"shape":"WorkflowExecution"}, + "workflowType":{"shape":"WorkflowType"}, + "reason":{"shape":"FailureReason"}, + "details":{"shape":"Data"}, + "initiatedEventId":{"shape":"EventId"}, + "startedEventId":{"shape":"EventId"} + } + }, + "ChildWorkflowExecutionStartedEventAttributes":{ + "type":"structure", + "required":[ + "workflowExecution", + "workflowType", + "initiatedEventId" + ], + "members":{ + "workflowExecution":{"shape":"WorkflowExecution"}, + "workflowType":{"shape":"WorkflowType"}, + "initiatedEventId":{"shape":"EventId"} + } + }, + "ChildWorkflowExecutionTerminatedEventAttributes":{ + "type":"structure", + "required":[ + "workflowExecution", + "workflowType", + "initiatedEventId", + "startedEventId" + ], + "members":{ + "workflowExecution":{"shape":"WorkflowExecution"}, + "workflowType":{"shape":"WorkflowType"}, + "initiatedEventId":{"shape":"EventId"}, + "startedEventId":{"shape":"EventId"} + } + }, + "ChildWorkflowExecutionTimedOutEventAttributes":{ + "type":"structure", + "required":[ + "workflowExecution", + "workflowType", + "timeoutType", + "initiatedEventId", + "startedEventId" + ], + "members":{ + "workflowExecution":{"shape":"WorkflowExecution"}, + "workflowType":{"shape":"WorkflowType"}, + "timeoutType":{"shape":"WorkflowExecutionTimeoutType"}, + "initiatedEventId":{"shape":"EventId"}, + "startedEventId":{"shape":"EventId"} + } + }, + "CloseStatus":{ + "type":"string", + "enum":[ + "COMPLETED", + "FAILED", + "CANCELED", + "TERMINATED", + "CONTINUED_AS_NEW", + "TIMED_OUT" + ] + }, + "CloseStatusFilter":{ + "type":"structure", + "required":["status"], + "members":{ + "status":{"shape":"CloseStatus"} + } + }, + "CompleteWorkflowExecutionDecisionAttributes":{ + "type":"structure", + "members":{ + "result":{"shape":"Data"} + } + }, + "CompleteWorkflowExecutionFailedCause":{ + "type":"string", + "enum":[ + "UNHANDLED_DECISION", + "OPERATION_NOT_PERMITTED" + ] + }, + "CompleteWorkflowExecutionFailedEventAttributes":{ + "type":"structure", + "required":[ + "cause", + "decisionTaskCompletedEventId" + ], + "members":{ + "cause":{"shape":"CompleteWorkflowExecutionFailedCause"}, + "decisionTaskCompletedEventId":{"shape":"EventId"} + } + }, + "ContinueAsNewWorkflowExecutionDecisionAttributes":{ + "type":"structure", + "members":{ + "input":{"shape":"Data"}, + "executionStartToCloseTimeout":{"shape":"DurationInSecondsOptional"}, + "taskList":{"shape":"TaskList"}, + "taskPriority":{"shape":"TaskPriority"}, + "taskStartToCloseTimeout":{"shape":"DurationInSecondsOptional"}, + "childPolicy":{"shape":"ChildPolicy"}, + "tagList":{"shape":"TagList"}, + "workflowTypeVersion":{"shape":"Version"}, + "lambdaRole":{"shape":"Arn"} + } + }, + "ContinueAsNewWorkflowExecutionFailedCause":{ + "type":"string", + "enum":[ + "UNHANDLED_DECISION", + "WORKFLOW_TYPE_DEPRECATED", + "WORKFLOW_TYPE_DOES_NOT_EXIST", + "DEFAULT_EXECUTION_START_TO_CLOSE_TIMEOUT_UNDEFINED", + "DEFAULT_TASK_START_TO_CLOSE_TIMEOUT_UNDEFINED", + "DEFAULT_TASK_LIST_UNDEFINED", + "DEFAULT_CHILD_POLICY_UNDEFINED", + "CONTINUE_AS_NEW_WORKFLOW_EXECUTION_RATE_EXCEEDED", + "OPERATION_NOT_PERMITTED" + ] + }, + "ContinueAsNewWorkflowExecutionFailedEventAttributes":{ + "type":"structure", + "required":[ + "cause", + "decisionTaskCompletedEventId" + ], + "members":{ + "cause":{"shape":"ContinueAsNewWorkflowExecutionFailedCause"}, + "decisionTaskCompletedEventId":{"shape":"EventId"} + } + }, + "Count":{ + "type":"integer", + "min":0 + }, + "CountClosedWorkflowExecutionsInput":{ + "type":"structure", + "required":["domain"], + "members":{ + "domain":{"shape":"DomainName"}, + "startTimeFilter":{"shape":"ExecutionTimeFilter"}, + "closeTimeFilter":{"shape":"ExecutionTimeFilter"}, + "executionFilter":{"shape":"WorkflowExecutionFilter"}, + "typeFilter":{"shape":"WorkflowTypeFilter"}, + "tagFilter":{"shape":"TagFilter"}, + "closeStatusFilter":{"shape":"CloseStatusFilter"} + } + }, + "CountOpenWorkflowExecutionsInput":{ + "type":"structure", + "required":[ + "domain", + "startTimeFilter" + ], + "members":{ + "domain":{"shape":"DomainName"}, + "startTimeFilter":{"shape":"ExecutionTimeFilter"}, + "typeFilter":{"shape":"WorkflowTypeFilter"}, + "tagFilter":{"shape":"TagFilter"}, + "executionFilter":{"shape":"WorkflowExecutionFilter"} + } + }, + "CountPendingActivityTasksInput":{ + "type":"structure", + "required":[ + "domain", + "taskList" + ], + "members":{ + "domain":{"shape":"DomainName"}, + "taskList":{"shape":"TaskList"} + } + }, + "CountPendingDecisionTasksInput":{ + "type":"structure", + "required":[ + "domain", + "taskList" + ], + "members":{ + "domain":{"shape":"DomainName"}, + "taskList":{"shape":"TaskList"} + } + }, + "Data":{ + "type":"string", + "max":32768 + }, + "Decision":{ + "type":"structure", + "required":["decisionType"], + "members":{ + "decisionType":{"shape":"DecisionType"}, + "scheduleActivityTaskDecisionAttributes":{"shape":"ScheduleActivityTaskDecisionAttributes"}, + "requestCancelActivityTaskDecisionAttributes":{"shape":"RequestCancelActivityTaskDecisionAttributes"}, + "completeWorkflowExecutionDecisionAttributes":{"shape":"CompleteWorkflowExecutionDecisionAttributes"}, + "failWorkflowExecutionDecisionAttributes":{"shape":"FailWorkflowExecutionDecisionAttributes"}, + "cancelWorkflowExecutionDecisionAttributes":{"shape":"CancelWorkflowExecutionDecisionAttributes"}, + "continueAsNewWorkflowExecutionDecisionAttributes":{"shape":"ContinueAsNewWorkflowExecutionDecisionAttributes"}, + "recordMarkerDecisionAttributes":{"shape":"RecordMarkerDecisionAttributes"}, + "startTimerDecisionAttributes":{"shape":"StartTimerDecisionAttributes"}, + "cancelTimerDecisionAttributes":{"shape":"CancelTimerDecisionAttributes"}, + "signalExternalWorkflowExecutionDecisionAttributes":{"shape":"SignalExternalWorkflowExecutionDecisionAttributes"}, + "requestCancelExternalWorkflowExecutionDecisionAttributes":{"shape":"RequestCancelExternalWorkflowExecutionDecisionAttributes"}, + "startChildWorkflowExecutionDecisionAttributes":{"shape":"StartChildWorkflowExecutionDecisionAttributes"}, + "scheduleLambdaFunctionDecisionAttributes":{"shape":"ScheduleLambdaFunctionDecisionAttributes"} + } + }, + "DecisionList":{ + "type":"list", + "member":{"shape":"Decision"} + }, + "DecisionTask":{ + "type":"structure", + "required":[ + "taskToken", + "startedEventId", + "workflowExecution", + "workflowType", + "events" + ], + "members":{ + "taskToken":{"shape":"TaskToken"}, + "startedEventId":{"shape":"EventId"}, + "workflowExecution":{"shape":"WorkflowExecution"}, + "workflowType":{"shape":"WorkflowType"}, + "events":{"shape":"HistoryEventList"}, + "nextPageToken":{"shape":"PageToken"}, + "previousStartedEventId":{"shape":"EventId"} + } + }, + "DecisionTaskCompletedEventAttributes":{ + "type":"structure", + "required":[ + "scheduledEventId", + "startedEventId" + ], + "members":{ + "executionContext":{"shape":"Data"}, + "scheduledEventId":{"shape":"EventId"}, + "startedEventId":{"shape":"EventId"} + } + }, + "DecisionTaskScheduledEventAttributes":{ + "type":"structure", + "required":["taskList"], + "members":{ + "taskList":{"shape":"TaskList"}, + "taskPriority":{"shape":"TaskPriority"}, + "startToCloseTimeout":{"shape":"DurationInSecondsOptional"} + } + }, + "DecisionTaskStartedEventAttributes":{ + "type":"structure", + "required":["scheduledEventId"], + "members":{ + "identity":{"shape":"Identity"}, + "scheduledEventId":{"shape":"EventId"} + } + }, + "DecisionTaskTimedOutEventAttributes":{ + "type":"structure", + "required":[ + "timeoutType", + "scheduledEventId", + "startedEventId" + ], + "members":{ + "timeoutType":{"shape":"DecisionTaskTimeoutType"}, + "scheduledEventId":{"shape":"EventId"}, + "startedEventId":{"shape":"EventId"} + } + }, + "DecisionTaskTimeoutType":{ + "type":"string", + "enum":["START_TO_CLOSE"] + }, + "DecisionType":{ + "type":"string", + "enum":[ + "ScheduleActivityTask", + "RequestCancelActivityTask", + "CompleteWorkflowExecution", + "FailWorkflowExecution", + "CancelWorkflowExecution", + "ContinueAsNewWorkflowExecution", + "RecordMarker", + "StartTimer", + "CancelTimer", + "SignalExternalWorkflowExecution", + "RequestCancelExternalWorkflowExecution", + "StartChildWorkflowExecution", + "ScheduleLambdaFunction" + ] + }, + "DefaultUndefinedFault":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true + }, + "DeprecateActivityTypeInput":{ + "type":"structure", + "required":[ + "domain", + "activityType" + ], + "members":{ + "domain":{"shape":"DomainName"}, + "activityType":{"shape":"ActivityType"} + } + }, + "DeprecateDomainInput":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{"shape":"DomainName"} + } + }, + "DeprecateWorkflowTypeInput":{ + "type":"structure", + "required":[ + "domain", + "workflowType" + ], + "members":{ + "domain":{"shape":"DomainName"}, + "workflowType":{"shape":"WorkflowType"} + } + }, + "DescribeActivityTypeInput":{ + "type":"structure", + "required":[ + "domain", + "activityType" + ], + "members":{ + "domain":{"shape":"DomainName"}, + "activityType":{"shape":"ActivityType"} + } + }, + "DescribeDomainInput":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{"shape":"DomainName"} + } + }, + "DescribeWorkflowExecutionInput":{ + "type":"structure", + "required":[ + "domain", + "execution" + ], + "members":{ + "domain":{"shape":"DomainName"}, + "execution":{"shape":"WorkflowExecution"} + } + }, + "DescribeWorkflowTypeInput":{ + "type":"structure", + "required":[ + "domain", + "workflowType" + ], + "members":{ + "domain":{"shape":"DomainName"}, + "workflowType":{"shape":"WorkflowType"} + } + }, + "Description":{ + "type":"string", + "max":1024 + }, + "DomainAlreadyExistsFault":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true + }, + "DomainConfiguration":{ + "type":"structure", + "required":["workflowExecutionRetentionPeriodInDays"], + "members":{ + "workflowExecutionRetentionPeriodInDays":{"shape":"DurationInDays"} + } + }, + "DomainDeprecatedFault":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true + }, + "DomainDetail":{ + "type":"structure", + "required":[ + "domainInfo", + "configuration" + ], + "members":{ + "domainInfo":{"shape":"DomainInfo"}, + "configuration":{"shape":"DomainConfiguration"} + } + }, + "DomainInfo":{ + "type":"structure", + "required":[ + "name", + "status" + ], + "members":{ + "name":{"shape":"DomainName"}, + "status":{"shape":"RegistrationStatus"}, + "description":{"shape":"Description"} + } + }, + "DomainInfoList":{ + "type":"list", + "member":{"shape":"DomainInfo"} + }, + "DomainInfos":{ + "type":"structure", + "required":["domainInfos"], + "members":{ + "domainInfos":{"shape":"DomainInfoList"}, + "nextPageToken":{"shape":"PageToken"} + } + }, + "DomainName":{ + "type":"string", + "min":1, + "max":256 + }, + "DurationInDays":{ + "type":"string", + "min":1, + "max":8 + }, + "DurationInSeconds":{ + "type":"string", + "min":1, + "max":8 + }, + "DurationInSecondsOptional":{ + "type":"string", + "max":8 + }, + "ErrorMessage":{"type":"string"}, + "EventId":{"type":"long"}, + "EventType":{ + "type":"string", + "enum":[ + "WorkflowExecutionStarted", + "WorkflowExecutionCancelRequested", + "WorkflowExecutionCompleted", + "CompleteWorkflowExecutionFailed", + "WorkflowExecutionFailed", + "FailWorkflowExecutionFailed", + "WorkflowExecutionTimedOut", + "WorkflowExecutionCanceled", + "CancelWorkflowExecutionFailed", + "WorkflowExecutionContinuedAsNew", + "ContinueAsNewWorkflowExecutionFailed", + "WorkflowExecutionTerminated", + "DecisionTaskScheduled", + "DecisionTaskStarted", + "DecisionTaskCompleted", + "DecisionTaskTimedOut", + "ActivityTaskScheduled", + "ScheduleActivityTaskFailed", + "ActivityTaskStarted", + "ActivityTaskCompleted", + "ActivityTaskFailed", + "ActivityTaskTimedOut", + "ActivityTaskCanceled", + "ActivityTaskCancelRequested", + "RequestCancelActivityTaskFailed", + "WorkflowExecutionSignaled", + "MarkerRecorded", + "RecordMarkerFailed", + "TimerStarted", + "StartTimerFailed", + "TimerFired", + "TimerCanceled", + "CancelTimerFailed", + "StartChildWorkflowExecutionInitiated", + "StartChildWorkflowExecutionFailed", + "ChildWorkflowExecutionStarted", + "ChildWorkflowExecutionCompleted", + "ChildWorkflowExecutionFailed", + "ChildWorkflowExecutionTimedOut", + "ChildWorkflowExecutionCanceled", + "ChildWorkflowExecutionTerminated", + "SignalExternalWorkflowExecutionInitiated", + "SignalExternalWorkflowExecutionFailed", + "ExternalWorkflowExecutionSignaled", + "RequestCancelExternalWorkflowExecutionInitiated", + "RequestCancelExternalWorkflowExecutionFailed", + "ExternalWorkflowExecutionCancelRequested", + "LambdaFunctionScheduled", + "LambdaFunctionStarted", + "LambdaFunctionCompleted", + "LambdaFunctionFailed", + "LambdaFunctionTimedOut", + "ScheduleLambdaFunctionFailed", + "StartLambdaFunctionFailed" + ] + }, + "ExecutionStatus":{ + "type":"string", + "enum":[ + "OPEN", + "CLOSED" + ] + }, + "ExecutionTimeFilter":{ + "type":"structure", + "required":["oldestDate"], + "members":{ + "oldestDate":{"shape":"Timestamp"}, + "latestDate":{"shape":"Timestamp"} + } + }, + "ExternalWorkflowExecutionCancelRequestedEventAttributes":{ + "type":"structure", + "required":[ + "workflowExecution", + "initiatedEventId" + ], + "members":{ + "workflowExecution":{"shape":"WorkflowExecution"}, + "initiatedEventId":{"shape":"EventId"} + } + }, + "ExternalWorkflowExecutionSignaledEventAttributes":{ + "type":"structure", + "required":[ + "workflowExecution", + "initiatedEventId" + ], + "members":{ + "workflowExecution":{"shape":"WorkflowExecution"}, + "initiatedEventId":{"shape":"EventId"} + } + }, + "FailWorkflowExecutionDecisionAttributes":{ + "type":"structure", + "members":{ + "reason":{"shape":"FailureReason"}, + "details":{"shape":"Data"} + } + }, + "FailWorkflowExecutionFailedCause":{ + "type":"string", + "enum":[ + "UNHANDLED_DECISION", + "OPERATION_NOT_PERMITTED" + ] + }, + "FailWorkflowExecutionFailedEventAttributes":{ + "type":"structure", + "required":[ + "cause", + "decisionTaskCompletedEventId" + ], + "members":{ + "cause":{"shape":"FailWorkflowExecutionFailedCause"}, + "decisionTaskCompletedEventId":{"shape":"EventId"} + } + }, + "FailureReason":{ + "type":"string", + "max":256 + }, + "FunctionId":{ + "type":"string", + "min":1, + "max":256 + }, + "FunctionInput":{ + "type":"string", + "min":1, + "max":32768 + }, + "FunctionName":{ + "type":"string", + "min":1, + "max":64 + }, + "GetWorkflowExecutionHistoryInput":{ + "type":"structure", + "required":[ + "domain", + "execution" + ], + "members":{ + "domain":{"shape":"DomainName"}, + "execution":{"shape":"WorkflowExecution"}, + "nextPageToken":{"shape":"PageToken"}, + "maximumPageSize":{"shape":"PageSize"}, + "reverseOrder":{"shape":"ReverseOrder"} + } + }, + "History":{ + "type":"structure", + "required":["events"], + "members":{ + "events":{"shape":"HistoryEventList"}, + "nextPageToken":{"shape":"PageToken"} + } + }, + "HistoryEvent":{ + "type":"structure", + "required":[ + "eventTimestamp", + "eventType", + "eventId" + ], + "members":{ + "eventTimestamp":{"shape":"Timestamp"}, + "eventType":{"shape":"EventType"}, + "eventId":{"shape":"EventId"}, + "workflowExecutionStartedEventAttributes":{"shape":"WorkflowExecutionStartedEventAttributes"}, + "workflowExecutionCompletedEventAttributes":{"shape":"WorkflowExecutionCompletedEventAttributes"}, + "completeWorkflowExecutionFailedEventAttributes":{"shape":"CompleteWorkflowExecutionFailedEventAttributes"}, + "workflowExecutionFailedEventAttributes":{"shape":"WorkflowExecutionFailedEventAttributes"}, + "failWorkflowExecutionFailedEventAttributes":{"shape":"FailWorkflowExecutionFailedEventAttributes"}, + "workflowExecutionTimedOutEventAttributes":{"shape":"WorkflowExecutionTimedOutEventAttributes"}, + "workflowExecutionCanceledEventAttributes":{"shape":"WorkflowExecutionCanceledEventAttributes"}, + "cancelWorkflowExecutionFailedEventAttributes":{"shape":"CancelWorkflowExecutionFailedEventAttributes"}, + "workflowExecutionContinuedAsNewEventAttributes":{"shape":"WorkflowExecutionContinuedAsNewEventAttributes"}, + "continueAsNewWorkflowExecutionFailedEventAttributes":{"shape":"ContinueAsNewWorkflowExecutionFailedEventAttributes"}, + "workflowExecutionTerminatedEventAttributes":{"shape":"WorkflowExecutionTerminatedEventAttributes"}, + "workflowExecutionCancelRequestedEventAttributes":{"shape":"WorkflowExecutionCancelRequestedEventAttributes"}, + "decisionTaskScheduledEventAttributes":{"shape":"DecisionTaskScheduledEventAttributes"}, + "decisionTaskStartedEventAttributes":{"shape":"DecisionTaskStartedEventAttributes"}, + "decisionTaskCompletedEventAttributes":{"shape":"DecisionTaskCompletedEventAttributes"}, + "decisionTaskTimedOutEventAttributes":{"shape":"DecisionTaskTimedOutEventAttributes"}, + "activityTaskScheduledEventAttributes":{"shape":"ActivityTaskScheduledEventAttributes"}, + "activityTaskStartedEventAttributes":{"shape":"ActivityTaskStartedEventAttributes"}, + "activityTaskCompletedEventAttributes":{"shape":"ActivityTaskCompletedEventAttributes"}, + "activityTaskFailedEventAttributes":{"shape":"ActivityTaskFailedEventAttributes"}, + "activityTaskTimedOutEventAttributes":{"shape":"ActivityTaskTimedOutEventAttributes"}, + "activityTaskCanceledEventAttributes":{"shape":"ActivityTaskCanceledEventAttributes"}, + "activityTaskCancelRequestedEventAttributes":{"shape":"ActivityTaskCancelRequestedEventAttributes"}, + "workflowExecutionSignaledEventAttributes":{"shape":"WorkflowExecutionSignaledEventAttributes"}, + "markerRecordedEventAttributes":{"shape":"MarkerRecordedEventAttributes"}, + "recordMarkerFailedEventAttributes":{"shape":"RecordMarkerFailedEventAttributes"}, + "timerStartedEventAttributes":{"shape":"TimerStartedEventAttributes"}, + "timerFiredEventAttributes":{"shape":"TimerFiredEventAttributes"}, + "timerCanceledEventAttributes":{"shape":"TimerCanceledEventAttributes"}, + "startChildWorkflowExecutionInitiatedEventAttributes":{"shape":"StartChildWorkflowExecutionInitiatedEventAttributes"}, + "childWorkflowExecutionStartedEventAttributes":{"shape":"ChildWorkflowExecutionStartedEventAttributes"}, + "childWorkflowExecutionCompletedEventAttributes":{"shape":"ChildWorkflowExecutionCompletedEventAttributes"}, + "childWorkflowExecutionFailedEventAttributes":{"shape":"ChildWorkflowExecutionFailedEventAttributes"}, + "childWorkflowExecutionTimedOutEventAttributes":{"shape":"ChildWorkflowExecutionTimedOutEventAttributes"}, + "childWorkflowExecutionCanceledEventAttributes":{"shape":"ChildWorkflowExecutionCanceledEventAttributes"}, + "childWorkflowExecutionTerminatedEventAttributes":{"shape":"ChildWorkflowExecutionTerminatedEventAttributes"}, + "signalExternalWorkflowExecutionInitiatedEventAttributes":{"shape":"SignalExternalWorkflowExecutionInitiatedEventAttributes"}, + "externalWorkflowExecutionSignaledEventAttributes":{"shape":"ExternalWorkflowExecutionSignaledEventAttributes"}, + "signalExternalWorkflowExecutionFailedEventAttributes":{"shape":"SignalExternalWorkflowExecutionFailedEventAttributes"}, + "externalWorkflowExecutionCancelRequestedEventAttributes":{"shape":"ExternalWorkflowExecutionCancelRequestedEventAttributes"}, + "requestCancelExternalWorkflowExecutionInitiatedEventAttributes":{"shape":"RequestCancelExternalWorkflowExecutionInitiatedEventAttributes"}, + "requestCancelExternalWorkflowExecutionFailedEventAttributes":{"shape":"RequestCancelExternalWorkflowExecutionFailedEventAttributes"}, + "scheduleActivityTaskFailedEventAttributes":{"shape":"ScheduleActivityTaskFailedEventAttributes"}, + "requestCancelActivityTaskFailedEventAttributes":{"shape":"RequestCancelActivityTaskFailedEventAttributes"}, + "startTimerFailedEventAttributes":{"shape":"StartTimerFailedEventAttributes"}, + "cancelTimerFailedEventAttributes":{"shape":"CancelTimerFailedEventAttributes"}, + "startChildWorkflowExecutionFailedEventAttributes":{"shape":"StartChildWorkflowExecutionFailedEventAttributes"}, + "lambdaFunctionScheduledEventAttributes":{"shape":"LambdaFunctionScheduledEventAttributes"}, + "lambdaFunctionStartedEventAttributes":{"shape":"LambdaFunctionStartedEventAttributes"}, + "lambdaFunctionCompletedEventAttributes":{"shape":"LambdaFunctionCompletedEventAttributes"}, + "lambdaFunctionFailedEventAttributes":{"shape":"LambdaFunctionFailedEventAttributes"}, + "lambdaFunctionTimedOutEventAttributes":{"shape":"LambdaFunctionTimedOutEventAttributes"}, + "scheduleLambdaFunctionFailedEventAttributes":{"shape":"ScheduleLambdaFunctionFailedEventAttributes"}, + "startLambdaFunctionFailedEventAttributes":{"shape":"StartLambdaFunctionFailedEventAttributes"} + } + }, + "HistoryEventList":{ + "type":"list", + "member":{"shape":"HistoryEvent"} + }, + "Identity":{ + "type":"string", + "max":256 + }, + "LambdaFunctionCompletedEventAttributes":{ + "type":"structure", + "required":[ + "scheduledEventId", + "startedEventId" + ], + "members":{ + "scheduledEventId":{"shape":"EventId"}, + "startedEventId":{"shape":"EventId"}, + "result":{"shape":"Data"} + } + }, + "LambdaFunctionFailedEventAttributes":{ + "type":"structure", + "required":[ + "scheduledEventId", + "startedEventId" + ], + "members":{ + "scheduledEventId":{"shape":"EventId"}, + "startedEventId":{"shape":"EventId"}, + "reason":{"shape":"FailureReason"}, + "details":{"shape":"Data"} + } + }, + "LambdaFunctionScheduledEventAttributes":{ + "type":"structure", + "required":[ + "id", + "name", + "decisionTaskCompletedEventId" + ], + "members":{ + "id":{"shape":"FunctionId"}, + "name":{"shape":"FunctionName"}, + "input":{"shape":"FunctionInput"}, + "startToCloseTimeout":{"shape":"DurationInSecondsOptional"}, + "decisionTaskCompletedEventId":{"shape":"EventId"} + } + }, + "LambdaFunctionStartedEventAttributes":{ + "type":"structure", + "required":["scheduledEventId"], + "members":{ + "scheduledEventId":{"shape":"EventId"} + } + }, + "LambdaFunctionTimedOutEventAttributes":{ + "type":"structure", + "required":[ + "scheduledEventId", + "startedEventId" + ], + "members":{ + "scheduledEventId":{"shape":"EventId"}, + "startedEventId":{"shape":"EventId"}, + "timeoutType":{"shape":"LambdaFunctionTimeoutType"} + } + }, + "LambdaFunctionTimeoutType":{ + "type":"string", + "enum":["START_TO_CLOSE"] + }, + "LimitExceededFault":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true + }, + "LimitedData":{ + "type":"string", + "max":2048 + }, + "ListActivityTypesInput":{ + "type":"structure", + "required":[ + "domain", + "registrationStatus" + ], + "members":{ + "domain":{"shape":"DomainName"}, + "name":{"shape":"Name"}, + "registrationStatus":{"shape":"RegistrationStatus"}, + "nextPageToken":{"shape":"PageToken"}, + "maximumPageSize":{"shape":"PageSize"}, + "reverseOrder":{"shape":"ReverseOrder"} + } + }, + "ListClosedWorkflowExecutionsInput":{ + "type":"structure", + "required":["domain"], + "members":{ + "domain":{"shape":"DomainName"}, + "startTimeFilter":{"shape":"ExecutionTimeFilter"}, + "closeTimeFilter":{"shape":"ExecutionTimeFilter"}, + "executionFilter":{"shape":"WorkflowExecutionFilter"}, + "closeStatusFilter":{"shape":"CloseStatusFilter"}, + "typeFilter":{"shape":"WorkflowTypeFilter"}, + "tagFilter":{"shape":"TagFilter"}, + "nextPageToken":{"shape":"PageToken"}, + "maximumPageSize":{"shape":"PageSize"}, + "reverseOrder":{"shape":"ReverseOrder"} + } + }, + "ListDomainsInput":{ + "type":"structure", + "required":["registrationStatus"], + "members":{ + "nextPageToken":{"shape":"PageToken"}, + "registrationStatus":{"shape":"RegistrationStatus"}, + "maximumPageSize":{"shape":"PageSize"}, + "reverseOrder":{"shape":"ReverseOrder"} + } + }, + "ListOpenWorkflowExecutionsInput":{ + "type":"structure", + "required":[ + "domain", + "startTimeFilter" + ], + "members":{ + "domain":{"shape":"DomainName"}, + "startTimeFilter":{"shape":"ExecutionTimeFilter"}, + "typeFilter":{"shape":"WorkflowTypeFilter"}, + "tagFilter":{"shape":"TagFilter"}, + "nextPageToken":{"shape":"PageToken"}, + "maximumPageSize":{"shape":"PageSize"}, + "reverseOrder":{"shape":"ReverseOrder"}, + "executionFilter":{"shape":"WorkflowExecutionFilter"} + } + }, + "ListWorkflowTypesInput":{ + "type":"structure", + "required":[ + "domain", + "registrationStatus" + ], + "members":{ + "domain":{"shape":"DomainName"}, + "name":{"shape":"Name"}, + "registrationStatus":{"shape":"RegistrationStatus"}, + "nextPageToken":{"shape":"PageToken"}, + "maximumPageSize":{"shape":"PageSize"}, + "reverseOrder":{"shape":"ReverseOrder"} + } + }, + "MarkerName":{ + "type":"string", + "min":1, + "max":256 + }, + "MarkerRecordedEventAttributes":{ + "type":"structure", + "required":[ + "markerName", + "decisionTaskCompletedEventId" + ], + "members":{ + "markerName":{"shape":"MarkerName"}, + "details":{"shape":"Data"}, + "decisionTaskCompletedEventId":{"shape":"EventId"} + } + }, + "Name":{ + "type":"string", + "min":1, + "max":256 + }, + "OpenDecisionTasksCount":{ + "type":"integer", + "min":0, + "max":1 + }, + "OperationNotPermittedFault":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true + }, + "PageSize":{ + "type":"integer", + "min":0, + "max":1000 + }, + "PageToken":{ + "type":"string", + "max":2048 + }, + "PendingTaskCount":{ + "type":"structure", + "required":["count"], + "members":{ + "count":{"shape":"Count"}, + "truncated":{"shape":"Truncated"} + } + }, + "PollForActivityTaskInput":{ + "type":"structure", + "required":[ + "domain", + "taskList" + ], + "members":{ + "domain":{"shape":"DomainName"}, + "taskList":{"shape":"TaskList"}, + "identity":{"shape":"Identity"} + } + }, + "PollForDecisionTaskInput":{ + "type":"structure", + "required":[ + "domain", + "taskList" + ], + "members":{ + "domain":{"shape":"DomainName"}, + "taskList":{"shape":"TaskList"}, + "identity":{"shape":"Identity"}, + "nextPageToken":{"shape":"PageToken"}, + "maximumPageSize":{"shape":"PageSize"}, + "reverseOrder":{"shape":"ReverseOrder"} + } + }, + "RecordActivityTaskHeartbeatInput":{ + "type":"structure", + "required":["taskToken"], + "members":{ + "taskToken":{"shape":"TaskToken"}, + "details":{"shape":"LimitedData"} + } + }, + "RecordMarkerDecisionAttributes":{ + "type":"structure", + "required":["markerName"], + "members":{ + "markerName":{"shape":"MarkerName"}, + "details":{"shape":"Data"} + } + }, + "RecordMarkerFailedCause":{ + "type":"string", + "enum":["OPERATION_NOT_PERMITTED"] + }, + "RecordMarkerFailedEventAttributes":{ + "type":"structure", + "required":[ + "markerName", + "cause", + "decisionTaskCompletedEventId" + ], + "members":{ + "markerName":{"shape":"MarkerName"}, + "cause":{"shape":"RecordMarkerFailedCause"}, + "decisionTaskCompletedEventId":{"shape":"EventId"} + } + }, + "RegisterActivityTypeInput":{ + "type":"structure", + "required":[ + "domain", + "name", + "version" + ], + "members":{ + "domain":{"shape":"DomainName"}, + "name":{"shape":"Name"}, + "version":{"shape":"Version"}, + "description":{"shape":"Description"}, + "defaultTaskStartToCloseTimeout":{"shape":"DurationInSecondsOptional"}, + "defaultTaskHeartbeatTimeout":{"shape":"DurationInSecondsOptional"}, + "defaultTaskList":{"shape":"TaskList"}, + "defaultTaskPriority":{"shape":"TaskPriority"}, + "defaultTaskScheduleToStartTimeout":{"shape":"DurationInSecondsOptional"}, + "defaultTaskScheduleToCloseTimeout":{"shape":"DurationInSecondsOptional"} + } + }, + "RegisterDomainInput":{ + "type":"structure", + "required":[ + "name", + "workflowExecutionRetentionPeriodInDays" + ], + "members":{ + "name":{"shape":"DomainName"}, + "description":{"shape":"Description"}, + "workflowExecutionRetentionPeriodInDays":{"shape":"DurationInDays"} + } + }, + "RegisterWorkflowTypeInput":{ + "type":"structure", + "required":[ + "domain", + "name", + "version" + ], + "members":{ + "domain":{"shape":"DomainName"}, + "name":{"shape":"Name"}, + "version":{"shape":"Version"}, + "description":{"shape":"Description"}, + "defaultTaskStartToCloseTimeout":{"shape":"DurationInSecondsOptional"}, + "defaultExecutionStartToCloseTimeout":{"shape":"DurationInSecondsOptional"}, + "defaultTaskList":{"shape":"TaskList"}, + "defaultTaskPriority":{"shape":"TaskPriority"}, + "defaultChildPolicy":{"shape":"ChildPolicy"}, + "defaultLambdaRole":{"shape":"Arn"} + } + }, + "RegistrationStatus":{ + "type":"string", + "enum":[ + "REGISTERED", + "DEPRECATED" + ] + }, + "RequestCancelActivityTaskDecisionAttributes":{ + "type":"structure", + "required":["activityId"], + "members":{ + "activityId":{"shape":"ActivityId"} + } + }, + "RequestCancelActivityTaskFailedCause":{ + "type":"string", + "enum":[ + "ACTIVITY_ID_UNKNOWN", + "OPERATION_NOT_PERMITTED" + ] + }, + "RequestCancelActivityTaskFailedEventAttributes":{ + "type":"structure", + "required":[ + "activityId", + "cause", + "decisionTaskCompletedEventId" + ], + "members":{ + "activityId":{"shape":"ActivityId"}, + "cause":{"shape":"RequestCancelActivityTaskFailedCause"}, + "decisionTaskCompletedEventId":{"shape":"EventId"} + } + }, + "RequestCancelExternalWorkflowExecutionDecisionAttributes":{ + "type":"structure", + "required":["workflowId"], + "members":{ + "workflowId":{"shape":"WorkflowId"}, + "runId":{"shape":"RunIdOptional"}, + "control":{"shape":"Data"} + } + }, + "RequestCancelExternalWorkflowExecutionFailedCause":{ + "type":"string", + "enum":[ + "UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION", + "REQUEST_CANCEL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED", + "OPERATION_NOT_PERMITTED" + ] + }, + "RequestCancelExternalWorkflowExecutionFailedEventAttributes":{ + "type":"structure", + "required":[ + "workflowId", + "cause", + "initiatedEventId", + "decisionTaskCompletedEventId" + ], + "members":{ + "workflowId":{"shape":"WorkflowId"}, + "runId":{"shape":"RunIdOptional"}, + "cause":{"shape":"RequestCancelExternalWorkflowExecutionFailedCause"}, + "initiatedEventId":{"shape":"EventId"}, + "decisionTaskCompletedEventId":{"shape":"EventId"}, + "control":{"shape":"Data"} + } + }, + "RequestCancelExternalWorkflowExecutionInitiatedEventAttributes":{ + "type":"structure", + "required":[ + "workflowId", + "decisionTaskCompletedEventId" + ], + "members":{ + "workflowId":{"shape":"WorkflowId"}, + "runId":{"shape":"RunIdOptional"}, + "decisionTaskCompletedEventId":{"shape":"EventId"}, + "control":{"shape":"Data"} + } + }, + "RequestCancelWorkflowExecutionInput":{ + "type":"structure", + "required":[ + "domain", + "workflowId" + ], + "members":{ + "domain":{"shape":"DomainName"}, + "workflowId":{"shape":"WorkflowId"}, + "runId":{"shape":"RunIdOptional"} + } + }, + "RespondActivityTaskCanceledInput":{ + "type":"structure", + "required":["taskToken"], + "members":{ + "taskToken":{"shape":"TaskToken"}, + "details":{"shape":"Data"} + } + }, + "RespondActivityTaskCompletedInput":{ + "type":"structure", + "required":["taskToken"], + "members":{ + "taskToken":{"shape":"TaskToken"}, + "result":{"shape":"Data"} + } + }, + "RespondActivityTaskFailedInput":{ + "type":"structure", + "required":["taskToken"], + "members":{ + "taskToken":{"shape":"TaskToken"}, + "reason":{"shape":"FailureReason"}, + "details":{"shape":"Data"} + } + }, + "RespondDecisionTaskCompletedInput":{ + "type":"structure", + "required":["taskToken"], + "members":{ + "taskToken":{"shape":"TaskToken"}, + "decisions":{"shape":"DecisionList"}, + "executionContext":{"shape":"Data"} + } + }, + "ReverseOrder":{"type":"boolean"}, + "Run":{ + "type":"structure", + "members":{ + "runId":{"shape":"RunId"} + } + }, + "RunId":{ + "type":"string", + "min":1, + "max":64 + }, + "RunIdOptional":{ + "type":"string", + "max":64 + }, + "ScheduleActivityTaskDecisionAttributes":{ + "type":"structure", + "required":[ + "activityType", + "activityId" + ], + "members":{ + "activityType":{"shape":"ActivityType"}, + "activityId":{"shape":"ActivityId"}, + "control":{"shape":"Data"}, + "input":{"shape":"Data"}, + "scheduleToCloseTimeout":{"shape":"DurationInSecondsOptional"}, + "taskList":{"shape":"TaskList"}, + "taskPriority":{"shape":"TaskPriority"}, + "scheduleToStartTimeout":{"shape":"DurationInSecondsOptional"}, + "startToCloseTimeout":{"shape":"DurationInSecondsOptional"}, + "heartbeatTimeout":{"shape":"DurationInSecondsOptional"} + } + }, + "ScheduleActivityTaskFailedCause":{ + "type":"string", + "enum":[ + "ACTIVITY_TYPE_DEPRECATED", + "ACTIVITY_TYPE_DOES_NOT_EXIST", + "ACTIVITY_ID_ALREADY_IN_USE", + "OPEN_ACTIVITIES_LIMIT_EXCEEDED", + "ACTIVITY_CREATION_RATE_EXCEEDED", + "DEFAULT_SCHEDULE_TO_CLOSE_TIMEOUT_UNDEFINED", + "DEFAULT_TASK_LIST_UNDEFINED", + "DEFAULT_SCHEDULE_TO_START_TIMEOUT_UNDEFINED", + "DEFAULT_START_TO_CLOSE_TIMEOUT_UNDEFINED", + "DEFAULT_HEARTBEAT_TIMEOUT_UNDEFINED", + "OPERATION_NOT_PERMITTED" + ] + }, + "ScheduleActivityTaskFailedEventAttributes":{ + "type":"structure", + "required":[ + "activityType", + "activityId", + "cause", + "decisionTaskCompletedEventId" + ], + "members":{ + "activityType":{"shape":"ActivityType"}, + "activityId":{"shape":"ActivityId"}, + "cause":{"shape":"ScheduleActivityTaskFailedCause"}, + "decisionTaskCompletedEventId":{"shape":"EventId"} + } + }, + "ScheduleLambdaFunctionDecisionAttributes":{ + "type":"structure", + "required":[ + "id", + "name" + ], + "members":{ + "id":{"shape":"FunctionId"}, + "name":{"shape":"FunctionName"}, + "input":{"shape":"FunctionInput"}, + "startToCloseTimeout":{"shape":"DurationInSecondsOptional"} + } + }, + "ScheduleLambdaFunctionFailedCause":{ + "type":"string", + "enum":[ + "ID_ALREADY_IN_USE", + "OPEN_LAMBDA_FUNCTIONS_LIMIT_EXCEEDED", + "LAMBDA_FUNCTION_CREATION_RATE_EXCEEDED", + "LAMBDA_SERVICE_NOT_AVAILABLE_IN_REGION" + ] + }, + "ScheduleLambdaFunctionFailedEventAttributes":{ + "type":"structure", + "required":[ + "id", + "name", + "cause", + "decisionTaskCompletedEventId" + ], + "members":{ + "id":{"shape":"FunctionId"}, + "name":{"shape":"FunctionName"}, + "cause":{"shape":"ScheduleLambdaFunctionFailedCause"}, + "decisionTaskCompletedEventId":{"shape":"EventId"} + } + }, + "SignalExternalWorkflowExecutionDecisionAttributes":{ + "type":"structure", + "required":[ + "workflowId", + "signalName" + ], + "members":{ + "workflowId":{"shape":"WorkflowId"}, + "runId":{"shape":"RunIdOptional"}, + "signalName":{"shape":"SignalName"}, + "input":{"shape":"Data"}, + "control":{"shape":"Data"} + } + }, + "SignalExternalWorkflowExecutionFailedCause":{ + "type":"string", + "enum":[ + "UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION", + "SIGNAL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED", + "OPERATION_NOT_PERMITTED" + ] + }, + "SignalExternalWorkflowExecutionFailedEventAttributes":{ + "type":"structure", + "required":[ + "workflowId", + "cause", + "initiatedEventId", + "decisionTaskCompletedEventId" + ], + "members":{ + "workflowId":{"shape":"WorkflowId"}, + "runId":{"shape":"RunIdOptional"}, + "cause":{"shape":"SignalExternalWorkflowExecutionFailedCause"}, + "initiatedEventId":{"shape":"EventId"}, + "decisionTaskCompletedEventId":{"shape":"EventId"}, + "control":{"shape":"Data"} + } + }, + "SignalExternalWorkflowExecutionInitiatedEventAttributes":{ + "type":"structure", + "required":[ + "workflowId", + "signalName", + "decisionTaskCompletedEventId" + ], + "members":{ + "workflowId":{"shape":"WorkflowId"}, + "runId":{"shape":"RunIdOptional"}, + "signalName":{"shape":"SignalName"}, + "input":{"shape":"Data"}, + "decisionTaskCompletedEventId":{"shape":"EventId"}, + "control":{"shape":"Data"} + } + }, + "SignalName":{ + "type":"string", + "min":1, + "max":256 + }, + "SignalWorkflowExecutionInput":{ + "type":"structure", + "required":[ + "domain", + "workflowId", + "signalName" + ], + "members":{ + "domain":{"shape":"DomainName"}, + "workflowId":{"shape":"WorkflowId"}, + "runId":{"shape":"RunIdOptional"}, + "signalName":{"shape":"SignalName"}, + "input":{"shape":"Data"} + } + }, + "StartChildWorkflowExecutionDecisionAttributes":{ + "type":"structure", + "required":[ + "workflowType", + "workflowId" + ], + "members":{ + "workflowType":{"shape":"WorkflowType"}, + "workflowId":{"shape":"WorkflowId"}, + "control":{"shape":"Data"}, + "input":{"shape":"Data"}, + "executionStartToCloseTimeout":{"shape":"DurationInSecondsOptional"}, + "taskList":{"shape":"TaskList"}, + "taskPriority":{"shape":"TaskPriority"}, + "taskStartToCloseTimeout":{"shape":"DurationInSecondsOptional"}, + "childPolicy":{"shape":"ChildPolicy"}, + "tagList":{"shape":"TagList"}, + "lambdaRole":{"shape":"Arn"} + } + }, + "StartChildWorkflowExecutionFailedCause":{ + "type":"string", + "enum":[ + "WORKFLOW_TYPE_DOES_NOT_EXIST", + "WORKFLOW_TYPE_DEPRECATED", + "OPEN_CHILDREN_LIMIT_EXCEEDED", + "OPEN_WORKFLOWS_LIMIT_EXCEEDED", + "CHILD_CREATION_RATE_EXCEEDED", + "WORKFLOW_ALREADY_RUNNING", + "DEFAULT_EXECUTION_START_TO_CLOSE_TIMEOUT_UNDEFINED", + "DEFAULT_TASK_LIST_UNDEFINED", + "DEFAULT_TASK_START_TO_CLOSE_TIMEOUT_UNDEFINED", + "DEFAULT_CHILD_POLICY_UNDEFINED", + "OPERATION_NOT_PERMITTED" + ] + }, + "StartChildWorkflowExecutionFailedEventAttributes":{ + "type":"structure", + "required":[ + "workflowType", + "cause", + "workflowId", + "initiatedEventId", + "decisionTaskCompletedEventId" + ], + "members":{ + "workflowType":{"shape":"WorkflowType"}, + "cause":{"shape":"StartChildWorkflowExecutionFailedCause"}, + "workflowId":{"shape":"WorkflowId"}, + "initiatedEventId":{"shape":"EventId"}, + "decisionTaskCompletedEventId":{"shape":"EventId"}, + "control":{"shape":"Data"} + } + }, + "StartChildWorkflowExecutionInitiatedEventAttributes":{ + "type":"structure", + "required":[ + "workflowId", + "workflowType", + "taskList", + "decisionTaskCompletedEventId", + "childPolicy" + ], + "members":{ + "workflowId":{"shape":"WorkflowId"}, + "workflowType":{"shape":"WorkflowType"}, + "control":{"shape":"Data"}, + "input":{"shape":"Data"}, + "executionStartToCloseTimeout":{"shape":"DurationInSecondsOptional"}, + "taskList":{"shape":"TaskList"}, + "taskPriority":{"shape":"TaskPriority"}, + "decisionTaskCompletedEventId":{"shape":"EventId"}, + "childPolicy":{"shape":"ChildPolicy"}, + "taskStartToCloseTimeout":{"shape":"DurationInSecondsOptional"}, + "tagList":{"shape":"TagList"}, + "lambdaRole":{"shape":"Arn"} + } + }, + "StartLambdaFunctionFailedCause":{ + "type":"string", + "enum":["ASSUME_ROLE_FAILED"] + }, + "StartLambdaFunctionFailedEventAttributes":{ + "type":"structure", + "members":{ + "scheduledEventId":{"shape":"EventId"}, + "cause":{"shape":"StartLambdaFunctionFailedCause"}, + "message":{"shape":"CauseMessage"} + } + }, + "StartTimerDecisionAttributes":{ + "type":"structure", + "required":[ + "timerId", + "startToFireTimeout" + ], + "members":{ + "timerId":{"shape":"TimerId"}, + "control":{"shape":"Data"}, + "startToFireTimeout":{"shape":"DurationInSeconds"} + } + }, + "StartTimerFailedCause":{ + "type":"string", + "enum":[ + "TIMER_ID_ALREADY_IN_USE", + "OPEN_TIMERS_LIMIT_EXCEEDED", + "TIMER_CREATION_RATE_EXCEEDED", + "OPERATION_NOT_PERMITTED" + ] + }, + "StartTimerFailedEventAttributes":{ + "type":"structure", + "required":[ + "timerId", + "cause", + "decisionTaskCompletedEventId" + ], + "members":{ + "timerId":{"shape":"TimerId"}, + "cause":{"shape":"StartTimerFailedCause"}, + "decisionTaskCompletedEventId":{"shape":"EventId"} + } + }, + "StartWorkflowExecutionInput":{ + "type":"structure", + "required":[ + "domain", + "workflowId", + "workflowType" + ], + "members":{ + "domain":{"shape":"DomainName"}, + "workflowId":{"shape":"WorkflowId"}, + "workflowType":{"shape":"WorkflowType"}, + "taskList":{"shape":"TaskList"}, + "taskPriority":{"shape":"TaskPriority"}, + "input":{"shape":"Data"}, + "executionStartToCloseTimeout":{"shape":"DurationInSecondsOptional"}, + "tagList":{"shape":"TagList"}, + "taskStartToCloseTimeout":{"shape":"DurationInSecondsOptional"}, + "childPolicy":{"shape":"ChildPolicy"}, + "lambdaRole":{"shape":"Arn"} + } + }, + "Tag":{ + "type":"string", + "min":1, + "max":256 + }, + "TagFilter":{ + "type":"structure", + "required":["tag"], + "members":{ + "tag":{"shape":"Tag"} + } + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"}, + "max":5 + }, + "TaskList":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{"shape":"Name"} + } + }, + "TaskPriority":{ + "type":"string", + "max":11 + }, + "TaskToken":{ + "type":"string", + "min":1, + "max":1024 + }, + "TerminateReason":{ + "type":"string", + "max":256 + }, + "TerminateWorkflowExecutionInput":{ + "type":"structure", + "required":[ + "domain", + "workflowId" + ], + "members":{ + "domain":{"shape":"DomainName"}, + "workflowId":{"shape":"WorkflowId"}, + "runId":{"shape":"RunIdOptional"}, + "reason":{"shape":"TerminateReason"}, + "details":{"shape":"Data"}, + "childPolicy":{"shape":"ChildPolicy"} + } + }, + "TimerCanceledEventAttributes":{ + "type":"structure", + "required":[ + "timerId", + "startedEventId", + "decisionTaskCompletedEventId" + ], + "members":{ + "timerId":{"shape":"TimerId"}, + "startedEventId":{"shape":"EventId"}, + "decisionTaskCompletedEventId":{"shape":"EventId"} + } + }, + "TimerFiredEventAttributes":{ + "type":"structure", + "required":[ + "timerId", + "startedEventId" + ], + "members":{ + "timerId":{"shape":"TimerId"}, + "startedEventId":{"shape":"EventId"} + } + }, + "TimerId":{ + "type":"string", + "min":1, + "max":256 + }, + "TimerStartedEventAttributes":{ + "type":"structure", + "required":[ + "timerId", + "startToFireTimeout", + "decisionTaskCompletedEventId" + ], + "members":{ + "timerId":{"shape":"TimerId"}, + "control":{"shape":"Data"}, + "startToFireTimeout":{"shape":"DurationInSeconds"}, + "decisionTaskCompletedEventId":{"shape":"EventId"} + } + }, + "Timestamp":{"type":"timestamp"}, + "Truncated":{"type":"boolean"}, + "TypeAlreadyExistsFault":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true + }, + "TypeDeprecatedFault":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true + }, + "UnknownResourceFault":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true + }, + "Version":{ + "type":"string", + "min":1, + "max":64 + }, + "VersionOptional":{ + "type":"string", + "max":64 + }, + "WorkflowExecution":{ + "type":"structure", + "required":[ + "workflowId", + "runId" + ], + "members":{ + "workflowId":{"shape":"WorkflowId"}, + "runId":{"shape":"RunId"} + } + }, + "WorkflowExecutionAlreadyStartedFault":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true + }, + "WorkflowExecutionCancelRequestedCause":{ + "type":"string", + "enum":["CHILD_POLICY_APPLIED"] + }, + "WorkflowExecutionCancelRequestedEventAttributes":{ + "type":"structure", + "members":{ + "externalWorkflowExecution":{"shape":"WorkflowExecution"}, + "externalInitiatedEventId":{"shape":"EventId"}, + "cause":{"shape":"WorkflowExecutionCancelRequestedCause"} + } + }, + "WorkflowExecutionCanceledEventAttributes":{ + "type":"structure", + "required":["decisionTaskCompletedEventId"], + "members":{ + "details":{"shape":"Data"}, + "decisionTaskCompletedEventId":{"shape":"EventId"} + } + }, + "WorkflowExecutionCompletedEventAttributes":{ + "type":"structure", + "required":["decisionTaskCompletedEventId"], + "members":{ + "result":{"shape":"Data"}, + "decisionTaskCompletedEventId":{"shape":"EventId"} + } + }, + "WorkflowExecutionConfiguration":{ + "type":"structure", + "required":[ + "taskStartToCloseTimeout", + "executionStartToCloseTimeout", + "taskList", + "childPolicy" + ], + "members":{ + "taskStartToCloseTimeout":{"shape":"DurationInSeconds"}, + "executionStartToCloseTimeout":{"shape":"DurationInSeconds"}, + "taskList":{"shape":"TaskList"}, + "taskPriority":{"shape":"TaskPriority"}, + "childPolicy":{"shape":"ChildPolicy"}, + "lambdaRole":{"shape":"Arn"} + } + }, + "WorkflowExecutionContinuedAsNewEventAttributes":{ + "type":"structure", + "required":[ + "decisionTaskCompletedEventId", + "newExecutionRunId", + "taskList", + "childPolicy", + "workflowType" + ], + "members":{ + "input":{"shape":"Data"}, + "decisionTaskCompletedEventId":{"shape":"EventId"}, + "newExecutionRunId":{"shape":"RunId"}, + "executionStartToCloseTimeout":{"shape":"DurationInSecondsOptional"}, + "taskList":{"shape":"TaskList"}, + "taskPriority":{"shape":"TaskPriority"}, + "taskStartToCloseTimeout":{"shape":"DurationInSecondsOptional"}, + "childPolicy":{"shape":"ChildPolicy"}, + "tagList":{"shape":"TagList"}, + "workflowType":{"shape":"WorkflowType"}, + "lambdaRole":{"shape":"Arn"} + } + }, + "WorkflowExecutionCount":{ + "type":"structure", + "required":["count"], + "members":{ + "count":{"shape":"Count"}, + "truncated":{"shape":"Truncated"} + } + }, + "WorkflowExecutionDetail":{ + "type":"structure", + "required":[ + "executionInfo", + "executionConfiguration", + "openCounts" + ], + "members":{ + "executionInfo":{"shape":"WorkflowExecutionInfo"}, + "executionConfiguration":{"shape":"WorkflowExecutionConfiguration"}, + "openCounts":{"shape":"WorkflowExecutionOpenCounts"}, + "latestActivityTaskTimestamp":{"shape":"Timestamp"}, + "latestExecutionContext":{"shape":"Data"} + } + }, + "WorkflowExecutionFailedEventAttributes":{ + "type":"structure", + "required":["decisionTaskCompletedEventId"], + "members":{ + "reason":{"shape":"FailureReason"}, + "details":{"shape":"Data"}, + "decisionTaskCompletedEventId":{"shape":"EventId"} + } + }, + "WorkflowExecutionFilter":{ + "type":"structure", + "required":["workflowId"], + "members":{ + "workflowId":{"shape":"WorkflowId"} + } + }, + "WorkflowExecutionInfo":{ + "type":"structure", + "required":[ + "execution", + "workflowType", + "startTimestamp", + "executionStatus" + ], + "members":{ + "execution":{"shape":"WorkflowExecution"}, + "workflowType":{"shape":"WorkflowType"}, + "startTimestamp":{"shape":"Timestamp"}, + "closeTimestamp":{"shape":"Timestamp"}, + "executionStatus":{"shape":"ExecutionStatus"}, + "closeStatus":{"shape":"CloseStatus"}, + "parent":{"shape":"WorkflowExecution"}, + "tagList":{"shape":"TagList"}, + "cancelRequested":{"shape":"Canceled"} + } + }, + "WorkflowExecutionInfoList":{ + "type":"list", + "member":{"shape":"WorkflowExecutionInfo"} + }, + "WorkflowExecutionInfos":{ + "type":"structure", + "required":["executionInfos"], + "members":{ + "executionInfos":{"shape":"WorkflowExecutionInfoList"}, + "nextPageToken":{"shape":"PageToken"} + } + }, + "WorkflowExecutionOpenCounts":{ + "type":"structure", + "required":[ + "openActivityTasks", + "openDecisionTasks", + "openTimers", + "openChildWorkflowExecutions" + ], + "members":{ + "openActivityTasks":{"shape":"Count"}, + "openDecisionTasks":{"shape":"OpenDecisionTasksCount"}, + "openTimers":{"shape":"Count"}, + "openChildWorkflowExecutions":{"shape":"Count"}, + "openLambdaFunctions":{"shape":"Count"} + } + }, + "WorkflowExecutionSignaledEventAttributes":{ + "type":"structure", + "required":["signalName"], + "members":{ + "signalName":{"shape":"SignalName"}, + "input":{"shape":"Data"}, + "externalWorkflowExecution":{"shape":"WorkflowExecution"}, + "externalInitiatedEventId":{"shape":"EventId"} + } + }, + "WorkflowExecutionStartedEventAttributes":{ + "type":"structure", + "required":[ + "childPolicy", + "taskList", + "workflowType" + ], + "members":{ + "input":{"shape":"Data"}, + "executionStartToCloseTimeout":{"shape":"DurationInSecondsOptional"}, + "taskStartToCloseTimeout":{"shape":"DurationInSecondsOptional"}, + "childPolicy":{"shape":"ChildPolicy"}, + "taskList":{"shape":"TaskList"}, + "workflowType":{"shape":"WorkflowType"}, + "tagList":{"shape":"TagList"}, + "taskPriority":{"shape":"TaskPriority"}, + "continuedExecutionRunId":{"shape":"RunIdOptional"}, + "parentWorkflowExecution":{"shape":"WorkflowExecution"}, + "parentInitiatedEventId":{"shape":"EventId"}, + "lambdaRole":{"shape":"Arn"} + } + }, + "WorkflowExecutionTerminatedCause":{ + "type":"string", + "enum":[ + "CHILD_POLICY_APPLIED", + "EVENT_LIMIT_EXCEEDED", + "OPERATOR_INITIATED" + ] + }, + "WorkflowExecutionTerminatedEventAttributes":{ + "type":"structure", + "required":["childPolicy"], + "members":{ + "reason":{"shape":"TerminateReason"}, + "details":{"shape":"Data"}, + "childPolicy":{"shape":"ChildPolicy"}, + "cause":{"shape":"WorkflowExecutionTerminatedCause"} + } + }, + "WorkflowExecutionTimedOutEventAttributes":{ + "type":"structure", + "required":[ + "timeoutType", + "childPolicy" + ], + "members":{ + "timeoutType":{"shape":"WorkflowExecutionTimeoutType"}, + "childPolicy":{"shape":"ChildPolicy"} + } + }, + "WorkflowExecutionTimeoutType":{ + "type":"string", + "enum":["START_TO_CLOSE"] + }, + "WorkflowId":{ + "type":"string", + "min":1, + "max":256 + }, + "WorkflowType":{ + "type":"structure", + "required":[ + "name", + "version" + ], + "members":{ + "name":{"shape":"Name"}, + "version":{"shape":"Version"} + } + }, + "WorkflowTypeConfiguration":{ + "type":"structure", + "members":{ + "defaultTaskStartToCloseTimeout":{"shape":"DurationInSecondsOptional"}, + "defaultExecutionStartToCloseTimeout":{"shape":"DurationInSecondsOptional"}, + "defaultTaskList":{"shape":"TaskList"}, + "defaultTaskPriority":{"shape":"TaskPriority"}, + "defaultChildPolicy":{"shape":"ChildPolicy"}, + "defaultLambdaRole":{"shape":"Arn"} + } + }, + "WorkflowTypeDetail":{ + "type":"structure", + "required":[ + "typeInfo", + "configuration" + ], + "members":{ + "typeInfo":{"shape":"WorkflowTypeInfo"}, + "configuration":{"shape":"WorkflowTypeConfiguration"} + } + }, + "WorkflowTypeFilter":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{"shape":"Name"}, + "version":{"shape":"VersionOptional"} + } + }, + "WorkflowTypeInfo":{ + "type":"structure", + "required":[ + "workflowType", + "status", + "creationDate" + ], + "members":{ + "workflowType":{"shape":"WorkflowType"}, + "status":{"shape":"RegistrationStatus"}, + "description":{"shape":"Description"}, + "creationDate":{"shape":"Timestamp"}, + "deprecationDate":{"shape":"Timestamp"} + } + }, + "WorkflowTypeInfoList":{ + "type":"list", + "member":{"shape":"WorkflowTypeInfo"} + }, + "WorkflowTypeInfos":{ + "type":"structure", + "required":["typeInfos"], + "members":{ + "typeInfos":{"shape":"WorkflowTypeInfoList"}, + "nextPageToken":{"shape":"PageToken"} + } + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/swf/2012-01-25/docs-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/swf/2012-01-25/docs-2.json new file mode 100644 index 000000000..b2b5d16ca --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/swf/2012-01-25/docs-2.json @@ -0,0 +1,1695 @@ +{ + "version": "2.0", + "operations": { + "CountClosedWorkflowExecutions": "Returns the number of closed workflow executions within the given domain that meet the specified filtering criteria.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.Condition element with the appropriate keys. tagFilter.tag: String constraint. The key is swf:tagFilter.tag.typeFilter.name: String constraint. The key is swf:typeFilter.name.typeFilter.version: String constraint. The key is swf:typeFilter.version.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
", + "CountOpenWorkflowExecutions": "Returns the number of open workflow executions within the given domain that meet the specified filtering criteria.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.Condition element with the appropriate keys. tagFilter.tag: String constraint. The key is swf:tagFilter.tag.typeFilter.name: String constraint. The key is swf:typeFilter.name.typeFilter.version: String constraint. The key is swf:typeFilter.version.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
", + "CountPendingActivityTasks": "Returns the estimated number of activity tasks in the specified task list. The count returned is an approximation and is not guaranteed to be exact. If you specify a task list that no activity task was ever scheduled in then 0 will be returned.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
", + "CountPendingDecisionTasks": "Returns the estimated number of decision tasks in the specified task list. The count returned is an approximation and is not guaranteed to be exact. If you specify a task list that no decision task was ever scheduled in then 0 will be returned.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
", + "DeprecateActivityType": "Deprecates the specified activity type. After an activity type has been deprecated, you cannot create new tasks of that activity type. Tasks of this type that were scheduled before the type was deprecated will continue to run.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.Condition element with the appropriate keys. activityType.name: String constraint. The key is swf:activityType.name.activityType.version: String constraint. The key is swf:activityType.version.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
", + "DeprecateDomain": "Deprecates the specified domain. After a domain has been deprecated it cannot be used to create new workflow executions or register new types. However, you can still use visibility actions on this domain. Deprecating a domain also deprecates all activity and workflow types registered in the domain. Executions that were started before the domain was deprecated will continue to run.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
", + "DeprecateWorkflowType": "Deprecates the specified workflow type. After a workflow type has been deprecated, you cannot create new executions of that type. Executions that were started before the type was deprecated will continue to run. A deprecated workflow type may still be used when calling visibility actions.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.Condition element with the appropriate keys. workflowType.name: String constraint. The key is swf:workflowType.name.workflowType.version: String constraint. The key is swf:workflowType.version.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
", + "DescribeActivityType": "Returns information about the specified activity type. This includes configuration settings provided when the type was registered and other general information about the type.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.Condition element with the appropriate keys. activityType.name: String constraint. The key is swf:activityType.name.activityType.version: String constraint. The key is swf:activityType.version.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
", + "DescribeDomain": "Returns information about the specified domain, including description and status.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
", + "DescribeWorkflowExecution": "Returns information about the specified workflow execution including its type and some statistics.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
", + "DescribeWorkflowType": "Returns information about the specified workflow type. This includes configuration settings specified when the type was registered and other information such as creation date, current status, and so on.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.Condition element with the appropriate keys. workflowType.name: String constraint. The key is swf:workflowType.name.workflowType.version: String constraint. The key is swf:workflowType.version.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
", + "GetWorkflowExecutionHistory": "Returns the history of the specified workflow execution. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
", + "ListActivityTypes": "Returns information about all activities registered in the specified domain that match the specified name and registration status. The result includes information like creation date, current status of the activity, etc. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
", + "ListClosedWorkflowExecutions": "Returns a list of closed workflow executions in the specified domain that meet the filtering criteria. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.Condition element with the appropriate keys. tagFilter.tag: String constraint. The key is swf:tagFilter.tag.typeFilter.name: String constraint. The key is swf:typeFilter.name.typeFilter.version: String constraint. The key is swf:typeFilter.version.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
", + "ListDomains": "Returns the list of domains registered in the account. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains. The element must be set to arn:aws:swf::AccountID:domain/*, where AccountID is the account ID, with no dashes.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
", + "ListOpenWorkflowExecutions": "Returns a list of open workflow executions in the specified domain that meet the filtering criteria. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.Condition element with the appropriate keys. tagFilter.tag: String constraint. The key is swf:tagFilter.tag.typeFilter.name: String constraint. The key is swf:typeFilter.name.typeFilter.version: String constraint. The key is swf:typeFilter.version.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
", + "ListWorkflowTypes": "Returns information about workflow types in the specified domain. The results may be split into multiple pages that can be retrieved by making the call repeatedly.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
", + "PollForActivityTask": "Used by workers to get an ActivityTask from the specified activity taskList. This initiates a long poll, where the service holds the HTTP connection open and responds as soon as a task becomes available. The maximum time the service holds on to the request before responding is 60 seconds. If no task is available within 60 seconds, the poll will return an empty result. An empty result, in this context, means that an ActivityTask is returned, but that the value of taskToken is an empty string. If a task is returned, the worker should use its type to identify and process it correctly.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
", + "PollForDecisionTask": "Used by deciders to get a DecisionTask from the specified decision taskList. A decision task may be returned for any open workflow execution that is using the specified task list. The task includes a paginated view of the history of the workflow execution. The decider should use the workflow type and the history to determine how to properly handle the task.
This action initiates a long poll, where the service holds the HTTP connection open and responds as soon a task becomes available. If no decision task is available in the specified task list before the timeout of 60 seconds expires, an empty result is returned. An empty result, in this context, means that a DecisionTask is returned, but that the value of taskToken is an empty string.
PollForDecisionTask using the nextPageToken returned by the initial call. Note that you do not call GetWorkflowExecutionHistory with this nextPageToken. Instead, call PollForDecisionTask again.Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
", + "RecordActivityTaskHeartbeat": "Used by activity workers to report to the service that the ActivityTask represented by the specified taskToken is still making progress. The worker can also (optionally) specify details of the progress, for example percent complete, using the details parameter. This action can also be used by the worker as a mechanism to check if cancellation is being requested for the activity task. If a cancellation is being attempted for the specified task, then the boolean cancelRequested flag returned by the service is set to true.
This action resets the taskHeartbeatTimeout clock. The taskHeartbeatTimeout is specified in RegisterActivityType.
This action does not in itself create an event in the workflow execution history. However, if the task times out, the workflow execution history will contain a ActivityTaskTimedOut event that contains the information from the last heartbeat generated by the activity worker.
taskStartToCloseTimeout of an activity type is the maximum duration of an activity task, regardless of the number of RecordActivityTaskHeartbeat requests received. The taskStartToCloseTimeout is also specified in RegisterActivityType.cancelRequested flag returns true, a cancellation is being attempted. If the worker can cancel the activity, it should respond with RespondActivityTaskCanceled. Otherwise, it should ignore the cancellation request.Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
", + "RegisterActivityType": "Registers a new activity type along with its configuration settings in the specified domain.
TypeAlreadyExists fault is returned if the type already exists in the domain. You cannot change any configuration settings of the type after its registration, and it must be registered as a new version.Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.Condition element with the appropriate keys. defaultTaskList.name: String constraint. The key is swf:defaultTaskList.name.name: String constraint. The key is swf:name.version: String constraint. The key is swf:version.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
", + "RegisterDomain": "Registers a new domain.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
", + "RegisterWorkflowType": "Registers a new workflow type and its configuration settings in the specified domain.
The retention period for the workflow history is set by the RegisterDomain action.
TypeAlreadyExists fault is returned. You cannot change the configuration settings of a workflow type once it is registered and it must be registered as a new version.Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.Condition element with the appropriate keys. defaultTaskList.name: String constraint. The key is swf:defaultTaskList.name.name: String constraint. The key is swf:name.version: String constraint. The key is swf:version.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
", + "RequestCancelWorkflowExecution": "Records a WorkflowExecutionCancelRequested event in the currently running workflow execution identified by the given domain, workflowId, and runId. This logically requests the cancellation of the workflow execution as a whole. It is up to the decider to take appropriate actions when it receives an execution history with this event.
WorkflowExecutionCancelRequested event is recorded in the history of the current open workflow execution with the specified workflowId in the domain.Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
", + "RespondActivityTaskCanceled": "Used by workers to tell the service that the ActivityTask identified by the taskToken was successfully canceled. Additional details can be optionally provided using the details argument.
These details (if provided) appear in the ActivityTaskCanceled event added to the workflow history.
canceled flag of a RecordActivityTaskHeartbeat request returns true and if the activity can be safely undone or abandoned.A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed out.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
", + "RespondActivityTaskCompleted": "Used by workers to tell the service that the ActivityTask identified by the taskToken completed successfully with a result (if provided). The result appears in the ActivityTaskCompleted event in the workflow history.
canceled flag returned by RecordActivityTaskHeartbeat, it should cancel the task, clean up and then call RespondActivityTaskCanceled.A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed out.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
", + "RespondActivityTaskFailed": "Used by workers to tell the service that the ActivityTask identified by the taskToken has failed with reason (if specified). The reason and details appear in the ActivityTaskFailed event added to the workflow history.
A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed out.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
", + "RespondDecisionTaskCompleted": "Used by deciders to tell the service that the DecisionTask identified by the taskToken has successfully completed. The decisions argument specifies the list of decisions made while processing the task.
A DecisionTaskCompleted event is added to the workflow history. The executionContext specified is attached to the event in the workflow execution history.
Access Control
If an IAM policy grants permission to use RespondDecisionTaskCompleted, it can express permissions for the list of decisions in the decisions parameter. Each of the decisions has one or more parameters, much like a regular API call. To allow for policies to be as readable as possible, you can express permissions on decisions as if they were actual API calls, including applying conditions to some parameters. For more information, see Using IAM to Manage Access to Amazon SWF Workflows.
Records a WorkflowExecutionSignaled event in the workflow execution history and creates a decision task for the workflow execution identified by the given domain, workflowId and runId. The event is recorded with the specified user defined signalName and input (if provided).
WorkflowExecutionSignaled event is recorded in the history of the current open workflow with the matching workflowId in the domain.UnknownResource.Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
", + "StartWorkflowExecution": "Starts an execution of the workflow type in the specified domain using the provided workflowId and input data.
This action returns the newly started workflow execution.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.Condition element with the appropriate keys. tagList.member.0: The key is swf:tagList.member.0.tagList.member.1: The key is swf:tagList.member.1.tagList.member.2: The key is swf:tagList.member.2.tagList.member.3: The key is swf:tagList.member.3.tagList.member.4: The key is swf:tagList.member.4.taskList: String constraint. The key is swf:taskList.name.workflowType.name: String constraint. The key is swf:workflowType.name.workflowType.version: String constraint. The key is swf:workflowType.version.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
", + "TerminateWorkflowExecution": "Records a WorkflowExecutionTerminated event and forces closure of the workflow execution identified by the given domain, runId, and workflowId. The child policy, registered with the workflow type or specified when starting this execution, is applied to any open child workflow executions of this workflow execution.
WorkflowExecutionTerminated event is recorded in the history of the current open workflow with the matching workflowId in the domain.Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
" + }, + "service": "The Amazon Simple Workflow Service (Amazon SWF) makes it easy to build applications that use Amazon's cloud to coordinate work across distributed components. In Amazon SWF, a task represents a logical unit of work that is performed by a component of your workflow. Coordinating tasks in a workflow involves managing intertask dependencies, scheduling, and concurrency in accordance with the logical flow of the application.
Amazon SWF gives you full control over implementing tasks and coordinating them without worrying about underlying complexities such as tracking their progress and maintaining their state.
This documentation serves as reference only. For a broader overview of the Amazon SWF programming model, see the Amazon SWF Developer Guide.
", + "shapes": { + "ActivityId": { + "base": null, + "refs": { + "ActivityTask$activityId": "The unique ID of the task.
", + "ActivityTaskCancelRequestedEventAttributes$activityId": "The unique ID of the task.
", + "ActivityTaskScheduledEventAttributes$activityId": "The unique ID of the activity task.
", + "RequestCancelActivityTaskDecisionAttributes$activityId": "The activityId of the activity task to be canceled.
The activityId provided in the RequestCancelActivityTask decision that failed.
Required. The activityId of the activity task.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string quotarnquot.
The activityId provided in the ScheduleActivityTask decision that failed.
Unit of work sent to an activity worker.
", + "refs": { + } + }, + "ActivityTaskCancelRequestedEventAttributes": { + "base": "Provides details of the ActivityTaskCancelRequested event.
If the event is of type ActivityTaskcancelRequested then this member is set and provides detailed information about the event. It is not set for other event types.
Provides details of the ActivityTaskCanceled event.
If the event is of type ActivityTaskCanceled then this member is set and provides detailed information about the event. It is not set for other event types.
Provides details of the ActivityTaskCompleted event.
If the event is of type ActivityTaskCompleted then this member is set and provides detailed information about the event. It is not set for other event types.
Provides details of the ActivityTaskFailed event.
If the event is of type ActivityTaskFailed then this member is set and provides detailed information about the event. It is not set for other event types.
Provides details of the ActivityTaskScheduled event.
If the event is of type ActivityTaskScheduled then this member is set and provides detailed information about the event. It is not set for other event types.
Provides details of the ActivityTaskStarted event.
If the event is of type ActivityTaskStarted then this member is set and provides detailed information about the event. It is not set for other event types.
Status information about an activity task.
", + "refs": { + } + }, + "ActivityTaskTimedOutEventAttributes": { + "base": "Provides details of the ActivityTaskTimedOut event.
If the event is of type ActivityTaskTimedOut then this member is set and provides detailed information about the event. It is not set for other event types.
The type of the timeout that caused this event.
" + } + }, + "ActivityType": { + "base": "Represents an activity type.
", + "refs": { + "ActivityTask$activityType": "The type of this activity task.
", + "ActivityTaskScheduledEventAttributes$activityType": "The type of the activity task.
", + "ActivityTypeInfo$activityType": "The ActivityType type structure representing the activity type.
", + "DeprecateActivityTypeInput$activityType": "The activity type to deprecate.
", + "DescribeActivityTypeInput$activityType": "The activity type to get information about. Activity types are identified by the name and version that were supplied when the activity was registered.
Required. The type of the activity task to schedule.
", + "ScheduleActivityTaskFailedEventAttributes$activityType": "The activity type provided in the ScheduleActivityTask decision that failed.
Configuration settings registered with the activity type.
", + "refs": { + "ActivityTypeDetail$configuration": "The configuration settings registered with the activity type.
" + } + }, + "ActivityTypeDetail": { + "base": "Detailed information about an activity type.
", + "refs": { + } + }, + "ActivityTypeInfo": { + "base": "Detailed information about an activity type.
", + "refs": { + "ActivityTypeDetail$typeInfo": "General information about the activity type.
The status of activity type (returned in the ActivityTypeInfo structure) can be one of the following.
List of activity type information.
" + } + }, + "ActivityTypeInfos": { + "base": "Contains a paginated list of activity type information structures.
", + "refs": { + } + }, + "Arn": { + "base": null, + "refs": { + "ContinueAsNewWorkflowExecutionDecisionAttributes$lambdaRole": "The ARN of an IAM role that authorizes Amazon SWF to invoke AWS Lambda functions.
The ARN of the default IAM role to use when a workflow execution of this type invokes AWS Lambda functions.
This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution and ContinueAsNewWorkflowExecution decision.
The ARN of an IAM role that authorizes Amazon SWF to invoke AWS Lambda functions.
The IAM role attached to this workflow execution to use when invoking AWS Lambda functions.
", + "StartWorkflowExecutionInput$lambdaRole": "The ARN of an IAM role that authorizes Amazon SWF to invoke AWS Lambda functions.
The IAM role used by this workflow execution when invoking AWS Lambda functions.
", + "WorkflowExecutionContinuedAsNewEventAttributes$lambdaRole": "The IAM role attached to this workflow execution to use when invoking AWS Lambda functions.
", + "WorkflowExecutionStartedEventAttributes$lambdaRole": "The IAM role attached to this workflow execution to use when invoking AWS Lambda functions.
", + "WorkflowTypeConfiguration$defaultLambdaRole": "The default IAM role to use when a workflow execution invokes a AWS Lambda function.
" + } + }, + "CancelTimerDecisionAttributes": { + "base": "Provides details of the CancelTimer decision.
Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
", + "refs": { + "Decision$cancelTimerDecisionAttributes": "Provides details of the CancelTimer decision. It is not set for other decision types.
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
Provides details of the CancelTimerFailed event.
If the event is of type CancelTimerFailed then this member is set and provides detailed information about the event. It is not set for other event types.
Provides details of the CancelWorkflowExecution decision.
Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
", + "refs": { + "Decision$cancelWorkflowExecutionDecisionAttributes": "Provides details of the CancelWorkflowExecution decision. It is not set for other decision types.
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
Provides details of the CancelWorkflowExecutionFailed event.
If the event is of type CancelWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.
Set to true if cancellation of the task is requested.
Set to true if a cancellation is requested for this workflow execution.
" + } + }, + "CauseMessage": { + "base": null, + "refs": { + "StartLambdaFunctionFailedEventAttributes$message": "The error message (if any).
" + } + }, + "ChildPolicy": { + "base": null, + "refs": { + "ContinueAsNewWorkflowExecutionDecisionAttributes$childPolicy": "If set, specifies the policy to use for the child workflow executions of the new execution if it is terminated by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.
The supported child policies are:
WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.If set, specifies the default policy to use for the child workflow executions when a workflow execution of this type is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution decision.
The supported child policies are:
WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.Optional. If set, specifies the policy to use for the child workflow executions if the workflow execution being started is terminated by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.
The supported child policies are:
WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.The policy to use for the child workflow executions if this execution gets terminated by explicitly calling the TerminateWorkflowExecution action or due to an expired timeout.
The supported child policies are:
WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.If set, specifies the policy to use for the child workflow executions of this workflow execution if it is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.
The supported child policies are:
WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.If set, specifies the policy to use for the child workflow executions of the workflow execution being terminated. This policy overrides the child policy specified for the workflow execution at registration time or when starting the execution.
The supported child policies are:
WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.The policy to use for the child workflow executions if this workflow execution is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.
The supported child policies are:
WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.The policy to use for the child workflow executions of the new execution if it is terminated by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.
The supported child policies are:
WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.The policy to use for the child workflow executions if this workflow execution is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.
The supported child policies are:
WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.The policy used for the child workflow executions of this workflow execution.
The supported child policies are:
WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.The policy used for the child workflow executions of this workflow execution.
The supported child policies are:
WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.Optional. The default policy to use for the child workflow executions when a workflow execution of this type is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution decision.
The supported child policies are:
WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.Provide details of the ChildWorkflowExecutionCanceled event.
If the event is of type ChildWorkflowExecutionCanceled then this member is set and provides detailed information about the event. It is not set for other event types.
Provides details of the ChildWorkflowExecutionCompleted event.
If the event is of type ChildWorkflowExecutionCompleted then this member is set and provides detailed information about the event. It is not set for other event types.
Provides details of the ChildWorkflowExecutionFailed event.
If the event is of type ChildWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.
Provides details of the ChildWorkflowExecutionStarted event.
If the event is of type ChildWorkflowExecutionStarted then this member is set and provides detailed information about the event. It is not set for other event types.
Provides details of the ChildWorkflowExecutionTerminated event.
If the event is of type ChildWorkflowExecutionTerminated then this member is set and provides detailed information about the event. It is not set for other event types.
Provides details of the ChildWorkflowExecutionTimedOut event.
If the event is of type ChildWorkflowExecutionTimedOut then this member is set and provides detailed information about the event. It is not set for other event types.
Required. The close status that must match the close status of an execution for it to meet the criteria of this filter.
", + "WorkflowExecutionInfo$closeStatus": "If the execution status is closed then this specifies how the execution was closed:
COMPLETED: the execution was successfully completed.CANCELED: the execution was canceled.Cancellation allows the implementation to gracefully clean up before the execution is closed.TERMINATED: the execution was force terminated.FAILED: the execution failed to complete.TIMED_OUT: the execution did not complete in the alloted time and was automatically timed out.CONTINUED_AS_NEW: the execution is logically continued. This means the current execution was completed and a new execution was started to carry on the workflow.Used to filter the closed workflow executions in visibility APIs by their close status.
", + "refs": { + "CountClosedWorkflowExecutionsInput$closeStatusFilter": "If specified, only workflow executions that match this close status are counted. This filter has an affect only if executionStatus is specified as CLOSED.
closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.If specified, only workflow executions that match this close status are listed. For example, if TERMINATED is specified, then only TERMINATED workflow executions are listed.
closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.Provides details of the CompleteWorkflowExecution decision.
Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
", + "refs": { + "Decision$completeWorkflowExecutionDecisionAttributes": "Provides details of the CompleteWorkflowExecution decision. It is not set for other decision types.
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
Provides details of the CompleteWorkflowExecutionFailed event.
If the event is of type CompleteWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.
Provides details of the ContinueAsNewWorkflowExecution decision.
Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.Condition element with the appropriate keys. tag: Optional.. A tag used to identify the workflow executiontaskList: String constraint. The key is swf:taskList.name.workflowType.version: String constraint. The key is swf:workflowType.version.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
", + "refs": { + "Decision$continueAsNewWorkflowExecutionDecisionAttributes": "Provides details of the ContinueAsNewWorkflowExecution decision. It is not set for other decision types.
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
Provides details of the ContinueAsNewWorkflowExecutionFailed event.
If the event is of type ContinueAsNewWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.
The number of tasks in the task list.
", + "WorkflowExecutionCount$count": "The number of workflow executions.
", + "WorkflowExecutionOpenCounts$openActivityTasks": "The count of activity tasks whose status is OPEN.
", + "WorkflowExecutionOpenCounts$openTimers": "The count of timers started by this workflow execution that have not fired yet.
", + "WorkflowExecutionOpenCounts$openChildWorkflowExecutions": "The count of child workflow executions whose status is OPEN.
", + "WorkflowExecutionOpenCounts$openLambdaFunctions": "The count of AWS Lambda functions that are currently executing.
" + } + }, + "CountClosedWorkflowExecutionsInput": { + "base": null, + "refs": { + } + }, + "CountOpenWorkflowExecutionsInput": { + "base": null, + "refs": { + } + }, + "CountPendingActivityTasksInput": { + "base": null, + "refs": { + } + }, + "CountPendingDecisionTasksInput": { + "base": null, + "refs": { + } + }, + "Data": { + "base": null, + "refs": { + "ActivityTask$input": "The inputs provided when the activity task was scheduled. The form of the input is user defined and should be meaningful to the activity implementation.
", + "ActivityTaskCanceledEventAttributes$details": "Details of the cancellation (if any).
", + "ActivityTaskCompletedEventAttributes$result": "The results of the activity task (if any).
", + "ActivityTaskFailedEventAttributes$details": "The details of the failure (if any).
", + "ActivityTaskScheduledEventAttributes$input": "The input provided to the activity task.
", + "ActivityTaskScheduledEventAttributes$control": "Optional. Data attached to the event that can be used by the decider in subsequent workflow tasks. This data is not sent to the activity.
", + "CancelWorkflowExecutionDecisionAttributes$details": "Optional. details of the cancellation.
", + "ChildWorkflowExecutionCanceledEventAttributes$details": "Details of the cancellation (if provided).
", + "ChildWorkflowExecutionCompletedEventAttributes$result": "The result of the child workflow execution (if any).
", + "ChildWorkflowExecutionFailedEventAttributes$details": "The details of the failure (if provided).
", + "CompleteWorkflowExecutionDecisionAttributes$result": "The result of the workflow execution. The form of the result is implementation defined.
", + "ContinueAsNewWorkflowExecutionDecisionAttributes$input": "The input provided to the new workflow execution.
", + "DecisionTaskCompletedEventAttributes$executionContext": "User defined context for the workflow execution.
", + "FailWorkflowExecutionDecisionAttributes$details": "Optional. Details of the failure.
", + "LambdaFunctionCompletedEventAttributes$result": "The result of the function execution (if any).
", + "LambdaFunctionFailedEventAttributes$details": "The details of the failure (if any).
", + "MarkerRecordedEventAttributes$details": "Details of the marker (if any).
", + "RecordMarkerDecisionAttributes$details": "Optional. details of the marker.
", + "RequestCancelExternalWorkflowExecutionDecisionAttributes$control": "Optional. Data attached to the event that can be used by the decider in subsequent workflow tasks.
", + "RequestCancelExternalWorkflowExecutionFailedEventAttributes$control": null, + "RequestCancelExternalWorkflowExecutionInitiatedEventAttributes$control": "Optional. Data attached to the event that can be used by the decider in subsequent workflow tasks.
", + "RespondActivityTaskCanceledInput$details": "Optional. Information about the cancellation.
", + "RespondActivityTaskCompletedInput$result": "The result of the activity task. It is a free form string that is implementation specific.
", + "RespondActivityTaskFailedInput$details": "Optional. Detailed information about the failure.
", + "RespondDecisionTaskCompletedInput$executionContext": "User defined context to add to workflow execution.
", + "ScheduleActivityTaskDecisionAttributes$control": "Optional. Data attached to the event that can be used by the decider in subsequent workflow tasks. This data is not sent to the activity.
", + "ScheduleActivityTaskDecisionAttributes$input": "The input provided to the activity task.
", + "SignalExternalWorkflowExecutionDecisionAttributes$input": "Optional. Input data to be provided with the signal. The target workflow execution will use the signal name and input data to process the signal.
", + "SignalExternalWorkflowExecutionDecisionAttributes$control": "Optional. Data attached to the event that can be used by the decider in subsequent decision tasks.
", + "SignalExternalWorkflowExecutionFailedEventAttributes$control": null, + "SignalExternalWorkflowExecutionInitiatedEventAttributes$input": "Input provided to the signal (if any).
", + "SignalExternalWorkflowExecutionInitiatedEventAttributes$control": "Optional. data attached to the event that can be used by the decider in subsequent decision tasks.
", + "SignalWorkflowExecutionInput$input": "Data to attach to the WorkflowExecutionSignaled event in the target workflow execution's history.
Optional. Data attached to the event that can be used by the decider in subsequent workflow tasks. This data is not sent to the child workflow execution.
", + "StartChildWorkflowExecutionDecisionAttributes$input": "The input to be provided to the workflow execution.
", + "StartChildWorkflowExecutionFailedEventAttributes$control": null, + "StartChildWorkflowExecutionInitiatedEventAttributes$control": "Optional. Data attached to the event that can be used by the decider in subsequent decision tasks. This data is not sent to the activity.
", + "StartChildWorkflowExecutionInitiatedEventAttributes$input": "The inputs provided to the child workflow execution (if any).
", + "StartTimerDecisionAttributes$control": "Optional. Data attached to the event that can be used by the decider in subsequent workflow tasks.
", + "StartWorkflowExecutionInput$input": "The input for the workflow execution. This is a free form string which should be meaningful to the workflow you are starting. This input is made available to the new workflow execution in the WorkflowExecutionStarted history event.
Optional. Details for terminating the workflow execution.
", + "TimerStartedEventAttributes$control": "Optional. Data attached to the event that can be used by the decider in subsequent workflow tasks.
", + "WorkflowExecutionCanceledEventAttributes$details": "Details for the cancellation (if any).
", + "WorkflowExecutionCompletedEventAttributes$result": "The result produced by the workflow execution upon successful completion.
", + "WorkflowExecutionContinuedAsNewEventAttributes$input": "The input provided to the new workflow execution.
", + "WorkflowExecutionDetail$latestExecutionContext": "The latest executionContext provided by the decider for this workflow execution. A decider can provide an executionContext (a free-form string) when closing a decision task using RespondDecisionTaskCompleted.
", + "WorkflowExecutionFailedEventAttributes$details": "The details of the failure (if any).
", + "WorkflowExecutionSignaledEventAttributes$input": "Inputs provided with the signal (if any). The decider can use the signal name and inputs to determine how to process the signal.
", + "WorkflowExecutionStartedEventAttributes$input": "The input provided to the workflow execution (if any).
", + "WorkflowExecutionTerminatedEventAttributes$details": "The details provided for the termination (if any).
" + } + }, + "Decision": { + "base": "Specifies a decision made by the decider. A decision can be one of these types:
TimerCanceled event in the history.WorkflowExecutionCanceled event in the history.WorkflowExecutionCompleted event in the history .WorkflowExecutionContinuedAsNew event is recorded in the history.WorkflowExecutionFailed event in the history.MarkerRecorded event in the history. Markers can be used for adding custom information in the history for instance to let deciders know that they do not need to look at the history beyond the marker event.RequestCancelExternalWorkflowExecutionInitiated event in the history.SignalExternalWorkflowExecutionInitiated event in the history.StartChildWorkflowExecutionInitiated event in the history. The child workflow execution is a separate workflow execution with its own history.TimerStarted event in the history. This timer will fire after the specified delay and record a TimerFired event.Access Control
If you grant permission to use RespondDecisionTaskCompleted, you can use IAM policies to express permissions for the list of decisions returned by this action as if they were members of the API. Treating decisions as a pseudo API maintains a uniform conceptual model and helps keep policies readable. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
Decision Failure
Decisions can fail for several reasons
One of the following events might be added to the history to indicate an error. The event attribute's cause parameter indicates the cause. If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
workflowID specified in the decision was incorrect.workflowID specified in the decision was incorrect.The preceding error events might occur due to an error in the decider logic, which might put the workflow execution in an unstable state The cause field in the event structure for the error event indicates the cause of the error.
CompleteWorkflowExecution, FailWorkflowExecution, CancelWorkflowExecution and ContinueAsNewWorkflowExecution. An UnhandledDecision fault will be returned if a workflow closing decision is specified and a signal or activity event had been added to the history while the decision task was being performed by the decider. Unlike the above situations which are logic issues, this fault is always possible because of race conditions in a distributed system. The right action here is to call RespondDecisionTaskCompleted without any decisions. This would result in another decision task with these new events included in the history. The decider should handle the new events and may decide to close the workflow execution.How to code a decision
You code a decision by first setting the decision type field to one of the above decision values, and then set the corresponding attributes field shown below:
The list of decisions (possibly empty) made by the decider while processing this decision task. See the docs for the decision structure for details.
" + } + }, + "DecisionTask": { + "base": "A structure that represents a decision task. Decision tasks are sent to deciders in order for them to make decisions.
", + "refs": { + } + }, + "DecisionTaskCompletedEventAttributes": { + "base": "Provides details of the DecisionTaskCompleted event.
If the event is of type DecisionTaskCompleted then this member is set and provides detailed information about the event. It is not set for other event types.
Provides details about the DecisionTaskScheduled event.
If the event is of type DecisionTaskScheduled then this member is set and provides detailed information about the event. It is not set for other event types.
Provides details of the DecisionTaskStarted event.
If the event is of type DecisionTaskStarted then this member is set and provides detailed information about the event. It is not set for other event types.
Provides details of the DecisionTaskTimedOut event.
If the event is of type DecisionTaskTimedOut then this member is set and provides detailed information about the event. It is not set for other event types.
The type of timeout that expired before the decision task could be completed.
" + } + }, + "DecisionType": { + "base": null, + "refs": { + "Decision$decisionType": "Specifies the type of the decision.
" + } + }, + "DefaultUndefinedFault": { + "base": null, + "refs": { + } + }, + "DeprecateActivityTypeInput": { + "base": null, + "refs": { + } + }, + "DeprecateDomainInput": { + "base": null, + "refs": { + } + }, + "DeprecateWorkflowTypeInput": { + "base": null, + "refs": { + } + }, + "DescribeActivityTypeInput": { + "base": null, + "refs": { + } + }, + "DescribeDomainInput": { + "base": null, + "refs": { + } + }, + "DescribeWorkflowExecutionInput": { + "base": null, + "refs": { + } + }, + "DescribeWorkflowTypeInput": { + "base": null, + "refs": { + } + }, + "Description": { + "base": null, + "refs": { + "ActivityTypeInfo$description": "The description of the activity type provided in RegisterActivityType.
", + "DomainInfo$description": "The description of the domain provided through RegisterDomain.
", + "RegisterActivityTypeInput$description": "A textual description of the activity type.
", + "RegisterDomainInput$description": "A text description of the domain.
", + "RegisterWorkflowTypeInput$description": "Textual description of the workflow type.
", + "WorkflowTypeInfo$description": "The description of the type registered through RegisterWorkflowType.
" + } + }, + "DomainAlreadyExistsFault": { + "base": "Returned if the specified domain already exists. You will get this fault even if the existing domain is in deprecated status.
", + "refs": { + } + }, + "DomainConfiguration": { + "base": "Contains the configuration settings of a domain.
", + "refs": { + "DomainDetail$configuration": null + } + }, + "DomainDeprecatedFault": { + "base": "Returned when the specified domain has been deprecated.
", + "refs": { + } + }, + "DomainDetail": { + "base": "Contains details of a domain.
", + "refs": { + } + }, + "DomainInfo": { + "base": "Contains general information about a domain.
", + "refs": { + "DomainDetail$domainInfo": null, + "DomainInfoList$member": null + } + }, + "DomainInfoList": { + "base": null, + "refs": { + "DomainInfos$domainInfos": "A list of DomainInfo structures.
" + } + }, + "DomainInfos": { + "base": "Contains a paginated collection of DomainInfo structures.
", + "refs": { + } + }, + "DomainName": { + "base": null, + "refs": { + "CountClosedWorkflowExecutionsInput$domain": "The name of the domain containing the workflow executions to count.
", + "CountOpenWorkflowExecutionsInput$domain": "The name of the domain containing the workflow executions to count.
", + "CountPendingActivityTasksInput$domain": "The name of the domain that contains the task list.
", + "CountPendingDecisionTasksInput$domain": "The name of the domain that contains the task list.
", + "DeprecateActivityTypeInput$domain": "The name of the domain in which the activity type is registered.
", + "DeprecateDomainInput$name": "The name of the domain to deprecate.
", + "DeprecateWorkflowTypeInput$domain": "The name of the domain in which the workflow type is registered.
", + "DescribeActivityTypeInput$domain": "The name of the domain in which the activity type is registered.
", + "DescribeDomainInput$name": "The name of the domain to describe.
", + "DescribeWorkflowExecutionInput$domain": "The name of the domain containing the workflow execution.
", + "DescribeWorkflowTypeInput$domain": "The name of the domain in which this workflow type is registered.
", + "DomainInfo$name": "The name of the domain. This name is unique within the account.
", + "GetWorkflowExecutionHistoryInput$domain": "The name of the domain containing the workflow execution.
", + "ListActivityTypesInput$domain": "The name of the domain in which the activity types have been registered.
", + "ListClosedWorkflowExecutionsInput$domain": "The name of the domain that contains the workflow executions to list.
", + "ListOpenWorkflowExecutionsInput$domain": "The name of the domain that contains the workflow executions to list.
", + "ListWorkflowTypesInput$domain": "The name of the domain in which the workflow types have been registered.
", + "PollForActivityTaskInput$domain": "The name of the domain that contains the task lists being polled.
", + "PollForDecisionTaskInput$domain": "The name of the domain containing the task lists to poll.
", + "RegisterActivityTypeInput$domain": "The name of the domain in which this activity is to be registered.
", + "RegisterDomainInput$name": "Name of the domain to register. The name must be unique in the region that the domain is registered in.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string quotarnquot.
The name of the domain in which to register the workflow type.
", + "RequestCancelWorkflowExecutionInput$domain": "The name of the domain containing the workflow execution to cancel.
", + "SignalWorkflowExecutionInput$domain": "The name of the domain containing the workflow execution to signal.
", + "StartWorkflowExecutionInput$domain": "The name of the domain in which the workflow execution is created.
", + "TerminateWorkflowExecutionInput$domain": "The domain of the workflow execution to terminate.
" + } + }, + "DurationInDays": { + "base": null, + "refs": { + "DomainConfiguration$workflowExecutionRetentionPeriodInDays": "The retention period for workflow executions in this domain.
", + "RegisterDomainInput$workflowExecutionRetentionPeriodInDays": "The duration (in days) that records and histories of workflow executions on the domain should be kept by the service. After the retention period, the workflow execution is not available in the results of visibility calls.
If you pass the value NONE or 0 (zero), then the workflow execution history will not be retained. As soon as the workflow execution completes, the execution record and its history are deleted.
The maximum workflow execution retention period is 90 days. For more information about Amazon SWF service limits, see: Amazon SWF Service Limits in the Amazon SWF Developer Guide.
" + } + }, + "DurationInSeconds": { + "base": null, + "refs": { + "StartTimerDecisionAttributes$startToFireTimeout": "Required. The duration to wait before firing the timer.
The duration is specified in seconds; an integer greater than or equal to 0.
", + "TimerStartedEventAttributes$startToFireTimeout": "The duration of time after which the timer will fire.
The duration is specified in seconds; an integer greater than or equal to 0.
", + "WorkflowExecutionConfiguration$taskStartToCloseTimeout": "The maximum duration allowed for decision tasks for this workflow execution.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
", + "WorkflowExecutionConfiguration$executionStartToCloseTimeout": "The total duration for this workflow execution.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
" + } + }, + "DurationInSecondsOptional": { + "base": null, + "refs": { + "ActivityTaskScheduledEventAttributes$scheduleToStartTimeout": "The maximum amount of time the activity task can wait to be assigned to a worker.
", + "ActivityTaskScheduledEventAttributes$scheduleToCloseTimeout": "The maximum amount of time for this activity task.
", + "ActivityTaskScheduledEventAttributes$startToCloseTimeout": "The maximum amount of time a worker may take to process the activity task.
", + "ActivityTaskScheduledEventAttributes$heartbeatTimeout": "The maximum time before which the worker processing this task must report progress by calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out. If the worker subsequently attempts to record a heartbeat or return a result, it will be ignored.
", + "ActivityTypeConfiguration$defaultTaskStartToCloseTimeout": "Optional. The default maximum duration for tasks of an activity type specified when registering the activity type. You can override this default when scheduling a task through the ScheduleActivityTask decision.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
", + "ActivityTypeConfiguration$defaultTaskHeartbeatTimeout": "Optional. The default maximum time, in seconds, before which a worker processing a task must report progress by calling RecordActivityTaskHeartbeat.
You can specify this value only when registering an activity type. The registered default value can be overridden when you schedule a task through the ScheduleActivityTask decision. If the activity worker subsequently attempts to record a heartbeat or returns a result, the activity worker receives an UnknownResource fault. In this case, Amazon SWF no longer considers the activity task to be valid; the activity worker should clean up the activity task.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
", + "ActivityTypeConfiguration$defaultTaskScheduleToStartTimeout": "Optional. The default maximum duration, specified when registering the activity type, that a task of an activity type can wait before being assigned to a worker. You can override this default when scheduling a task through the ScheduleActivityTask decision.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
", + "ActivityTypeConfiguration$defaultTaskScheduleToCloseTimeout": "Optional. The default maximum duration, specified when registering the activity type, for tasks of this activity type. You can override this default when scheduling a task through the ScheduleActivityTask decision.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
", + "ContinueAsNewWorkflowExecutionDecisionAttributes$executionStartToCloseTimeout": "If set, specifies the total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
Specifies the maximum duration of decision tasks for the new workflow execution. This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
The maximum duration for this decision task. The task is considered timed out if it does not completed within this duration.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
", + "LambdaFunctionScheduledEventAttributes$startToCloseTimeout": "The maximum time, in seconds, that the AWS Lambda function can take to execute from start to close before it is marked as failed.
", + "RegisterActivityTypeInput$defaultTaskStartToCloseTimeout": "If set, specifies the default maximum duration that a worker can take to process tasks of this activity type. This default can be overridden when scheduling an activity task using the ScheduleActivityTask decision.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
", + "RegisterActivityTypeInput$defaultTaskHeartbeatTimeout": "If set, specifies the default maximum time before which a worker processing a task of this type must report progress by calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out. This default can be overridden when scheduling an activity task using the ScheduleActivityTask decision. If the activity worker subsequently attempts to record a heartbeat or returns a result, the activity worker receives an UnknownResource fault. In this case, Amazon SWF no longer considers the activity task to be valid; the activity worker should clean up the activity task.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
", + "RegisterActivityTypeInput$defaultTaskScheduleToStartTimeout": "If set, specifies the default maximum duration that a task of this activity type can wait before being assigned to a worker. This default can be overridden when scheduling an activity task using the ScheduleActivityTask decision.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
", + "RegisterActivityTypeInput$defaultTaskScheduleToCloseTimeout": "If set, specifies the default maximum duration for a task of this activity type. This default can be overridden when scheduling an activity task using the ScheduleActivityTask decision.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
", + "RegisterWorkflowTypeInput$defaultTaskStartToCloseTimeout": "If set, specifies the default maximum duration of decision tasks for this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution decision.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
", + "RegisterWorkflowTypeInput$defaultExecutionStartToCloseTimeout": "If set, specifies the default maximum duration for executions of this workflow type. You can override this default when starting an execution through the StartWorkflowExecution action or StartChildWorkflowExecution decision.
The duration is specified in seconds; an integer greater than or equal to 0. Unlike some of the other timeout parameters in Amazon SWF, you cannot specify a value of \"NONE\" for defaultExecutionStartToCloseTimeout; there is a one-year max limit on the time that a workflow execution can run. Exceeding this limit will always cause the workflow execution to time out.
The maximum duration for this activity task.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
Optional. If set, specifies the maximum duration the activity task can wait to be assigned to a worker. This overrides the default schedule-to-start timeout specified when registering the activity type using RegisterActivityType.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
If set, specifies the maximum duration a worker may take to process this activity task. This overrides the default start-to-close timeout specified when registering the activity type using RegisterActivityType.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
If set, specifies the maximum time before which a worker processing a task of this type must report progress by calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out. If the worker subsequently attempts to record a heartbeat or returns a result, it will be ignored. This overrides the default heartbeat timeout specified when registering the activity type using RegisterActivityType.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
", + "ScheduleLambdaFunctionDecisionAttributes$startToCloseTimeout": "If set, specifies the maximum duration the function may take to execute.
", + "StartChildWorkflowExecutionDecisionAttributes$executionStartToCloseTimeout": "The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
Specifies the maximum duration of decision tasks for this workflow execution. This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
The maximum duration for the child workflow execution. If the workflow execution is not closed within this duration, it will be timed out and force terminated.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
", + "StartChildWorkflowExecutionInitiatedEventAttributes$taskStartToCloseTimeout": "The maximum duration allowed for the decision tasks for this workflow execution.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
", + "StartWorkflowExecutionInput$executionStartToCloseTimeout": "The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.
The duration is specified in seconds; an integer greater than or equal to 0. Exceeding this limit will cause the workflow execution to time out. Unlike some of the other timeout parameters in Amazon SWF, you cannot specify a value of \"NONE\" for this timeout; there is a one-year max limit on the time that a workflow execution can run.
Specifies the maximum duration of decision tasks for this workflow execution. This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
The total duration allowed for the new workflow execution.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
", + "WorkflowExecutionContinuedAsNewEventAttributes$taskStartToCloseTimeout": "The maximum duration of decision tasks for the new workflow execution.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
", + "WorkflowExecutionStartedEventAttributes$executionStartToCloseTimeout": "The maximum duration for this workflow execution.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
", + "WorkflowExecutionStartedEventAttributes$taskStartToCloseTimeout": "The maximum duration of decision tasks for this workflow type.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
", + "WorkflowTypeConfiguration$defaultTaskStartToCloseTimeout": "Optional. The default maximum duration, specified when registering the workflow type, that a decision task for executions of this workflow type might take before returning completion or failure. If the task does not close in the specified time then the task is automatically timed out and rescheduled. If the decider eventually reports a completion or failure, it is ignored. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution decision.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
", + "WorkflowTypeConfiguration$defaultExecutionStartToCloseTimeout": "Optional. The default maximum duration, specified when registering the workflow type, for executions of this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution decision.
The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.
" + } + }, + "ErrorMessage": { + "base": null, + "refs": { + "DefaultUndefinedFault$message": null, + "DomainAlreadyExistsFault$message": "A description that may help with diagnosing the cause of the fault.
", + "DomainDeprecatedFault$message": "A description that may help with diagnosing the cause of the fault.
", + "LimitExceededFault$message": "A description that may help with diagnosing the cause of the fault.
", + "OperationNotPermittedFault$message": "A description that may help with diagnosing the cause of the fault.
", + "TypeAlreadyExistsFault$message": "A description that may help with diagnosing the cause of the fault.
", + "TypeDeprecatedFault$message": "A description that may help with diagnosing the cause of the fault.
", + "UnknownResourceFault$message": "A description that may help with diagnosing the cause of the fault.
", + "WorkflowExecutionAlreadyStartedFault$message": "A description that may help with diagnosing the cause of the fault.
" + } + }, + "EventId": { + "base": null, + "refs": { + "ActivityTask$startedEventId": "The ID of the ActivityTaskStarted event recorded in the history.
The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RequestCancelActivityTask decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the ActivityTaskStarted event recorded when this activity task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
If set, contains the ID of the last ActivityTaskCancelRequested event recorded for this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the ActivityTaskStarted event recorded when this activity task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the ActivityTaskStarted event recorded when this activity task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the DecisionTaskCompleted event corresponding to the decision that resulted in the scheduling of this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the ActivityTaskStarted event recorded when this activity task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CancelTimer decision to cancel this timer. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CancelWorkflowExecution decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CompleteWorkflowExecution decision to complete this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the ContinueAsNewWorkflowExecution decision that started this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the DecisionTaskStarted event recorded in the history.
The ID of the DecisionTaskStarted event of the previous decision task of this workflow execution that was processed by the decider. This can be used to determine the events in the history new since the last decision task received by the decider.
", + "DecisionTaskCompletedEventAttributes$scheduledEventId": "The ID of the DecisionTaskScheduled event that was recorded when this decision task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the DecisionTaskStarted event recorded when this decision task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the DecisionTaskScheduled event that was recorded when this decision task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the DecisionTaskScheduled event that was recorded when this decision task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the DecisionTaskStarted event recorded when this decision task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the RequestCancelExternalWorkflowExecutionInitiated event corresponding to the RequestCancelExternalWorkflowExecution decision to cancel this external workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the SignalExternalWorkflowExecutionInitiated event corresponding to the SignalExternalWorkflowExecution decision to request this signal. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the FailWorkflowExecution decision to fail this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The system generated ID of the event. This ID uniquely identifies the event with in the workflow execution history.
", + "LambdaFunctionCompletedEventAttributes$scheduledEventId": "The ID of the LambdaFunctionScheduled event that was recorded when this AWS Lambda function was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the LambdaFunctionStarted event recorded in the history.
The ID of the LambdaFunctionScheduled event that was recorded when this AWS Lambda function was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the LambdaFunctionStarted event recorded in the history.
The ID of the DecisionTaskCompleted event for the decision that resulted in the scheduling of this AWS Lambda function. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the LambdaFunctionScheduled event that was recorded when this AWS Lambda function was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the LambdaFunctionScheduled event that was recorded when this AWS Lambda function was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the LambdaFunctionStarted event recorded in the history.
The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RecordMarker decision that requested this marker. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RecordMarkerFailed decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RequestCancelActivityTask decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the RequestCancelExternalWorkflowExecutionInitiated event corresponding to the RequestCancelExternalWorkflowExecution decision to cancel this external workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RequestCancelExternalWorkflowExecution decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RequestCancelExternalWorkflowExecution decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the DecisionTaskCompleted event corresponding to the decision that resulted in the scheduling of this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the DecisionTaskCompleted event corresponding to the decision that resulted in the scheduling of this AWS Lambda function. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the SignalExternalWorkflowExecutionInitiated event corresponding to the SignalExternalWorkflowExecution decision to request this signal. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the SignalExternalWorkflowExecution decision for this signal. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the SignalExternalWorkflowExecution decision for this signal. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartChildWorkflowExecution decision to request this child workflow execution. This information can be useful for diagnosing problems by tracing back the cause of events.
The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartChildWorkflowExecution decision to request this child workflow execution. This information can be useful for diagnosing problems by tracing back the cause of events.
The ID of the LambdaFunctionScheduled event that was recorded when this AWS Lambda function was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartTimer decision for this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the TimerStarted event that was recorded when this timer was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CancelTimer decision to cancel this timer. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the TimerStarted event that was recorded when this timer was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartTimer decision for this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the RequestCancelExternalWorkflowExecutionInitiated event corresponding to the RequestCancelExternalWorkflowExecution decision to cancel this workflow execution.The source event with this ID can be found in the history of the source workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CancelWorkflowExecution decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CompleteWorkflowExecution decision to complete this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the ContinueAsNewWorkflowExecution decision that started this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the FailWorkflowExecution decision to fail this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The ID of the SignalExternalWorkflowExecutionInitiated event corresponding to the SignalExternalWorkflow decision to signal this workflow execution.The source event with this ID can be found in the history of the source workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event. This field is set only if the signal was initiated by another workflow execution.
The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution decision to start this workflow execution. The source event with this ID can be found in the history of the source workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
The type of the history event.
" + } + }, + "ExecutionStatus": { + "base": null, + "refs": { + "WorkflowExecutionInfo$executionStatus": "The current status of the execution.
" + } + }, + "ExecutionTimeFilter": { + "base": "Used to filter the workflow executions in visibility APIs by various time-based rules. Each parameter, if specified, defines a rule that must be satisfied by each returned query result. The parameter values are in the Unix Time format. For example: \"oldestDate\": 1325376070.
If specified, only workflow executions that meet the start time criteria of the filter are counted.
startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.If specified, only workflow executions that meet the close time criteria of the filter are counted.
startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.Specifies the start time criteria that workflow executions must meet in order to be counted.
", + "ListClosedWorkflowExecutionsInput$startTimeFilter": "If specified, the workflow executions are included in the returned results based on whether their start times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their start times.
startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.If specified, the workflow executions are included in the returned results based on whether their close times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their close times.
startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.Workflow executions are included in the returned results based on whether their start times are within the range specified by this filter.
" + } + }, + "ExternalWorkflowExecutionCancelRequestedEventAttributes": { + "base": "Provides details of the ExternalWorkflowExecutionCancelRequested event.
If the event is of type ExternalWorkflowExecutionCancelRequested then this member is set and provides detailed information about the event. It is not set for other event types.
Provides details of the ExternalWorkflowExecutionSignaled event.
If the event is of type ExternalWorkflowExecutionSignaled then this member is set and provides detailed information about the event. It is not set for other event types.
Provides details of the FailWorkflowExecution decision.
Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
", + "refs": { + "Decision$failWorkflowExecutionDecisionAttributes": "Provides details of the FailWorkflowExecution decision. It is not set for other decision types.
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
Provides details of the FailWorkflowExecutionFailed event.
If the event is of type FailWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.
The reason provided for the failure (if any).
", + "ChildWorkflowExecutionFailedEventAttributes$reason": "The reason for the failure (if provided).
", + "FailWorkflowExecutionDecisionAttributes$reason": "A descriptive reason for the failure that may help in diagnostics.
", + "LambdaFunctionFailedEventAttributes$reason": "The reason provided for the failure (if any).
", + "RespondActivityTaskFailedInput$reason": "Description of the error that may assist in diagnostics.
", + "WorkflowExecutionFailedEventAttributes$reason": "The descriptive reason provided for the failure (if any).
" + } + }, + "FunctionId": { + "base": null, + "refs": { + "LambdaFunctionScheduledEventAttributes$id": "The unique Amazon SWF ID for the AWS Lambda task.
", + "ScheduleLambdaFunctionDecisionAttributes$id": "Required. The SWF id of the AWS Lambda task.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string quotarnquot.
The unique Amazon SWF ID of the AWS Lambda task.
" + } + }, + "FunctionInput": { + "base": null, + "refs": { + "LambdaFunctionScheduledEventAttributes$input": "Input provided to the AWS Lambda function.
", + "ScheduleLambdaFunctionDecisionAttributes$input": "The input provided to the AWS Lambda function.
" + } + }, + "FunctionName": { + "base": null, + "refs": { + "LambdaFunctionScheduledEventAttributes$name": "The name of the scheduled AWS Lambda function.
", + "ScheduleLambdaFunctionDecisionAttributes$name": "Required. The name of the AWS Lambda function to invoke.
", + "ScheduleLambdaFunctionFailedEventAttributes$name": "The name of the scheduled AWS Lambda function.
" + } + }, + "GetWorkflowExecutionHistoryInput": { + "base": null, + "refs": { + } + }, + "History": { + "base": "Paginated representation of a workflow history for a workflow execution. This is the up to date, complete and authoritative record of the events related to all tasks and events in the life of the workflow execution.
", + "refs": { + } + }, + "HistoryEvent": { + "base": "Event within a workflow execution. A history event can be one of these types:
RequestCancelActivityTask decision was received by the system.RecordMarker decision.StartTimer decision.A paginated list of history events of the workflow execution. The decider uses this during the processing of the decision task.
", + "History$events": "The list of history events.
" + } + }, + "Identity": { + "base": null, + "refs": { + "ActivityTaskStartedEventAttributes$identity": "Identity of the worker that was assigned this task. This aids diagnostics when problems arise. The form of this identity is user defined.
", + "DecisionTaskStartedEventAttributes$identity": "Identity of the decider making the request. This enables diagnostic tracing when problems arise. The form of this identity is user defined.
", + "PollForActivityTaskInput$identity": "Identity of the worker making the request, recorded in the ActivityTaskStarted event in the workflow history. This enables diagnostic tracing when problems arise. The form of this identity is user defined.
Identity of the decider making the request, which is recorded in the DecisionTaskStarted event in the workflow history. This enables diagnostic tracing when problems arise. The form of this identity is user defined.
" + } + }, + "LambdaFunctionCompletedEventAttributes": { + "base": "Provides details for the LambdaFunctionCompleted event.
Provides details for the LambdaFunctionFailed event.
Provides details for the LambdaFunctionScheduled event.
Provides details for the LambdaFunctionStarted event.
Provides details for the LambdaFunctionTimedOut event.
The type of the timeout that caused this event.
" + } + }, + "LimitExceededFault": { + "base": "Returned by any operation if a system imposed limitation has been reached. To address this fault you should either clean up unused resources or increase the limit by contacting AWS.
", + "refs": { + } + }, + "LimitedData": { + "base": null, + "refs": { + "ActivityTaskTimedOutEventAttributes$details": "Contains the content of the details parameter for the last call made by the activity to RecordActivityTaskHeartbeat.
If specified, contains details about the progress of the task.
" + } + }, + "ListActivityTypesInput": { + "base": null, + "refs": { + } + }, + "ListClosedWorkflowExecutionsInput": { + "base": null, + "refs": { + } + }, + "ListDomainsInput": { + "base": null, + "refs": { + } + }, + "ListOpenWorkflowExecutionsInput": { + "base": null, + "refs": { + } + }, + "ListWorkflowTypesInput": { + "base": null, + "refs": { + } + }, + "MarkerName": { + "base": null, + "refs": { + "MarkerRecordedEventAttributes$markerName": "The name of the marker.
", + "RecordMarkerDecisionAttributes$markerName": "Required. The name of the marker.
", + "RecordMarkerFailedEventAttributes$markerName": "The marker's name.
" + } + }, + "MarkerRecordedEventAttributes": { + "base": "Provides details of the MarkerRecorded event.
If the event is of type MarkerRecorded then this member is set and provides detailed information about the event. It is not set for other event types.
The name of this activity.
If specified, only lists the activity types that have this name.
", + "ListWorkflowTypesInput$name": "If specified, lists the workflow type with this name.
", + "RegisterActivityTypeInput$name": "The name of the activity type within the domain.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string quotarnquot.
The name of the workflow type.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string quotarnquot.
The name of the task list.
", + "WorkflowType$name": "Required. The name of the workflow type.
Required. Name of the workflow type.
" + } + }, + "OpenDecisionTasksCount": { + "base": null, + "refs": { + "WorkflowExecutionOpenCounts$openDecisionTasks": "The count of decision tasks whose status is OPEN. A workflow execution can have at most one open decision task.
" + } + }, + "OperationNotPermittedFault": { + "base": "Returned when the caller does not have sufficient permissions to invoke the action.
", + "refs": { + } + }, + "PageSize": { + "base": null, + "refs": { + "GetWorkflowExecutionHistoryInput$maximumPageSize": "The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum.
This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
", + "ListActivityTypesInput$maximumPageSize": "The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum.
This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
", + "ListClosedWorkflowExecutionsInput$maximumPageSize": "The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum.
This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
", + "ListDomainsInput$maximumPageSize": "The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum.
This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
", + "ListOpenWorkflowExecutionsInput$maximumPageSize": "The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum.
This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
", + "ListWorkflowTypesInput$maximumPageSize": "The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum.
This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
", + "PollForDecisionTaskInput$maximumPageSize": "The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum.
This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
" + } + }, + "PageToken": { + "base": null, + "refs": { + "ActivityTypeInfos$nextPageToken": "If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.
The configured maximumPageSize determines how many results can be returned in a single call.
If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.
The configured maximumPageSize determines how many results can be returned in a single call.
If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.
The configured maximumPageSize determines how many results can be returned in a single call.
If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.
The configured maximumPageSize determines how many results can be returned in a single call.
If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.
The configured maximumPageSize determines how many results can be returned in a single call.
If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.
The configured maximumPageSize determines how many results can be returned in a single call.
If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.
The configured maximumPageSize determines how many results can be returned in a single call.
If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.
The configured maximumPageSize determines how many results can be returned in a single call.
If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.
The configured maximumPageSize determines how many results can be returned in a single call.
If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.
The configured maximumPageSize determines how many results can be returned in a single call.
If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.
The configured maximumPageSize determines how many results can be returned in a single call.
nextPageToken returned by this action cannot be used with GetWorkflowExecutionHistory to get the next page. You must call PollForDecisionTask again (with the nextPageToken) to retrieve the next page of history records. Calling PollForDecisionTask with a nextPageToken will not return a new decision task.If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.
The configured maximumPageSize determines how many results can be returned in a single call.
If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.
The configured maximumPageSize determines how many results can be returned in a single call.
Contains the count of tasks in a task list.
", + "refs": { + } + }, + "PollForActivityTaskInput": { + "base": null, + "refs": { + } + }, + "PollForDecisionTaskInput": { + "base": null, + "refs": { + } + }, + "RecordActivityTaskHeartbeatInput": { + "base": null, + "refs": { + } + }, + "RecordMarkerDecisionAttributes": { + "base": "Provides details of the RecordMarker decision.
Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
", + "refs": { + "Decision$recordMarkerDecisionAttributes": "Provides details of the RecordMarker decision. It is not set for other decision types.
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
Provides details of the RecordMarkerFailed event.
If the event is of type DecisionTaskFailed then this member is set and provides detailed information about the event. It is not set for other event types.
The current status of the activity type.
", + "DomainInfo$status": "The status of the domain:
Specifies the registration status of the activity types to list.
", + "ListDomainsInput$registrationStatus": "Specifies the registration status of the domains to list.
", + "ListWorkflowTypesInput$registrationStatus": "Specifies the registration status of the workflow types to list.
", + "WorkflowTypeInfo$status": "The current status of the workflow type.
" + } + }, + "RequestCancelActivityTaskDecisionAttributes": { + "base": "Provides details of the RequestCancelActivityTask decision.
Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
", + "refs": { + "Decision$requestCancelActivityTaskDecisionAttributes": "Provides details of the RequestCancelActivityTask decision. It is not set for other decision types.
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
Provides details of the RequestCancelActivityTaskFailed event.
If the event is of type RequestCancelActivityTaskFailed then this member is set and provides detailed information about the event. It is not set for other event types.
Provides details of the RequestCancelExternalWorkflowExecution decision.
Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
", + "refs": { + "Decision$requestCancelExternalWorkflowExecutionDecisionAttributes": "Provides details of the RequestCancelExternalWorkflowExecution decision. It is not set for other decision types.
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
Provides details of the RequestCancelExternalWorkflowExecutionFailed event.
If the event is of type RequestCancelExternalWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.
Provides details of the RequestCancelExternalWorkflowExecutionInitiated event.
If the event is of type RequestCancelExternalWorkflowExecutionInitiated then this member is set and provides detailed information about the event. It is not set for other event types.
When set to true, returns the events in reverse order. By default the results are returned in ascending order of the eventTimeStamp of the events.
When set to true, returns the results in reverse order. By default, the results are returned in ascending alphabetical order by name of the activity types.
When set to true, returns the results in reverse order. By default the results are returned in descending order of the start or the close time of the executions.
When set to true, returns the results in reverse order. By default, the results are returned in ascending alphabetical order by name of the domains.
When set to true, returns the results in reverse order. By default the results are returned in descending order of the start time of the executions.
When set to true, returns the results in reverse order. By default the results are returned in ascending alphabetical order of the name of the workflow types.
When set to true, returns the events in reverse order. By default the results are returned in ascending order of the eventTimestamp of the events.
Specifies the runId of a workflow execution.
The runId of a workflow execution. This ID is generated by the service and can be used to uniquely identify the workflow execution within a domain.
A system-generated unique identifier for the workflow execution.
", + "WorkflowExecutionContinuedAsNewEventAttributes$newExecutionRunId": "The runId of the new workflow execution.
The runId of the external workflow execution to cancel.
The runId of the external workflow execution.
The runId of the external workflow execution to be canceled.
The runId of the workflow execution to cancel.
", + "SignalExternalWorkflowExecutionDecisionAttributes$runId": "The runId of the workflow execution to be signaled.
The runId of the external workflow execution that the signal was being delivered to.
The runId of the external workflow execution to send the signal to.
The runId of the workflow execution to signal.
", + "TerminateWorkflowExecutionInput$runId": "The runId of the workflow execution to terminate.
", + "WorkflowExecutionStartedEventAttributes$continuedExecutionRunId": "If this workflow execution was started due to a ContinueAsNewWorkflowExecution decision, then it contains the runId of the previous workflow execution that was closed and continued as this execution.
Provides details of the ScheduleActivityTask decision.
Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.Condition element with the appropriate keys. activityType.name: String constraint. The key is swf:activityType.name.activityType.version: String constraint. The key is swf:activityType.version.taskList: String constraint. The key is swf:taskList.name.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
", + "refs": { + "Decision$scheduleActivityTaskDecisionAttributes": "Provides details of the ScheduleActivityTask decision. It is not set for other decision types.
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
Provides details of the ScheduleActivityTaskFailed event.
If the event is of type ScheduleActivityTaskFailed then this member is set and provides detailed information about the event. It is not set for other event types.
Provides details of the ScheduleLambdaFunction decision.
Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.Condition element with the appropriate keys. activityType.name: String constraint. The key is swf:activityType.name.activityType.version: String constraint. The key is swf:activityType.version.taskList: String constraint. The key is swf:taskList.name.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
", + "refs": { + "Decision$scheduleLambdaFunctionDecisionAttributes": null + } + }, + "ScheduleLambdaFunctionFailedCause": { + "base": null, + "refs": { + "ScheduleLambdaFunctionFailedEventAttributes$cause": "The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
Provides details for the ScheduleLambdaFunctionFailed event.
Provides details of the SignalExternalWorkflowExecution decision.
Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
", + "refs": { + "Decision$signalExternalWorkflowExecutionDecisionAttributes": "Provides details of the SignalExternalWorkflowExecution decision. It is not set for other decision types.
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
Provides details of the SignalExternalWorkflowExecutionFailed event.
If the event is of type SignalExternalWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.
Provides details of the SignalExternalWorkflowExecutionInitiated event.
If the event is of type SignalExternalWorkflowExecutionInitiated then this member is set and provides detailed information about the event. It is not set for other event types.
Required. The name of the signal.The target workflow execution will use the signal name and input to process the signal.
", + "SignalExternalWorkflowExecutionInitiatedEventAttributes$signalName": "The name of the signal.
", + "SignalWorkflowExecutionInput$signalName": "The name of the signal. This name must be meaningful to the target workflow.
", + "WorkflowExecutionSignaledEventAttributes$signalName": "The name of the signal received. The decider can use the signal name and inputs to determine how to the process the signal.
" + } + }, + "SignalWorkflowExecutionInput": { + "base": null, + "refs": { + } + }, + "StartChildWorkflowExecutionDecisionAttributes": { + "base": "Provides details of the StartChildWorkflowExecution decision.
Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.Condition element with the appropriate keys. tagList.member.N: The key is \"swf:tagList.N\" where N is the tag number from 0 to 4, inclusive.taskList: String constraint. The key is swf:taskList.name.workflowType.name: String constraint. The key is swf:workflowType.name.workflowType.version: String constraint. The key is swf:workflowType.version.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
", + "refs": { + "Decision$startChildWorkflowExecutionDecisionAttributes": "Provides details of the StartChildWorkflowExecution decision. It is not set for other decision types.
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
Provides details of the StartChildWorkflowExecutionFailed event.
If the event is of type StartChildWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.
Provides details of the StartChildWorkflowExecutionInitiated event.
If the event is of type StartChildWorkflowExecutionInitiated then this member is set and provides detailed information about the event. It is not set for other event types.
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
Provides details for the StartLambdaFunctionFailed event.
Provides details of the StartTimer decision.
Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
", + "refs": { + "Decision$startTimerDecisionAttributes": "Provides details of the StartTimer decision. It is not set for other decision types.
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
Provides details of the StartTimerFailed event.
If the event is of type StartTimerFailed then this member is set and provides detailed information about the event. It is not set for other event types.
Required. Specifies the tag that must be associated with the execution for it to meet the filter criteria.
", + "TagList$member": null + } + }, + "TagFilter": { + "base": "Used to filter the workflow executions in visibility APIs based on a tag.
", + "refs": { + "CountClosedWorkflowExecutionsInput$tagFilter": "If specified, only executions that have a tag that matches the filter are counted.
closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.If specified, only executions that have a tag that matches the filter are counted.
executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.If specified, only executions that have the matching tag are listed.
closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.If specified, only executions that have the matching tag are listed.
executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.The list of tags to associate with the new workflow execution. A maximum of 5 tags can be specified. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or ListClosedWorkflowExecutions and specifying a TagFilter.
", + "StartChildWorkflowExecutionDecisionAttributes$tagList": "The list of tags to associate with the child workflow execution. A maximum of 5 tags can be specified. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or ListClosedWorkflowExecutions and specifying a TagFilter.
", + "StartChildWorkflowExecutionInitiatedEventAttributes$tagList": "The list of tags to associated with the child workflow execution.
", + "StartWorkflowExecutionInput$tagList": "The list of tags to associate with the workflow execution. You can specify a maximum of 5 tags. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or ListClosedWorkflowExecutions and specifying a TagFilter.
", + "WorkflowExecutionContinuedAsNewEventAttributes$tagList": "The list of tags associated with the new workflow execution.
", + "WorkflowExecutionInfo$tagList": "The list of tags associated with the workflow execution. Tags can be used to identify and list workflow executions of interest through the visibility APIs. A workflow execution can have a maximum of 5 tags.
", + "WorkflowExecutionStartedEventAttributes$tagList": "The list of tags associated with this workflow execution. An execution can have up to 5 tags.
" + } + }, + "TaskList": { + "base": "Represents a task list.
", + "refs": { + "ActivityTaskScheduledEventAttributes$taskList": "The task list in which the activity task has been scheduled.
", + "ActivityTypeConfiguration$defaultTaskList": "Optional. The default task list specified for this activity type at registration. This default is used if a task list is not provided when a task is scheduled through the ScheduleActivityTask decision. You can override the default registered task list when scheduling a task through the ScheduleActivityTask decision.
The name of the task list.
", + "CountPendingDecisionTasksInput$taskList": "The name of the task list.
", + "DecisionTaskScheduledEventAttributes$taskList": "The name of the task list in which the decision task was scheduled.
", + "PollForActivityTaskInput$taskList": "Specifies the task list to poll for activity tasks.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string quotarnquot.
Specifies the task list to poll for decision tasks.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string quotarnquot.
If set, specifies the default task list to use for scheduling tasks of this activity type. This default task list is used if a task list is not provided when a task is scheduled through the ScheduleActivityTask decision.
If set, specifies the default task list to use for scheduling decision tasks for executions of this workflow type. This default is used only if a task list is not provided when starting the execution through the StartWorkflowExecution action or StartChildWorkflowExecution decision.
If set, specifies the name of the task list in which to schedule the activity task. If not specified, the defaultTaskList registered with the activity type will be used.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string quotarnquot.
The name of the task list to be used for decision tasks of the child workflow execution.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string quotarnquot.
The name of the task list used for the decision tasks of the child workflow execution.
", + "StartWorkflowExecutionInput$taskList": "The task list to use for the decision tasks generated for this workflow execution. This overrides the defaultTaskList specified when registering the workflow type.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string quotarnquot.
The task list used for the decision tasks generated for this workflow execution.
", + "WorkflowExecutionContinuedAsNewEventAttributes$taskList": null, + "WorkflowExecutionStartedEventAttributes$taskList": "The name of the task list for scheduling the decision tasks for this workflow execution.
", + "WorkflowTypeConfiguration$defaultTaskList": "Optional. The default task list, specified when registering the workflow type, for decisions tasks scheduled for workflow executions of this type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution decision.
Optional. The priority to assign to the scheduled activity task. If set, this will override any default priority value that was assigned when the activity type was registered.
Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
", + "ActivityTypeConfiguration$defaultTaskPriority": "Optional. The default task priority for tasks of this activity type, specified at registration. If not set, then \"0\" will be used as the default priority. This default can be overridden when scheduling an activity task.
Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
", + "ContinueAsNewWorkflowExecutionDecisionAttributes$taskPriority": "Optional. The task priority that, if set, specifies the priority for the decision tasks for this workflow execution. This overrides the defaultTaskPriority specified when registering the workflow type. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
", + "DecisionTaskScheduledEventAttributes$taskPriority": "Optional. A task priority that, if set, specifies the priority for this decision task. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
", + "RegisterActivityTypeInput$defaultTaskPriority": "The default task priority to assign to the activity type. If not assigned, then \"0\" will be used. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
", + "RegisterWorkflowTypeInput$defaultTaskPriority": "The default task priority to assign to the workflow type. If not assigned, then \"0\" will be used. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
", + "ScheduleActivityTaskDecisionAttributes$taskPriority": "Optional. If set, specifies the priority with which the activity task is to be assigned to a worker. This overrides the defaultTaskPriority specified when registering the activity type using RegisterActivityType. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
", + "StartChildWorkflowExecutionDecisionAttributes$taskPriority": "Optional. A task priority that, if set, specifies the priority for a decision task of this workflow execution. This overrides the defaultTaskPriority specified when registering the workflow type. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
", + "StartChildWorkflowExecutionInitiatedEventAttributes$taskPriority": "Optional. The priority assigned for the decision tasks for this workflow execution. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
", + "StartWorkflowExecutionInput$taskPriority": "The task priority to use for this workflow execution. This will override any default priority that was assigned when the workflow type was registered. If not set, then the default task priority for the workflow type will be used. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
", + "WorkflowExecutionConfiguration$taskPriority": "The priority assigned to decision tasks for this workflow execution. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
", + "WorkflowExecutionContinuedAsNewEventAttributes$taskPriority": null, + "WorkflowExecutionStartedEventAttributes$taskPriority": null, + "WorkflowTypeConfiguration$defaultTaskPriority": "Optional. The default task priority, specified when registering the workflow type, for all decision tasks of this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution decision.
Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
" + } + }, + "TaskToken": { + "base": null, + "refs": { + "ActivityTask$taskToken": "The opaque string used as a handle on the task. This token is used by workers to communicate progress and response information back to the system about the task.
", + "DecisionTask$taskToken": "The opaque string used as a handle on the task. This token is used by workers to communicate progress and response information back to the system about the task.
", + "RecordActivityTaskHeartbeatInput$taskToken": "The taskToken of the ActivityTask.
taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results. The taskToken of the ActivityTask.
taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.The taskToken of the ActivityTask.
taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.The taskToken of the ActivityTask.
taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.The taskToken from the DecisionTask.
taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.Optional. A descriptive reason for terminating the workflow execution.
", + "WorkflowExecutionTerminatedEventAttributes$reason": "The reason provided for the termination (if any).
" + } + }, + "TerminateWorkflowExecutionInput": { + "base": null, + "refs": { + } + }, + "TimerCanceledEventAttributes": { + "base": " Provides details of the TimerCanceled event.
If the event is of type TimerCanceled then this member is set and provides detailed information about the event. It is not set for other event types.
Provides details of the TimerFired event.
If the event is of type TimerFired then this member is set and provides detailed information about the event. It is not set for other event types.
Required. The unique ID of the timer to cancel.
", + "CancelTimerFailedEventAttributes$timerId": "The timerId provided in the CancelTimer decision that failed.
Required. The unique ID of the timer.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string quotarnquot.
The timerId provided in the StartTimer decision that failed.
The unique ID of the timer that was canceled.
", + "TimerFiredEventAttributes$timerId": "The unique ID of the timer that fired.
", + "TimerStartedEventAttributes$timerId": "The unique ID of the timer that was started.
" + } + }, + "TimerStartedEventAttributes": { + "base": "Provides details of the TimerStarted event.
If the event is of type TimerStarted then this member is set and provides detailed information about the event. It is not set for other event types.
The date and time this activity type was created through RegisterActivityType.
", + "ActivityTypeInfo$deprecationDate": "If DEPRECATED, the date and time DeprecateActivityType was called.
", + "ExecutionTimeFilter$oldestDate": "Specifies the oldest start or close date and time to return.
", + "ExecutionTimeFilter$latestDate": "Specifies the latest start or close date and time to return.
", + "HistoryEvent$eventTimestamp": "The date and time when the event occurred.
", + "WorkflowExecutionDetail$latestActivityTaskTimestamp": "The time when the last activity task was scheduled for this workflow execution. You can use this information to determine if the workflow has not made progress for an unusually long period of time and might require a corrective action.
", + "WorkflowExecutionInfo$startTimestamp": "The time when the execution was started.
", + "WorkflowExecutionInfo$closeTimestamp": "The time when the workflow execution was closed. Set only if the execution status is CLOSED.
", + "WorkflowTypeInfo$creationDate": "The date when this type was registered.
", + "WorkflowTypeInfo$deprecationDate": "If the type is in deprecated state, then it is set to the date when the type was deprecated.
" + } + }, + "Truncated": { + "base": null, + "refs": { + "PendingTaskCount$truncated": "If set to true, indicates that the actual count was more than the maximum supported by this API and the count returned is the truncated value.
", + "WorkflowExecutionCount$truncated": "If set to true, indicates that the actual count was more than the maximum supported by this API and the count returned is the truncated value.
" + } + }, + "TypeAlreadyExistsFault": { + "base": "Returned if the type already exists in the specified domain. You will get this fault even if the existing type is in deprecated status. You can specify another version if the intent is to create a new distinct version of the type.
", + "refs": { + } + }, + "TypeDeprecatedFault": { + "base": "Returned when the specified activity or workflow type was already deprecated.
", + "refs": { + } + }, + "UnknownResourceFault": { + "base": "Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.
", + "refs": { + } + }, + "Version": { + "base": null, + "refs": { + "ActivityType$version": "The version of this activity.
The version of the activity type.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string quotarnquot.
The version of the workflow type.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string quotarnquot.
Required. The version of the workflow type.
Version of the workflow type.
" + } + }, + "WorkflowExecution": { + "base": "Represents a workflow execution.
", + "refs": { + "ActivityTask$workflowExecution": "The workflow execution that started this activity task.
", + "ChildWorkflowExecutionCanceledEventAttributes$workflowExecution": "The child workflow execution that was canceled.
", + "ChildWorkflowExecutionCompletedEventAttributes$workflowExecution": "The child workflow execution that was completed.
", + "ChildWorkflowExecutionFailedEventAttributes$workflowExecution": "The child workflow execution that failed.
", + "ChildWorkflowExecutionStartedEventAttributes$workflowExecution": "The child workflow execution that was started.
", + "ChildWorkflowExecutionTerminatedEventAttributes$workflowExecution": "The child workflow execution that was terminated.
", + "ChildWorkflowExecutionTimedOutEventAttributes$workflowExecution": "The child workflow execution that timed out.
", + "DecisionTask$workflowExecution": "The workflow execution for which this decision task was created.
", + "DescribeWorkflowExecutionInput$execution": "The workflow execution to describe.
", + "ExternalWorkflowExecutionCancelRequestedEventAttributes$workflowExecution": "The external workflow execution to which the cancellation request was delivered.
", + "ExternalWorkflowExecutionSignaledEventAttributes$workflowExecution": "The external workflow execution that the signal was delivered to.
", + "GetWorkflowExecutionHistoryInput$execution": "Specifies the workflow execution for which to return the history.
", + "WorkflowExecutionCancelRequestedEventAttributes$externalWorkflowExecution": "The external workflow execution for which the cancellation was requested.
", + "WorkflowExecutionInfo$execution": "The workflow execution this information is about.
", + "WorkflowExecutionInfo$parent": "If this workflow execution is a child of another execution then contains the workflow execution that started this execution.
", + "WorkflowExecutionSignaledEventAttributes$externalWorkflowExecution": "The workflow execution that sent the signal. This is set only of the signal was sent by another workflow execution.
", + "WorkflowExecutionStartedEventAttributes$parentWorkflowExecution": "The source workflow execution that started this workflow execution. The member is not set if the workflow execution was not started by a workflow.
" + } + }, + "WorkflowExecutionAlreadyStartedFault": { + "base": "Returned by StartWorkflowExecution when an open execution with the same workflowId is already running in the specified domain.
", + "refs": { + } + }, + "WorkflowExecutionCancelRequestedCause": { + "base": null, + "refs": { + "WorkflowExecutionCancelRequestedEventAttributes$cause": "If set, indicates that the request to cancel the workflow execution was automatically generated, and specifies the cause. This happens if the parent workflow execution times out or is terminated, and the child policy is set to cancel child executions.
" + } + }, + "WorkflowExecutionCancelRequestedEventAttributes": { + "base": "Provides details of the WorkflowExecutionCancelRequested event.
If the event is of type WorkflowExecutionCancelRequested then this member is set and provides detailed information about the event. It is not set for other event types.
Provides details of the WorkflowExecutionCanceled event.
If the event is of type WorkflowExecutionCanceled then this member is set and provides detailed information about the event. It is not set for other event types.
Provides details of the WorkflowExecutionCompleted event.
If the event is of type WorkflowExecutionCompleted then this member is set and provides detailed information about the event. It is not set for other event types.
The configuration settings for a workflow execution including timeout values, tasklist etc. These configuration settings are determined from the defaults specified when registering the workflow type and those specified when starting the workflow execution.
", + "refs": { + "WorkflowExecutionDetail$executionConfiguration": "The configuration settings for this workflow execution including timeout values, tasklist etc.
" + } + }, + "WorkflowExecutionContinuedAsNewEventAttributes": { + "base": "Provides details of the WorkflowExecutionContinuedAsNew event.
If the event is of type WorkflowExecutionContinuedAsNew then this member is set and provides detailed information about the event. It is not set for other event types.
Contains the count of workflow executions returned from CountOpenWorkflowExecutions or CountClosedWorkflowExecutions
", + "refs": { + } + }, + "WorkflowExecutionDetail": { + "base": "Contains details about a workflow execution.
", + "refs": { + } + }, + "WorkflowExecutionFailedEventAttributes": { + "base": "Provides details of the WorkflowExecutionFailed event.
If the event is of type WorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.
Used to filter the workflow executions in visibility APIs by their workflowId.
If specified, only workflow executions matching the WorkflowId in the filter are counted.
closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.If specified, only workflow executions matching the WorkflowId in the filter are counted.
executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.If specified, only workflow executions matching the workflow ID specified in the filter are returned.
closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.If specified, only workflow executions matching the workflow ID specified in the filter are returned.
executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.Contains information about a workflow execution.
", + "refs": { + "WorkflowExecutionDetail$executionInfo": "Information about the workflow execution.
", + "WorkflowExecutionInfoList$member": null + } + }, + "WorkflowExecutionInfoList": { + "base": null, + "refs": { + "WorkflowExecutionInfos$executionInfos": "The list of workflow information structures.
" + } + }, + "WorkflowExecutionInfos": { + "base": "Contains a paginated list of information about workflow executions.
", + "refs": { + } + }, + "WorkflowExecutionOpenCounts": { + "base": "Contains the counts of open tasks, child workflow executions and timers for a workflow execution.
", + "refs": { + "WorkflowExecutionDetail$openCounts": "The number of tasks for this workflow execution. This includes open and closed tasks of all types.
" + } + }, + "WorkflowExecutionSignaledEventAttributes": { + "base": "Provides details of the WorkflowExecutionSignaled event.
If the event is of type WorkflowExecutionSignaled then this member is set and provides detailed information about the event. It is not set for other event types.
Provides details of WorkflowExecutionStarted event.
If the event is of type WorkflowExecutionStarted then this member is set and provides detailed information about the event. It is not set for other event types.
If set, indicates that the workflow execution was automatically terminated, and specifies the cause. This happens if the parent workflow execution times out or is terminated and the child policy is set to terminate child executions.
" + } + }, + "WorkflowExecutionTerminatedEventAttributes": { + "base": "Provides details of the WorkflowExecutionTerminated event.
If the event is of type WorkflowExecutionTerminated then this member is set and provides detailed information about the event. It is not set for other event types.
Provides details of the WorkflowExecutionTimedOut event.
If the event is of type WorkflowExecutionTimedOut then this member is set and provides detailed information about the event. It is not set for other event types.
The type of the timeout that caused the child workflow execution to time out.
", + "WorkflowExecutionTimedOutEventAttributes$timeoutType": "The type of timeout that caused this event.
" + } + }, + "WorkflowId": { + "base": null, + "refs": { + "RequestCancelExternalWorkflowExecutionDecisionAttributes$workflowId": "Required. The workflowId of the external workflow execution to cancel.
The workflowId of the external workflow to which the cancel request was to be delivered.
The workflowId of the external workflow execution to be canceled.
The workflowId of the workflow execution to cancel.
", + "SignalExternalWorkflowExecutionDecisionAttributes$workflowId": "Required. The workflowId of the workflow execution to be signaled.
The workflowId of the external workflow execution that the signal was being delivered to.
The workflowId of the external workflow execution.
The workflowId of the workflow execution to signal.
", + "StartChildWorkflowExecutionDecisionAttributes$workflowId": "Required. The workflowId of the workflow execution.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string quotarnquot.
The workflowId of the child workflow execution.
The workflowId of the child workflow execution.
The user defined identifier associated with the workflow execution. You can use this to associate a custom identifier with the workflow execution. You may specify the same identifier if a workflow execution is logically a restart of a previous execution. You cannot have two open workflow executions with the same workflowId at the same time.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string quotarnquot.
The workflowId of the workflow execution to terminate.
", + "WorkflowExecution$workflowId": "The user defined identifier associated with the workflow execution.
", + "WorkflowExecutionFilter$workflowId": "The workflowId to pass of match the criteria of this filter.
" + } + }, + "WorkflowType": { + "base": "Represents a workflow type.
", + "refs": { + "ChildWorkflowExecutionCanceledEventAttributes$workflowType": "The type of the child workflow execution.
", + "ChildWorkflowExecutionCompletedEventAttributes$workflowType": "The type of the child workflow execution.
", + "ChildWorkflowExecutionFailedEventAttributes$workflowType": "The type of the child workflow execution.
", + "ChildWorkflowExecutionStartedEventAttributes$workflowType": "The type of the child workflow execution.
", + "ChildWorkflowExecutionTerminatedEventAttributes$workflowType": "The type of the child workflow execution.
", + "ChildWorkflowExecutionTimedOutEventAttributes$workflowType": "The type of the child workflow execution.
", + "DecisionTask$workflowType": "The type of the workflow execution for which this decision task was created.
", + "DeprecateWorkflowTypeInput$workflowType": "The workflow type to deprecate.
", + "DescribeWorkflowTypeInput$workflowType": "The workflow type to describe.
", + "StartChildWorkflowExecutionDecisionAttributes$workflowType": "Required. The type of the workflow execution to be started.
", + "StartChildWorkflowExecutionFailedEventAttributes$workflowType": "The workflow type provided in the StartChildWorkflowExecution decision that failed.
The type of the child workflow execution.
", + "StartWorkflowExecutionInput$workflowType": "The type of the workflow to start.
", + "WorkflowExecutionContinuedAsNewEventAttributes$workflowType": null, + "WorkflowExecutionInfo$workflowType": "The type of the workflow execution.
", + "WorkflowExecutionStartedEventAttributes$workflowType": "The workflow type of this execution.
", + "WorkflowTypeInfo$workflowType": "The workflow type this information is about.
" + } + }, + "WorkflowTypeConfiguration": { + "base": "The configuration settings of a workflow type.
", + "refs": { + "WorkflowTypeDetail$configuration": "Configuration settings of the workflow type registered through RegisterWorkflowType
" + } + }, + "WorkflowTypeDetail": { + "base": "Contains details about a workflow type.
", + "refs": { + } + }, + "WorkflowTypeFilter": { + "base": "Used to filter workflow execution query results by type. Each parameter, if specified, defines a rule that must be satisfied by each returned result.
", + "refs": { + "CountClosedWorkflowExecutionsInput$typeFilter": "If specified, indicates the type of the workflow executions to be counted.
closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.Specifies the type of the workflow executions to be counted.
executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.If specified, only executions of the type specified in the filter are returned.
closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.If specified, only executions of the type specified in the filter are returned.
executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.Contains information about a workflow type.
", + "refs": { + "WorkflowTypeDetail$typeInfo": "General information about the workflow type.
The status of the workflow type (returned in the WorkflowTypeInfo structure) can be one of the following.
The list of workflow type information.
" + } + }, + "WorkflowTypeInfos": { + "base": "Contains a paginated list of information structures about workflow types.
", + "refs": { + } + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/swf/2012-01-25/paginators-1.json b/vendor/github.com/aws/aws-sdk-go/models/apis/swf/2012-01-25/paginators-1.json new file mode 100644 index 000000000..892ee38b5 --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/swf/2012-01-25/paginators-1.json @@ -0,0 +1,46 @@ +{ + "pagination": { + "GetWorkflowExecutionHistory": { + "limit_key": "maximumPageSize", + "input_token": "nextPageToken", + "output_token": "nextPageToken", + "result_key": "events" + }, + "ListActivityTypes": { + "limit_key": "maximumPageSize", + "input_token": "nextPageToken", + "output_token": "nextPageToken", + "result_key": "typeInfos" + }, + "ListClosedWorkflowExecutions": { + "limit_key": "maximumPageSize", + "input_token": "nextPageToken", + "output_token": "nextPageToken", + "result_key": "executionInfos" + }, + "ListDomains": { + "limit_key": "maximumPageSize", + "input_token": "nextPageToken", + "output_token": "nextPageToken", + "result_key": "domainInfos" + }, + "ListOpenWorkflowExecutions": { + "limit_key": "maximumPageSize", + "input_token": "nextPageToken", + "output_token": "nextPageToken", + "result_key": "executionInfos" + }, + "ListWorkflowTypes": { + "limit_key": "maximumPageSize", + "input_token": "nextPageToken", + "output_token": "nextPageToken", + "result_key": "typeInfos" + }, + "PollForDecisionTask": { + "limit_key": "maximumPageSize", + "input_token": "nextPageToken", + "output_token": "nextPageToken", + "result_key": "events" + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/waf/2015-08-24/api-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/waf/2015-08-24/api-2.json new file mode 100644 index 000000000..b51ee18ed --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/waf/2015-08-24/api-2.json @@ -0,0 +1,1959 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2015-08-24", + "endpointPrefix":"waf", + "jsonVersion":"1.1", + "protocol":"json", + "serviceAbbreviation":"WAF", + "serviceFullName":"AWS WAF", + "signatureVersion":"v4", + "targetPrefix":"AWSWAF_20150824" + }, + "operations":{ + "CreateByteMatchSet":{ + "name":"CreateByteMatchSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateByteMatchSetRequest"}, + "output":{"shape":"CreateByteMatchSetResponse"}, + "errors":[ + {"shape":"WAFDisallowedNameException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFStaleDataException"}, + {"shape":"WAFLimitsExceededException"} + ] + }, + "CreateIPSet":{ + "name":"CreateIPSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateIPSetRequest"}, + "output":{"shape":"CreateIPSetResponse"}, + "errors":[ + {"shape":"WAFStaleDataException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFDisallowedNameException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFLimitsExceededException"} + ] + }, + "CreateRule":{ + "name":"CreateRule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateRuleRequest"}, + "output":{"shape":"CreateRuleResponse"}, + "errors":[ + {"shape":"WAFStaleDataException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFDisallowedNameException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFLimitsExceededException"} + ] + }, + "CreateSizeConstraintSet":{ + "name":"CreateSizeConstraintSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateSizeConstraintSetRequest"}, + "output":{"shape":"CreateSizeConstraintSetResponse"}, + "errors":[ + {"shape":"WAFStaleDataException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFDisallowedNameException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFLimitsExceededException"} + ] + }, + "CreateSqlInjectionMatchSet":{ + "name":"CreateSqlInjectionMatchSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateSqlInjectionMatchSetRequest"}, + "output":{"shape":"CreateSqlInjectionMatchSetResponse"}, + "errors":[ + {"shape":"WAFDisallowedNameException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFStaleDataException"}, + {"shape":"WAFLimitsExceededException"} + ] + }, + "CreateWebACL":{ + "name":"CreateWebACL", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateWebACLRequest"}, + "output":{"shape":"CreateWebACLResponse"}, + "errors":[ + {"shape":"WAFStaleDataException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFDisallowedNameException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFLimitsExceededException"} + ] + }, + "CreateXssMatchSet":{ + "name":"CreateXssMatchSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateXssMatchSetRequest"}, + "output":{"shape":"CreateXssMatchSetResponse"}, + "errors":[ + {"shape":"WAFDisallowedNameException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFStaleDataException"}, + {"shape":"WAFLimitsExceededException"} + ] + }, + "DeleteByteMatchSet":{ + "name":"DeleteByteMatchSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteByteMatchSetRequest"}, + "output":{"shape":"DeleteByteMatchSetResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFReferencedItemException"}, + {"shape":"WAFStaleDataException"}, + {"shape":"WAFNonEmptyEntityException"} + ] + }, + "DeleteIPSet":{ + "name":"DeleteIPSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteIPSetRequest"}, + "output":{"shape":"DeleteIPSetResponse"}, + "errors":[ + {"shape":"WAFStaleDataException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFReferencedItemException"}, + {"shape":"WAFNonEmptyEntityException"} + ] + }, + "DeleteRule":{ + "name":"DeleteRule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteRuleRequest"}, + "output":{"shape":"DeleteRuleResponse"}, + "errors":[ + {"shape":"WAFStaleDataException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFReferencedItemException"}, + {"shape":"WAFNonEmptyEntityException"} + ] + }, + "DeleteSizeConstraintSet":{ + "name":"DeleteSizeConstraintSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSizeConstraintSetRequest"}, + "output":{"shape":"DeleteSizeConstraintSetResponse"}, + "errors":[ + {"shape":"WAFStaleDataException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFReferencedItemException"}, + {"shape":"WAFNonEmptyEntityException"} + ] + }, + "DeleteSqlInjectionMatchSet":{ + "name":"DeleteSqlInjectionMatchSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSqlInjectionMatchSetRequest"}, + "output":{"shape":"DeleteSqlInjectionMatchSetResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFReferencedItemException"}, + {"shape":"WAFStaleDataException"}, + {"shape":"WAFNonEmptyEntityException"} + ] + }, + "DeleteWebACL":{ + "name":"DeleteWebACL", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteWebACLRequest"}, + "output":{"shape":"DeleteWebACLResponse"}, + "errors":[ + {"shape":"WAFStaleDataException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFReferencedItemException"}, + {"shape":"WAFNonEmptyEntityException"} + ] + }, + "DeleteXssMatchSet":{ + "name":"DeleteXssMatchSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteXssMatchSetRequest"}, + "output":{"shape":"DeleteXssMatchSetResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFReferencedItemException"}, + {"shape":"WAFStaleDataException"}, + {"shape":"WAFNonEmptyEntityException"} + ] + }, + "GetByteMatchSet":{ + "name":"GetByteMatchSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetByteMatchSetRequest"}, + "output":{"shape":"GetByteMatchSetResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFNonexistentItemException"} + ] + }, + "GetChangeToken":{ + "name":"GetChangeToken", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetChangeTokenRequest"}, + "output":{"shape":"GetChangeTokenResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"} + ] + }, + "GetChangeTokenStatus":{ + "name":"GetChangeTokenStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetChangeTokenStatusRequest"}, + "output":{"shape":"GetChangeTokenStatusResponse"}, + "errors":[ + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFInternalErrorException"} + ] + }, + "GetIPSet":{ + "name":"GetIPSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetIPSetRequest"}, + "output":{"shape":"GetIPSetResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFNonexistentItemException"} + ] + }, + "GetRule":{ + "name":"GetRule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetRuleRequest"}, + "output":{"shape":"GetRuleResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFNonexistentItemException"} + ] + }, + "GetSampledRequests":{ + "name":"GetSampledRequests", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetSampledRequestsRequest"}, + "output":{"shape":"GetSampledRequestsResponse"}, + "errors":[ + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFInternalErrorException"} + ] + }, + "GetSizeConstraintSet":{ + "name":"GetSizeConstraintSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetSizeConstraintSetRequest"}, + "output":{"shape":"GetSizeConstraintSetResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFNonexistentItemException"} + ] + }, + "GetSqlInjectionMatchSet":{ + "name":"GetSqlInjectionMatchSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetSqlInjectionMatchSetRequest"}, + "output":{"shape":"GetSqlInjectionMatchSetResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFNonexistentItemException"} + ] + }, + "GetWebACL":{ + "name":"GetWebACL", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetWebACLRequest"}, + "output":{"shape":"GetWebACLResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFNonexistentItemException"} + ] + }, + "GetXssMatchSet":{ + "name":"GetXssMatchSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetXssMatchSetRequest"}, + "output":{"shape":"GetXssMatchSetResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFNonexistentItemException"} + ] + }, + "ListByteMatchSets":{ + "name":"ListByteMatchSets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListByteMatchSetsRequest"}, + "output":{"shape":"ListByteMatchSetsResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"} + ] + }, + "ListIPSets":{ + "name":"ListIPSets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListIPSetsRequest"}, + "output":{"shape":"ListIPSetsResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"} + ] + }, + "ListRules":{ + "name":"ListRules", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListRulesRequest"}, + "output":{"shape":"ListRulesResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"} + ] + }, + "ListSizeConstraintSets":{ + "name":"ListSizeConstraintSets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListSizeConstraintSetsRequest"}, + "output":{"shape":"ListSizeConstraintSetsResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"} + ] + }, + "ListSqlInjectionMatchSets":{ + "name":"ListSqlInjectionMatchSets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListSqlInjectionMatchSetsRequest"}, + "output":{"shape":"ListSqlInjectionMatchSetsResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"} + ] + }, + "ListWebACLs":{ + "name":"ListWebACLs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListWebACLsRequest"}, + "output":{"shape":"ListWebACLsResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"} + ] + }, + "ListXssMatchSets":{ + "name":"ListXssMatchSets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListXssMatchSetsRequest"}, + "output":{"shape":"ListXssMatchSetsResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"} + ] + }, + "UpdateByteMatchSet":{ + "name":"UpdateByteMatchSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateByteMatchSetRequest"}, + "output":{"shape":"UpdateByteMatchSetResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFInvalidOperationException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFNonexistentContainerException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFStaleDataException"}, + {"shape":"WAFLimitsExceededException"} + ] + }, + "UpdateIPSet":{ + "name":"UpdateIPSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateIPSetRequest"}, + "output":{"shape":"UpdateIPSetResponse"}, + "errors":[ + {"shape":"WAFStaleDataException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFInvalidOperationException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFNonexistentContainerException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFReferencedItemException"}, + {"shape":"WAFLimitsExceededException"} + ] + }, + "UpdateRule":{ + "name":"UpdateRule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateRuleRequest"}, + "output":{"shape":"UpdateRuleResponse"}, + "errors":[ + {"shape":"WAFStaleDataException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFInvalidOperationException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFNonexistentContainerException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFReferencedItemException"}, + {"shape":"WAFLimitsExceededException"} + ] + }, + "UpdateSizeConstraintSet":{ + "name":"UpdateSizeConstraintSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateSizeConstraintSetRequest"}, + "output":{"shape":"UpdateSizeConstraintSetResponse"}, + "errors":[ + {"shape":"WAFStaleDataException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFInvalidOperationException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFNonexistentContainerException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFReferencedItemException"}, + {"shape":"WAFLimitsExceededException"} + ] + }, + "UpdateSqlInjectionMatchSet":{ + "name":"UpdateSqlInjectionMatchSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateSqlInjectionMatchSetRequest"}, + "output":{"shape":"UpdateSqlInjectionMatchSetResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFInvalidOperationException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFNonexistentContainerException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFStaleDataException"}, + {"shape":"WAFLimitsExceededException"} + ] + }, + "UpdateWebACL":{ + "name":"UpdateWebACL", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateWebACLRequest"}, + "output":{"shape":"UpdateWebACLResponse"}, + "errors":[ + {"shape":"WAFStaleDataException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFInvalidOperationException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFNonexistentContainerException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFReferencedItemException"}, + {"shape":"WAFLimitsExceededException"} + ] + }, + "UpdateXssMatchSet":{ + "name":"UpdateXssMatchSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateXssMatchSetRequest"}, + "output":{"shape":"UpdateXssMatchSetResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFInvalidOperationException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFNonexistentContainerException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFStaleDataException"}, + {"shape":"WAFLimitsExceededException"} + ] + } + }, + "shapes":{ + "Action":{"type":"string"}, + "ActivatedRule":{ + "type":"structure", + "required":[ + "Priority", + "RuleId", + "Action" + ], + "members":{ + "Priority":{"shape":"RulePriority"}, + "RuleId":{"shape":"ResourceId"}, + "Action":{"shape":"WafAction"} + } + }, + "ActivatedRules":{ + "type":"list", + "member":{"shape":"ActivatedRule"} + }, + "ByteMatchSet":{ + "type":"structure", + "required":[ + "ByteMatchSetId", + "ByteMatchTuples" + ], + "members":{ + "ByteMatchSetId":{"shape":"ResourceId"}, + "Name":{"shape":"ResourceName"}, + "ByteMatchTuples":{"shape":"ByteMatchTuples"} + } + }, + "ByteMatchSetSummaries":{ + "type":"list", + "member":{"shape":"ByteMatchSetSummary"} + }, + "ByteMatchSetSummary":{ + "type":"structure", + "required":[ + "ByteMatchSetId", + "Name" + ], + "members":{ + "ByteMatchSetId":{"shape":"ResourceId"}, + "Name":{"shape":"ResourceName"} + } + }, + "ByteMatchSetUpdate":{ + "type":"structure", + "required":[ + "Action", + "ByteMatchTuple" + ], + "members":{ + "Action":{"shape":"ChangeAction"}, + "ByteMatchTuple":{"shape":"ByteMatchTuple"} + } + }, + "ByteMatchSetUpdates":{ + "type":"list", + "member":{"shape":"ByteMatchSetUpdate"} + }, + "ByteMatchTargetString":{"type":"blob"}, + "ByteMatchTuple":{ + "type":"structure", + "required":[ + "FieldToMatch", + "TargetString", + "TextTransformation", + "PositionalConstraint" + ], + "members":{ + "FieldToMatch":{"shape":"FieldToMatch"}, + "TargetString":{"shape":"ByteMatchTargetString"}, + "TextTransformation":{"shape":"TextTransformation"}, + "PositionalConstraint":{"shape":"PositionalConstraint"} + } + }, + "ByteMatchTuples":{ + "type":"list", + "member":{"shape":"ByteMatchTuple"} + }, + "ChangeAction":{ + "type":"string", + "enum":[ + "INSERT", + "DELETE" + ] + }, + "ChangeToken":{"type":"string"}, + "ChangeTokenStatus":{ + "type":"string", + "enum":[ + "PROVISIONED", + "PENDING", + "INSYNC" + ] + }, + "ComparisonOperator":{ + "type":"string", + "enum":[ + "EQ", + "NE", + "LE", + "LT", + "GE", + "GT" + ] + }, + "Country":{"type":"string"}, + "CreateByteMatchSetRequest":{ + "type":"structure", + "required":[ + "Name", + "ChangeToken" + ], + "members":{ + "Name":{"shape":"ResourceName"}, + "ChangeToken":{"shape":"ChangeToken"} + } + }, + "CreateByteMatchSetResponse":{ + "type":"structure", + "members":{ + "ByteMatchSet":{"shape":"ByteMatchSet"}, + "ChangeToken":{"shape":"ChangeToken"} + } + }, + "CreateIPSetRequest":{ + "type":"structure", + "required":[ + "Name", + "ChangeToken" + ], + "members":{ + "Name":{"shape":"ResourceName"}, + "ChangeToken":{"shape":"ChangeToken"} + } + }, + "CreateIPSetResponse":{ + "type":"structure", + "members":{ + "IPSet":{"shape":"IPSet"}, + "ChangeToken":{"shape":"ChangeToken"} + } + }, + "CreateRuleRequest":{ + "type":"structure", + "required":[ + "Name", + "MetricName", + "ChangeToken" + ], + "members":{ + "Name":{"shape":"ResourceName"}, + "MetricName":{"shape":"MetricName"}, + "ChangeToken":{"shape":"ChangeToken"} + } + }, + "CreateRuleResponse":{ + "type":"structure", + "members":{ + "Rule":{"shape":"Rule"}, + "ChangeToken":{"shape":"ChangeToken"} + } + }, + "CreateSizeConstraintSetRequest":{ + "type":"structure", + "required":[ + "Name", + "ChangeToken" + ], + "members":{ + "Name":{"shape":"ResourceName"}, + "ChangeToken":{"shape":"ChangeToken"} + } + }, + "CreateSizeConstraintSetResponse":{ + "type":"structure", + "members":{ + "SizeConstraintSet":{"shape":"SizeConstraintSet"}, + "ChangeToken":{"shape":"ChangeToken"} + } + }, + "CreateSqlInjectionMatchSetRequest":{ + "type":"structure", + "required":[ + "Name", + "ChangeToken" + ], + "members":{ + "Name":{"shape":"ResourceName"}, + "ChangeToken":{"shape":"ChangeToken"} + } + }, + "CreateSqlInjectionMatchSetResponse":{ + "type":"structure", + "members":{ + "SqlInjectionMatchSet":{"shape":"SqlInjectionMatchSet"}, + "ChangeToken":{"shape":"ChangeToken"} + } + }, + "CreateWebACLRequest":{ + "type":"structure", + "required":[ + "Name", + "MetricName", + "DefaultAction", + "ChangeToken" + ], + "members":{ + "Name":{"shape":"ResourceName"}, + "MetricName":{"shape":"MetricName"}, + "DefaultAction":{"shape":"WafAction"}, + "ChangeToken":{"shape":"ChangeToken"} + } + }, + "CreateWebACLResponse":{ + "type":"structure", + "members":{ + "WebACL":{"shape":"WebACL"}, + "ChangeToken":{"shape":"ChangeToken"} + } + }, + "CreateXssMatchSetRequest":{ + "type":"structure", + "required":[ + "Name", + "ChangeToken" + ], + "members":{ + "Name":{"shape":"ResourceName"}, + "ChangeToken":{"shape":"ChangeToken"} + } + }, + "CreateXssMatchSetResponse":{ + "type":"structure", + "members":{ + "XssMatchSet":{"shape":"XssMatchSet"}, + "ChangeToken":{"shape":"ChangeToken"} + } + }, + "DeleteByteMatchSetRequest":{ + "type":"structure", + "required":[ + "ByteMatchSetId", + "ChangeToken" + ], + "members":{ + "ByteMatchSetId":{"shape":"ResourceId"}, + "ChangeToken":{"shape":"ChangeToken"} + } + }, + "DeleteByteMatchSetResponse":{ + "type":"structure", + "members":{ + "ChangeToken":{"shape":"ChangeToken"} + } + }, + "DeleteIPSetRequest":{ + "type":"structure", + "required":[ + "IPSetId", + "ChangeToken" + ], + "members":{ + "IPSetId":{"shape":"ResourceId"}, + "ChangeToken":{"shape":"ChangeToken"} + } + }, + "DeleteIPSetResponse":{ + "type":"structure", + "members":{ + "ChangeToken":{"shape":"ChangeToken"} + } + }, + "DeleteRuleRequest":{ + "type":"structure", + "required":[ + "RuleId", + "ChangeToken" + ], + "members":{ + "RuleId":{"shape":"ResourceId"}, + "ChangeToken":{"shape":"ChangeToken"} + } + }, + "DeleteRuleResponse":{ + "type":"structure", + "members":{ + "ChangeToken":{"shape":"ChangeToken"} + } + }, + "DeleteSizeConstraintSetRequest":{ + "type":"structure", + "required":[ + "SizeConstraintSetId", + "ChangeToken" + ], + "members":{ + "SizeConstraintSetId":{"shape":"ResourceId"}, + "ChangeToken":{"shape":"ChangeToken"} + } + }, + "DeleteSizeConstraintSetResponse":{ + "type":"structure", + "members":{ + "ChangeToken":{"shape":"ChangeToken"} + } + }, + "DeleteSqlInjectionMatchSetRequest":{ + "type":"structure", + "required":[ + "SqlInjectionMatchSetId", + "ChangeToken" + ], + "members":{ + "SqlInjectionMatchSetId":{"shape":"ResourceId"}, + "ChangeToken":{"shape":"ChangeToken"} + } + }, + "DeleteSqlInjectionMatchSetResponse":{ + "type":"structure", + "members":{ + "ChangeToken":{"shape":"ChangeToken"} + } + }, + "DeleteWebACLRequest":{ + "type":"structure", + "required":[ + "WebACLId", + "ChangeToken" + ], + "members":{ + "WebACLId":{"shape":"ResourceId"}, + "ChangeToken":{"shape":"ChangeToken"} + } + }, + "DeleteWebACLResponse":{ + "type":"structure", + "members":{ + "ChangeToken":{"shape":"ChangeToken"} + } + }, + "DeleteXssMatchSetRequest":{ + "type":"structure", + "required":[ + "XssMatchSetId", + "ChangeToken" + ], + "members":{ + "XssMatchSetId":{"shape":"ResourceId"}, + "ChangeToken":{"shape":"ChangeToken"} + } + }, + "DeleteXssMatchSetResponse":{ + "type":"structure", + "members":{ + "ChangeToken":{"shape":"ChangeToken"} + } + }, + "FieldToMatch":{ + "type":"structure", + "required":["Type"], + "members":{ + "Type":{"shape":"MatchFieldType"}, + "Data":{"shape":"MatchFieldData"} + } + }, + "GetByteMatchSetRequest":{ + "type":"structure", + "required":["ByteMatchSetId"], + "members":{ + "ByteMatchSetId":{"shape":"ResourceId"} + } + }, + "GetByteMatchSetResponse":{ + "type":"structure", + "members":{ + "ByteMatchSet":{"shape":"ByteMatchSet"} + } + }, + "GetChangeTokenRequest":{ + "type":"structure", + "members":{ + } + }, + "GetChangeTokenResponse":{ + "type":"structure", + "members":{ + "ChangeToken":{"shape":"ChangeToken"} + } + }, + "GetChangeTokenStatusRequest":{ + "type":"structure", + "required":["ChangeToken"], + "members":{ + "ChangeToken":{"shape":"ChangeToken"} + } + }, + "GetChangeTokenStatusResponse":{ + "type":"structure", + "members":{ + "ChangeTokenStatus":{"shape":"ChangeTokenStatus"} + } + }, + "GetIPSetRequest":{ + "type":"structure", + "required":["IPSetId"], + "members":{ + "IPSetId":{"shape":"ResourceId"} + } + }, + "GetIPSetResponse":{ + "type":"structure", + "members":{ + "IPSet":{"shape":"IPSet"} + } + }, + "GetRuleRequest":{ + "type":"structure", + "required":["RuleId"], + "members":{ + "RuleId":{"shape":"ResourceId"} + } + }, + "GetRuleResponse":{ + "type":"structure", + "members":{ + "Rule":{"shape":"Rule"} + } + }, + "GetSampledRequestsRequest":{ + "type":"structure", + "required":[ + "WebAclId", + "RuleId", + "TimeWindow", + "MaxItems" + ], + "members":{ + "WebAclId":{"shape":"ResourceId"}, + "RuleId":{"shape":"ResourceId"}, + "TimeWindow":{"shape":"TimeWindow"}, + "MaxItems":{"shape":"ListMaxItems"} + } + }, + "GetSampledRequestsResponse":{ + "type":"structure", + "members":{ + "SampledRequests":{"shape":"SampledHTTPRequests"}, + "PopulationSize":{"shape":"PopulationSize"}, + "TimeWindow":{"shape":"TimeWindow"} + } + }, + "GetSizeConstraintSetRequest":{ + "type":"structure", + "required":["SizeConstraintSetId"], + "members":{ + "SizeConstraintSetId":{"shape":"ResourceId"} + } + }, + "GetSizeConstraintSetResponse":{ + "type":"structure", + "members":{ + "SizeConstraintSet":{"shape":"SizeConstraintSet"} + } + }, + "GetSqlInjectionMatchSetRequest":{ + "type":"structure", + "required":["SqlInjectionMatchSetId"], + "members":{ + "SqlInjectionMatchSetId":{"shape":"ResourceId"} + } + }, + "GetSqlInjectionMatchSetResponse":{ + "type":"structure", + "members":{ + "SqlInjectionMatchSet":{"shape":"SqlInjectionMatchSet"} + } + }, + "GetWebACLRequest":{ + "type":"structure", + "required":["WebACLId"], + "members":{ + "WebACLId":{"shape":"ResourceId"} + } + }, + "GetWebACLResponse":{ + "type":"structure", + "members":{ + "WebACL":{"shape":"WebACL"} + } + }, + "GetXssMatchSetRequest":{ + "type":"structure", + "required":["XssMatchSetId"], + "members":{ + "XssMatchSetId":{"shape":"ResourceId"} + } + }, + "GetXssMatchSetResponse":{ + "type":"structure", + "members":{ + "XssMatchSet":{"shape":"XssMatchSet"} + } + }, + "HTTPHeader":{ + "type":"structure", + "members":{ + "Name":{"shape":"HeaderName"}, + "Value":{"shape":"HeaderValue"} + } + }, + "HTTPHeaders":{ + "type":"list", + "member":{"shape":"HTTPHeader"} + }, + "HTTPMethod":{"type":"string"}, + "HTTPRequest":{ + "type":"structure", + "members":{ + "ClientIP":{"shape":"IPString"}, + "Country":{"shape":"Country"}, + "URI":{"shape":"URIString"}, + "Method":{"shape":"HTTPMethod"}, + "HTTPVersion":{"shape":"HTTPVersion"}, + "Headers":{"shape":"HTTPHeaders"} + } + }, + "HTTPVersion":{"type":"string"}, + "HeaderName":{"type":"string"}, + "HeaderValue":{"type":"string"}, + "IPSet":{ + "type":"structure", + "required":[ + "IPSetId", + "IPSetDescriptors" + ], + "members":{ + "IPSetId":{"shape":"ResourceId"}, + "Name":{"shape":"ResourceName"}, + "IPSetDescriptors":{"shape":"IPSetDescriptors"} + } + }, + "IPSetDescriptor":{ + "type":"structure", + "required":[ + "Type", + "Value" + ], + "members":{ + "Type":{"shape":"IPSetDescriptorType"}, + "Value":{"shape":"IPSetDescriptorValue"} + } + }, + "IPSetDescriptorType":{ + "type":"string", + "enum":["IPV4"] + }, + "IPSetDescriptorValue":{"type":"string"}, + "IPSetDescriptors":{ + "type":"list", + "member":{"shape":"IPSetDescriptor"} + }, + "IPSetSummaries":{ + "type":"list", + "member":{"shape":"IPSetSummary"} + }, + "IPSetSummary":{ + "type":"structure", + "required":[ + "IPSetId", + "Name" + ], + "members":{ + "IPSetId":{"shape":"ResourceId"}, + "Name":{"shape":"ResourceName"} + } + }, + "IPSetUpdate":{ + "type":"structure", + "required":[ + "Action", + "IPSetDescriptor" + ], + "members":{ + "Action":{"shape":"ChangeAction"}, + "IPSetDescriptor":{"shape":"IPSetDescriptor"} + } + }, + "IPSetUpdates":{ + "type":"list", + "member":{"shape":"IPSetUpdate"} + }, + "IPString":{"type":"string"}, + "ListByteMatchSetsRequest":{ + "type":"structure", + "required":["Limit"], + "members":{ + "NextMarker":{"shape":"NextMarker"}, + "Limit":{"shape":"PaginationLimit"} + } + }, + "ListByteMatchSetsResponse":{ + "type":"structure", + "members":{ + "NextMarker":{"shape":"NextMarker"}, + "ByteMatchSets":{"shape":"ByteMatchSetSummaries"} + } + }, + "ListIPSetsRequest":{ + "type":"structure", + "required":["Limit"], + "members":{ + "NextMarker":{"shape":"NextMarker"}, + "Limit":{"shape":"PaginationLimit"} + } + }, + "ListIPSetsResponse":{ + "type":"structure", + "members":{ + "NextMarker":{"shape":"NextMarker"}, + "IPSets":{"shape":"IPSetSummaries"} + } + }, + "ListMaxItems":{ + "type":"long", + "max":100, + "min":1 + }, + "ListRulesRequest":{ + "type":"structure", + "required":["Limit"], + "members":{ + "NextMarker":{"shape":"NextMarker"}, + "Limit":{"shape":"PaginationLimit"} + } + }, + "ListRulesResponse":{ + "type":"structure", + "members":{ + "NextMarker":{"shape":"NextMarker"}, + "Rules":{"shape":"RuleSummaries"} + } + }, + "ListSizeConstraintSetsRequest":{ + "type":"structure", + "required":["Limit"], + "members":{ + "NextMarker":{"shape":"NextMarker"}, + "Limit":{"shape":"PaginationLimit"} + } + }, + "ListSizeConstraintSetsResponse":{ + "type":"structure", + "members":{ + "NextMarker":{"shape":"NextMarker"}, + "SizeConstraintSets":{"shape":"SizeConstraintSetSummaries"} + } + }, + "ListSqlInjectionMatchSetsRequest":{ + "type":"structure", + "required":["Limit"], + "members":{ + "NextMarker":{"shape":"NextMarker"}, + "Limit":{"shape":"PaginationLimit"} + } + }, + "ListSqlInjectionMatchSetsResponse":{ + "type":"structure", + "members":{ + "NextMarker":{"shape":"NextMarker"}, + "SqlInjectionMatchSets":{"shape":"SqlInjectionMatchSetSummaries"} + } + }, + "ListWebACLsRequest":{ + "type":"structure", + "required":["Limit"], + "members":{ + "NextMarker":{"shape":"NextMarker"}, + "Limit":{"shape":"PaginationLimit"} + } + }, + "ListWebACLsResponse":{ + "type":"structure", + "members":{ + "NextMarker":{"shape":"NextMarker"}, + "WebACLs":{"shape":"WebACLSummaries"} + } + }, + "ListXssMatchSetsRequest":{ + "type":"structure", + "required":["Limit"], + "members":{ + "NextMarker":{"shape":"NextMarker"}, + "Limit":{"shape":"PaginationLimit"} + } + }, + "ListXssMatchSetsResponse":{ + "type":"structure", + "members":{ + "NextMarker":{"shape":"NextMarker"}, + "XssMatchSets":{"shape":"XssMatchSetSummaries"} + } + }, + "MatchFieldData":{"type":"string"}, + "MatchFieldType":{ + "type":"string", + "enum":[ + "URI", + "QUERY_STRING", + "HEADER", + "METHOD", + "BODY" + ] + }, + "MetricName":{"type":"string"}, + "Negated":{"type":"boolean"}, + "NextMarker":{ + "type":"string", + "min":1 + }, + "PaginationLimit":{ + "type":"integer", + "max":100, + "min":1 + }, + "ParameterExceptionField":{ + "type":"string", + "enum":[ + "CHANGE_ACTION", + "WAF_ACTION", + "PREDICATE_TYPE", + "IPSET_TYPE", + "BYTE_MATCH_FIELD_TYPE", + "SQL_INJECTION_MATCH_FIELD_TYPE", + "BYTE_MATCH_TEXT_TRANSFORMATION", + "BYTE_MATCH_POSITIONAL_CONSTRAINT", + "SIZE_CONSTRAINT_COMPARISON_OPERATOR" + ] + }, + "ParameterExceptionParameter":{ + "type":"string", + "min":1 + }, + "ParameterExceptionReason":{ + "type":"string", + "enum":[ + "INVALID_OPTION", + "ILLEGAL_COMBINATION" + ] + }, + "PopulationSize":{"type":"long"}, + "PositionalConstraint":{ + "type":"string", + "enum":[ + "EXACTLY", + "STARTS_WITH", + "ENDS_WITH", + "CONTAINS", + "CONTAINS_WORD" + ] + }, + "Predicate":{ + "type":"structure", + "required":[ + "Negated", + "Type", + "DataId" + ], + "members":{ + "Negated":{"shape":"Negated"}, + "Type":{"shape":"PredicateType"}, + "DataId":{"shape":"ResourceId"} + } + }, + "PredicateType":{ + "type":"string", + "enum":[ + "IPMatch", + "ByteMatch", + "SqlInjectionMatch", + "SizeConstraint", + "XssMatch" + ] + }, + "Predicates":{ + "type":"list", + "member":{"shape":"Predicate"} + }, + "ResourceId":{ + "type":"string", + "max":128, + "min":1 + }, + "ResourceName":{ + "type":"string", + "max":128, + "min":1 + }, + "Rule":{ + "type":"structure", + "required":[ + "RuleId", + "Predicates" + ], + "members":{ + "RuleId":{"shape":"ResourceId"}, + "Name":{"shape":"ResourceName"}, + "MetricName":{"shape":"MetricName"}, + "Predicates":{"shape":"Predicates"} + } + }, + "RulePriority":{"type":"integer"}, + "RuleSummaries":{ + "type":"list", + "member":{"shape":"RuleSummary"} + }, + "RuleSummary":{ + "type":"structure", + "required":[ + "RuleId", + "Name" + ], + "members":{ + "RuleId":{"shape":"ResourceId"}, + "Name":{"shape":"ResourceName"} + } + }, + "RuleUpdate":{ + "type":"structure", + "required":[ + "Action", + "Predicate" + ], + "members":{ + "Action":{"shape":"ChangeAction"}, + "Predicate":{"shape":"Predicate"} + } + }, + "RuleUpdates":{ + "type":"list", + "member":{"shape":"RuleUpdate"} + }, + "SampleWeight":{ + "type":"long", + "min":0 + }, + "SampledHTTPRequest":{ + "type":"structure", + "required":[ + "Request", + "Weight" + ], + "members":{ + "Request":{"shape":"HTTPRequest"}, + "Weight":{"shape":"SampleWeight"}, + "Timestamp":{"shape":"Timestamp"}, + "Action":{"shape":"Action"} + } + }, + "SampledHTTPRequests":{ + "type":"list", + "member":{"shape":"SampledHTTPRequest"} + }, + "Size":{ + "type":"long", + "max":21474836480, + "min":0 + }, + "SizeConstraint":{ + "type":"structure", + "required":[ + "FieldToMatch", + "TextTransformation", + "ComparisonOperator", + "Size" + ], + "members":{ + "FieldToMatch":{"shape":"FieldToMatch"}, + "TextTransformation":{"shape":"TextTransformation"}, + "ComparisonOperator":{"shape":"ComparisonOperator"}, + "Size":{"shape":"Size"} + } + }, + "SizeConstraintSet":{ + "type":"structure", + "required":[ + "SizeConstraintSetId", + "SizeConstraints" + ], + "members":{ + "SizeConstraintSetId":{"shape":"ResourceId"}, + "Name":{"shape":"ResourceName"}, + "SizeConstraints":{"shape":"SizeConstraints"} + } + }, + "SizeConstraintSetSummaries":{ + "type":"list", + "member":{"shape":"SizeConstraintSetSummary"} + }, + "SizeConstraintSetSummary":{ + "type":"structure", + "required":[ + "SizeConstraintSetId", + "Name" + ], + "members":{ + "SizeConstraintSetId":{"shape":"ResourceId"}, + "Name":{"shape":"ResourceName"} + } + }, + "SizeConstraintSetUpdate":{ + "type":"structure", + "required":[ + "Action", + "SizeConstraint" + ], + "members":{ + "Action":{"shape":"ChangeAction"}, + "SizeConstraint":{"shape":"SizeConstraint"} + } + }, + "SizeConstraintSetUpdates":{ + "type":"list", + "member":{"shape":"SizeConstraintSetUpdate"} + }, + "SizeConstraints":{ + "type":"list", + "member":{"shape":"SizeConstraint"} + }, + "SqlInjectionMatchSet":{ + "type":"structure", + "required":[ + "SqlInjectionMatchSetId", + "SqlInjectionMatchTuples" + ], + "members":{ + "SqlInjectionMatchSetId":{"shape":"ResourceId"}, + "Name":{"shape":"ResourceName"}, + "SqlInjectionMatchTuples":{"shape":"SqlInjectionMatchTuples"} + } + }, + "SqlInjectionMatchSetSummaries":{ + "type":"list", + "member":{"shape":"SqlInjectionMatchSetSummary"} + }, + "SqlInjectionMatchSetSummary":{ + "type":"structure", + "required":[ + "SqlInjectionMatchSetId", + "Name" + ], + "members":{ + "SqlInjectionMatchSetId":{"shape":"ResourceId"}, + "Name":{"shape":"ResourceName"} + } + }, + "SqlInjectionMatchSetUpdate":{ + "type":"structure", + "required":[ + "Action", + "SqlInjectionMatchTuple" + ], + "members":{ + "Action":{"shape":"ChangeAction"}, + "SqlInjectionMatchTuple":{"shape":"SqlInjectionMatchTuple"} + } + }, + "SqlInjectionMatchSetUpdates":{ + "type":"list", + "member":{"shape":"SqlInjectionMatchSetUpdate"} + }, + "SqlInjectionMatchTuple":{ + "type":"structure", + "required":[ + "FieldToMatch", + "TextTransformation" + ], + "members":{ + "FieldToMatch":{"shape":"FieldToMatch"}, + "TextTransformation":{"shape":"TextTransformation"} + } + }, + "SqlInjectionMatchTuples":{ + "type":"list", + "member":{"shape":"SqlInjectionMatchTuple"} + }, + "TextTransformation":{ + "type":"string", + "enum":[ + "NONE", + "COMPRESS_WHITE_SPACE", + "HTML_ENTITY_DECODE", + "LOWERCASE", + "CMD_LINE", + "URL_DECODE" + ] + }, + "TimeWindow":{ + "type":"structure", + "required":[ + "StartTime", + "EndTime" + ], + "members":{ + "StartTime":{"shape":"Timestamp"}, + "EndTime":{"shape":"Timestamp"} + } + }, + "Timestamp":{"type":"timestamp"}, + "URIString":{"type":"string"}, + "UpdateByteMatchSetRequest":{ + "type":"structure", + "required":[ + "ByteMatchSetId", + "ChangeToken", + "Updates" + ], + "members":{ + "ByteMatchSetId":{"shape":"ResourceId"}, + "ChangeToken":{"shape":"ChangeToken"}, + "Updates":{"shape":"ByteMatchSetUpdates"} + } + }, + "UpdateByteMatchSetResponse":{ + "type":"structure", + "members":{ + "ChangeToken":{"shape":"ChangeToken"} + } + }, + "UpdateIPSetRequest":{ + "type":"structure", + "required":[ + "IPSetId", + "ChangeToken", + "Updates" + ], + "members":{ + "IPSetId":{"shape":"ResourceId"}, + "ChangeToken":{"shape":"ChangeToken"}, + "Updates":{"shape":"IPSetUpdates"} + } + }, + "UpdateIPSetResponse":{ + "type":"structure", + "members":{ + "ChangeToken":{"shape":"ChangeToken"} + } + }, + "UpdateRuleRequest":{ + "type":"structure", + "required":[ + "RuleId", + "ChangeToken", + "Updates" + ], + "members":{ + "RuleId":{"shape":"ResourceId"}, + "ChangeToken":{"shape":"ChangeToken"}, + "Updates":{"shape":"RuleUpdates"} + } + }, + "UpdateRuleResponse":{ + "type":"structure", + "members":{ + "ChangeToken":{"shape":"ChangeToken"} + } + }, + "UpdateSizeConstraintSetRequest":{ + "type":"structure", + "required":[ + "SizeConstraintSetId", + "ChangeToken", + "Updates" + ], + "members":{ + "SizeConstraintSetId":{"shape":"ResourceId"}, + "ChangeToken":{"shape":"ChangeToken"}, + "Updates":{"shape":"SizeConstraintSetUpdates"} + } + }, + "UpdateSizeConstraintSetResponse":{ + "type":"structure", + "members":{ + "ChangeToken":{"shape":"ChangeToken"} + } + }, + "UpdateSqlInjectionMatchSetRequest":{ + "type":"structure", + "required":[ + "SqlInjectionMatchSetId", + "ChangeToken", + "Updates" + ], + "members":{ + "SqlInjectionMatchSetId":{"shape":"ResourceId"}, + "ChangeToken":{"shape":"ChangeToken"}, + "Updates":{"shape":"SqlInjectionMatchSetUpdates"} + } + }, + "UpdateSqlInjectionMatchSetResponse":{ + "type":"structure", + "members":{ + "ChangeToken":{"shape":"ChangeToken"} + } + }, + "UpdateWebACLRequest":{ + "type":"structure", + "required":[ + "WebACLId", + "ChangeToken" + ], + "members":{ + "WebACLId":{"shape":"ResourceId"}, + "ChangeToken":{"shape":"ChangeToken"}, + "Updates":{"shape":"WebACLUpdates"}, + "DefaultAction":{"shape":"WafAction"} + } + }, + "UpdateWebACLResponse":{ + "type":"structure", + "members":{ + "ChangeToken":{"shape":"ChangeToken"} + } + }, + "UpdateXssMatchSetRequest":{ + "type":"structure", + "required":[ + "XssMatchSetId", + "ChangeToken", + "Updates" + ], + "members":{ + "XssMatchSetId":{"shape":"ResourceId"}, + "ChangeToken":{"shape":"ChangeToken"}, + "Updates":{"shape":"XssMatchSetUpdates"} + } + }, + "UpdateXssMatchSetResponse":{ + "type":"structure", + "members":{ + "ChangeToken":{"shape":"ChangeToken"} + } + }, + "WAFDisallowedNameException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "exception":true + }, + "WAFInternalErrorException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "exception":true, + "fault":true + }, + "WAFInvalidAccountException":{ + "type":"structure", + "members":{ + }, + "exception":true + }, + "WAFInvalidOperationException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "exception":true + }, + "WAFInvalidParameterException":{ + "type":"structure", + "members":{ + "field":{"shape":"ParameterExceptionField"}, + "parameter":{"shape":"ParameterExceptionParameter"}, + "reason":{"shape":"ParameterExceptionReason"} + }, + "exception":true + }, + "WAFLimitsExceededException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "exception":true + }, + "WAFNonEmptyEntityException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "exception":true + }, + "WAFNonexistentContainerException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "exception":true + }, + "WAFNonexistentItemException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "exception":true + }, + "WAFReferencedItemException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "exception":true + }, + "WAFStaleDataException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "exception":true + }, + "WafAction":{ + "type":"structure", + "required":["Type"], + "members":{ + "Type":{"shape":"WafActionType"} + } + }, + "WafActionType":{ + "type":"string", + "enum":[ + "BLOCK", + "ALLOW", + "COUNT" + ] + }, + "WebACL":{ + "type":"structure", + "required":[ + "WebACLId", + "DefaultAction", + "Rules" + ], + "members":{ + "WebACLId":{"shape":"ResourceId"}, + "Name":{"shape":"ResourceName"}, + "MetricName":{"shape":"MetricName"}, + "DefaultAction":{"shape":"WafAction"}, + "Rules":{"shape":"ActivatedRules"} + } + }, + "WebACLSummaries":{ + "type":"list", + "member":{"shape":"WebACLSummary"} + }, + "WebACLSummary":{ + "type":"structure", + "required":[ + "WebACLId", + "Name" + ], + "members":{ + "WebACLId":{"shape":"ResourceId"}, + "Name":{"shape":"ResourceName"} + } + }, + "WebACLUpdate":{ + "type":"structure", + "required":[ + "Action", + "ActivatedRule" + ], + "members":{ + "Action":{"shape":"ChangeAction"}, + "ActivatedRule":{"shape":"ActivatedRule"} + } + }, + "WebACLUpdates":{ + "type":"list", + "member":{"shape":"WebACLUpdate"} + }, + "XssMatchSet":{ + "type":"structure", + "required":[ + "XssMatchSetId", + "XssMatchTuples" + ], + "members":{ + "XssMatchSetId":{"shape":"ResourceId"}, + "Name":{"shape":"ResourceName"}, + "XssMatchTuples":{"shape":"XssMatchTuples"} + } + }, + "XssMatchSetSummaries":{ + "type":"list", + "member":{"shape":"XssMatchSetSummary"} + }, + "XssMatchSetSummary":{ + "type":"structure", + "required":[ + "XssMatchSetId", + "Name" + ], + "members":{ + "XssMatchSetId":{"shape":"ResourceId"}, + "Name":{"shape":"ResourceName"} + } + }, + "XssMatchSetUpdate":{ + "type":"structure", + "required":[ + "Action", + "XssMatchTuple" + ], + "members":{ + "Action":{"shape":"ChangeAction"}, + "XssMatchTuple":{"shape":"XssMatchTuple"} + } + }, + "XssMatchSetUpdates":{ + "type":"list", + "member":{"shape":"XssMatchSetUpdate"} + }, + "XssMatchTuple":{ + "type":"structure", + "required":[ + "FieldToMatch", + "TextTransformation" + ], + "members":{ + "FieldToMatch":{"shape":"FieldToMatch"}, + "TextTransformation":{"shape":"TextTransformation"} + } + }, + "XssMatchTuples":{ + "type":"list", + "member":{"shape":"XssMatchTuple"} + }, + "errorMessage":{"type":"string"} + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/waf/2015-08-24/docs-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/waf/2015-08-24/docs-2.json new file mode 100644 index 000000000..a580dc663 --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/waf/2015-08-24/docs-2.json @@ -0,0 +1,1208 @@ +{ + "version": "2.0", + "service": "This is the AWS WAF API Reference. This guide is for developers who need detailed information about the AWS WAF API actions, data types, and errors. For detailed information about AWS WAF features and an overview of how to use the AWS WAF API, see the AWS WAF Developer Guide.
", + "operations": { + "CreateByteMatchSet": "Creates a ByteMatchSet. You then use UpdateByteMatchSet to identify the part of a web request that you want AWS WAF to inspect, such as the values of the User-Agent header or the query string. For example, you can create a ByteMatchSet that matches any requests with User-Agent headers that contain the string BadBot. You can then configure AWS WAF to reject those requests.
To create and configure a ByteMatchSet, perform the following steps:
ChangeToken parameter of a CreateByteMatchSet request.CreateByteMatchSet request.GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateByteMatchSet request.For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
", + "CreateIPSet": "Creates an IPSet, which you use to specify which web requests you want to allow or block based on the IP addresses that the requests originate from. For example, if you're receiving a lot of requests from one or more individual IP addresses or one or more ranges of IP addresses and you want to block the requests, you can create an IPSet that contains those IP addresses and then configure AWS WAF to block the requests.
To create and configure an IPSet, perform the following steps:
ChangeToken parameter of a CreateIPSet request.CreateIPSet request.GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request.UpdateIPSet request to specify the IP addresses that you want AWS WAF to watch for.For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
", + "CreateRule": "Creates a Rule, which contains the IPSet objects, ByteMatchSet objects, and other predicates that identify the requests that you want to block. If you add more than one predicate to a Rule, a request must match all of the specifications to be allowed or blocked. For example, suppose you add the following to a Rule:
IPSet that matches the IP address 192.0.2.44/32ByteMatchSet that matches BadBot in the User-Agent headerYou then add the Rule to a WebACL and specify that you want to blocks requests that satisfy the Rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and the User-Agent header in the request must contain the value BadBot.
To create and configure a Rule, perform the following steps:
Rule. For more information, see CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet.ChangeToken parameter of a CreateRule request.CreateRule request.GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRule request.UpdateRule request to specify the predicates that you want to include in the Rule.WebACL that contains the Rule. For more information, see CreateWebACL.For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
", + "CreateSizeConstraintSet": "Creates a SizeConstraintSet. You then use UpdateSizeConstraintSet to identify the part of a web request that you want AWS WAF to check for length, such as the length of the User-Agent header or the length of the query string. For example, you can create a SizeConstraintSet that matches any requests that have a query string that is longer than 100 bytes. You can then configure AWS WAF to reject those requests.
To create and configure a SizeConstraintSet, perform the following steps:
ChangeToken parameter of a CreateSizeConstraintSet request.CreateSizeConstraintSet request.GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateSizeConstraintSet request.For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
", + "CreateSqlInjectionMatchSet": "Creates a SqlInjectionMatchSet, which you use to allow, block, or count requests that contain snippets of SQL code in a specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings.
To create and configure a SqlInjectionMatchSet, perform the following steps:
ChangeToken parameter of a CreateSqlInjectionMatchSet request.CreateSqlInjectionMatchSet request.GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateSqlInjectionMatchSet request.For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
", + "CreateWebACL": "Creates a WebACL, which contains the Rules that identify the CloudFront web requests that you want to allow, block, or count. AWS WAF evaluates Rules in order based on the value of Priority for each Rule.
You also specify a default action, either ALLOW or BLOCK. If a web request doesn't match any of the Rules in a WebACL, AWS WAF responds to the request with the default action.
To create and configure a WebACL, perform the following steps:
ByteMatchSet objects and other predicates that you want to include in Rules. For more information, see CreateByteMatchSet, UpdateByteMatchSet, CreateIPSet, UpdateIPSet, CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet.Rules that you want to include in the WebACL. For more information, see CreateRule and UpdateRule.ChangeToken parameter of a CreateWebACL request.CreateWebACL request.GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateWebACL request.Rules that you want to include in the WebACL, to specify the default action, and to associate the WebACL with a CloudFront distribution.For more information about how to use the AWS WAF API, see the AWS WAF Developer Guide.
", + "CreateXssMatchSet": "Creates an XssMatchSet, which you use to allow, block, or count requests that contain cross-site scripting attacks in the specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings.
To create and configure an XssMatchSet, perform the following steps:
ChangeToken parameter of a CreateXssMatchSet request.CreateXssMatchSet request.GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateXssMatchSet request.For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
", + "DeleteByteMatchSet": "Permanently deletes a ByteMatchSet. You can't delete a ByteMatchSet if it's still used in any Rules or if it still includes any ByteMatchTuple objects (any filters).
If you just want to remove a ByteMatchSet from a Rule, use UpdateRule.
To permanently delete a ByteMatchSet, perform the following steps:
ByteMatchSet to remove filters, if any. For more information, see UpdateByteMatchSet.ChangeToken parameter of a DeleteByteMatchSet request.DeleteByteMatchSet request.Permanently deletes an IPSet. You can't delete an IPSet if it's still used in any Rules or if it still includes any IP addresses.
If you just want to remove an IPSet from a Rule, use UpdateRule.
To permanently delete an IPSet from AWS WAF, perform the following steps:
IPSet to remove IP address ranges, if any. For more information, see UpdateIPSet.ChangeToken parameter of a DeleteIPSet request.DeleteIPSet request.Permanently deletes a Rule. You can't delete a Rule if it's still used in any WebACL objects or if it still includes any predicates, such as ByteMatchSet objects.
If you just want to remove a Rule from a WebACL, use UpdateWebACL.
To permanently delete a Rule from AWS WAF, perform the following steps:
Rule to remove predicates, if any. For more information, see UpdateRule.ChangeToken parameter of a DeleteRule request.DeleteRule request.Permanently deletes a SizeConstraintSet. You can't delete a SizeConstraintSet if it's still used in any Rules or if it still includes any SizeConstraint objects (any filters).
If you just want to remove a SizeConstraintSet from a Rule, use UpdateRule.
To permanently delete a SizeConstraintSet, perform the following steps:
SizeConstraintSet to remove filters, if any. For more information, see UpdateSizeConstraintSet.ChangeToken parameter of a DeleteSizeConstraintSet request.DeleteSizeConstraintSet request.Permanently deletes a SqlInjectionMatchSet. You can't delete a SqlInjectionMatchSet if it's still used in any Rules or if it still contains any SqlInjectionMatchTuple objects.
If you just want to remove a SqlInjectionMatchSet from a Rule, use UpdateRule.
To permanently delete a SqlInjectionMatchSet from AWS WAF, perform the following steps:
SqlInjectionMatchSet to remove filters, if any. For more information, see UpdateSqlInjectionMatchSet.ChangeToken parameter of a DeleteSqlInjectionMatchSet request.DeleteSqlInjectionMatchSet request.Permanently deletes a WebACL. You can't delete a WebACL if it still contains any Rules.
To delete a WebACL, perform the following steps:
WebACL to remove Rules, if any. For more information, see UpdateWebACL.ChangeToken parameter of a DeleteWebACL request.DeleteWebACL request.Permanently deletes an XssMatchSet. You can't delete an XssMatchSet if it's still used in any Rules or if it still contains any XssMatchTuple objects.
If you just want to remove an XssMatchSet from a Rule, use UpdateRule.
To permanently delete an XssMatchSet from AWS WAF, perform the following steps:
XssMatchSet to remove filters, if any. For more information, see UpdateXssMatchSet.ChangeToken parameter of a DeleteXssMatchSet request.DeleteXssMatchSet request.Returns the ByteMatchSet specified by ByteMatchSetId.
When you want to create, update, or delete AWS WAF objects, get a change token and include the change token in the create, update, or delete request. Change tokens ensure that your application doesn't submit conflicting requests to AWS WAF.
Each create, update, or delete request must use a unique change token. If your application submits a GetChangeToken request and then submits a second GetChangeToken request before submitting a create, update, or delete request, the second GetChangeToken request returns the same value as the first GetChangeToken request.
When you use a change token in a create, update, or delete request, the status of the change token changes to PENDING, which indicates that AWS WAF is propagating the change to all AWS WAF servers. Use GetChangeTokenStatus to determine the status of your change token.
Returns the status of a ChangeToken that you got by calling GetChangeToken. ChangeTokenStatus is one of the following values:
PROVISIONED: You requested the change token by calling GetChangeToken, but you haven't used it yet in a call to create, update, or delete an AWS WAF object.PENDING: AWS WAF is propagating the create, update, or delete request to all AWS WAF servers.IN_SYNC: Propagation is complete.Returns the IPSet that is specified by IPSetId.
Returns the Rule that is specified by the RuleId that you included in the GetRule request.
Gets detailed information about a specified number of requests--a sample--that AWS WAF randomly selects from among the first 5,000 requests that your AWS resource received during a time range that you choose. You can specify a sample size of up to 100 requests, and you can specify any time range in the previous three hours.
GetSampledRequests returns a time range, which is usually the time range that you specified. However, if your resource (such as a CloudFront distribution) received 5,000 requests before the specified time range elapsed, GetSampledRequests returns an updated time range. This new time range indicates the actual period during which AWS WAF selected the requests in the sample.
Returns the SizeConstraintSet specified by SizeConstraintSetId.
Returns the SqlInjectionMatchSet that is specified by SqlInjectionMatchSetId.
Returns the WebACL that is specified by WebACLId.
Returns the XssMatchSet that is specified by XssMatchSetId.
Returns an array of ByteMatchSetSummary objects.
", + "ListIPSets": "Returns an array of IPSetSummary objects in the response.
", + "ListRules": "Returns an array of RuleSummary objects.
", + "ListSizeConstraintSets": "Returns an array of SizeConstraintSetSummary objects.
", + "ListSqlInjectionMatchSets": "Returns an array of SqlInjectionMatchSet objects.
", + "ListWebACLs": "Returns an array of WebACLSummary objects in the response.
", + "ListXssMatchSets": "Returns an array of XssMatchSet objects.
", + "UpdateByteMatchSet": "Inserts or deletes ByteMatchTuple objects (filters) in a ByteMatchSet. For each ByteMatchTuple object, you specify the following values:
ByteMatchSetUpdate object, you delete the existing object and add a new one.User-Agent header. TargetString in the ByteMatchTuple data type. For example, you can add a ByteMatchSetUpdate object that matches web requests in which User-Agent headers contain the string BadBot. You can then configure AWS WAF to block those requests.
To create and configure a ByteMatchSet, perform the following steps:
ByteMatchSet. For more information, see CreateByteMatchSet.ChangeToken parameter of an UpdateByteMatchSet request.UpdateByteMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for.For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
", + "UpdateIPSet": "Inserts or deletes IPSetDescriptor objects in an IPSet. For each IPSetDescriptor object, you specify the following values:
IPSetDescriptor object, you delete the existing object and add a new one.IPv4. 192.0.2.0/24 (for the range of IP addresses from 192.0.2.0 to 192.0.2.255) or 192.0.2.44/32 (for the individual IP address 192.0.2.44). AWS WAF supports /8, /16, /24, and /32 IP address ranges. For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
You use an IPSet to specify which web requests you want to allow or block based on the IP addresses that the requests originated from. For example, if you're receiving a lot of requests from one or a small number of IP addresses and you want to block the requests, you can create an IPSet that specifies those IP addresses, and then configure AWS WAF to block the requests.
To create and configure an IPSet, perform the following steps:
ChangeToken parameter of an UpdateIPSet request.UpdateIPSet request to specify the IP addresses that you want AWS WAF to watch for.When you update an IPSet, you specify the IP addresses that you want to add and/or the IP addresses that you want to delete. If you want to change an IP address, you delete the existing IP address and add the new one.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
", + "UpdateRule": "Inserts or deletes Predicate objects in a Rule. Each Predicate object identifies a predicate, such as a ByteMatchSet or an IPSet, that specifies the web requests that you want to allow, block, or count. If you add more than one predicate to a Rule, a request must match all of the specifications to be allowed, blocked, or counted. For example, suppose you add the following to a Rule:
ByteMatchSet that matches the value BadBot in the User-Agent headerIPSet that matches the IP address 192.0.2.44You then add the Rule to a WebACL and specify that you want to block requests that satisfy the Rule. For a request to be blocked, the User-Agent header in the request must contain the value BadBot and the request must originate from the IP address 192.0.2.44.
To create and configure a Rule, perform the following steps:
Rule.Rule. See CreateRule.GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRule request.UpdateRule request to add predicates to the Rule.WebACL that contains the Rule. See CreateWebACL.If you want to replace one ByteMatchSet or IPSet with another, you delete the existing one and add the new one.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
", + "UpdateSizeConstraintSet": "Inserts or deletes SizeConstraint objects (filters) in a SizeConstraintSet. For each SizeConstraint object, you specify the following values:
SizeConstraintSetUpdate object, you delete the existing object and add a new one.User-Agent header.8192 bytes of your request to AWS WAF.ComparisonOperator used for evaluating the selected part of the request against the specified Size, such as equals, greater than, less than, and so on.For example, you can add a SizeConstraintSetUpdate object that matches web requests in which the length of the User-Agent header is greater than 100 bytes. You can then configure AWS WAF to block those requests.
To create and configure a SizeConstraintSet, perform the following steps:
SizeConstraintSet. For more information, see CreateSizeConstraintSet.ChangeToken parameter of an UpdateSizeConstraintSet request.UpdateSizeConstraintSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for.For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
", + "UpdateSqlInjectionMatchSet": "Inserts or deletes SqlInjectionMatchTuple objects (filters) in a SqlInjectionMatchSet. For each SqlInjectionMatchTuple object, you specify the following values:
Action: Whether to insert the object into or delete the object from the array. To change a SqlInjectionMatchTuple, you delete the existing object and add a new one.FieldToMatch: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header, the name of the header.TextTransformation: Which text transformation, if any, to perform on the web request before inspecting the request for snippets of malicious SQL code.You use SqlInjectionMatchSet objects to specify which CloudFront requests you want to allow, block, or count. For example, if you're receiving requests that contain snippets of SQL code in the query string and you want to block the requests, you can create a SqlInjectionMatchSet with the applicable settings, and then configure AWS WAF to block the requests.
To create and configure a SqlInjectionMatchSet, perform the following steps:
ChangeToken parameter of an UpdateIPSet request.UpdateSqlInjectionMatchSet request to specify the parts of web requests that you want AWS WAF to inspect for snippets of SQL code.For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
", + "UpdateWebACL": "Inserts or deletes ActivatedRule objects in a WebACL. Each Rule identifies web requests that you want to allow, block, or count. When you update a WebACL, you specify the following values:
WebACL, either ALLOW or BLOCK. AWS WAF performs the default action if a request doesn't match the criteria in any of the Rules in a WebACL.Rules that you want to add and/or delete. If you want to replace one Rule with another, you delete the existing Rule and add the new one.Rule, whether you want AWS WAF to allow requests, block requests, or count requests that match the conditions in the Rule.Rules in a WebACL. If you add more than one Rule to a WebACL, AWS WAF evaluates each request against the Rules in order based on the value of Priority. (The Rule that has the lowest value for Priority is evaluated first.) When a web request matches all of the predicates (such as ByteMatchSets and IPSets) in a Rule, AWS WAF immediately takes the corresponding action, allow or block, and doesn't evaluate the request against the remaining Rules in the WebACL, if any. WebACL.To create and configure a WebACL, perform the following steps:
Rules. For more information, see CreateByteMatchSet, UpdateByteMatchSet, CreateIPSet, UpdateIPSet, CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet.Rules that you want to include in the WebACL. For more information, see CreateRule and UpdateRule.WebACL. See CreateWebACL.GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateWebACL request.UpdateWebACL request to specify the Rules that you want to include in the WebACL, to specify the default action, and to associate the WebACL with a CloudFront distribution. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
", + "UpdateXssMatchSet": "Inserts or deletes XssMatchTuple objects (filters) in an XssMatchSet. For each XssMatchTuple object, you specify the following values:
Action: Whether to insert the object into or delete the object from the array. To change a XssMatchTuple, you delete the existing object and add a new one.FieldToMatch: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header, the name of the header.TextTransformation: Which text transformation, if any, to perform on the web request before inspecting the request for cross-site scripting attacks.You use XssMatchSet objects to specify which CloudFront requests you want to allow, block, or count. For example, if you're receiving requests that contain cross-site scripting attacks in the request body and you want to block the requests, you can create an XssMatchSet with the applicable settings, and then configure AWS WAF to block the requests.
To create and configure an XssMatchSet, perform the following steps:
ChangeToken parameter of an UpdateIPSet request.UpdateXssMatchSet request to specify the parts of web requests that you want AWS WAF to inspect for cross-site scripting attacks.For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
" + }, + "shapes": { + "Action": { + "base": null, + "refs": { + "SampledHTTPRequest$Action": "The action for the Rule that the request matched: ALLOW, BLOCK, or COUNT.
The ActivatedRule object in an UpdateWebACL request specifies a Rule that you want to insert or delete, the priority of the Rule in the WebACL, and the action that you want AWS WAF to take when a web request matches the Rule (ALLOW, BLOCK, or COUNT).
To specify whether to insert or delete a Rule, use the Action parameter in the WebACLUpdate data type.
An array that contains the action for each Rule in a WebACL, the priority of the Rule, and the ID of the Rule.
In a GetByteMatchSet request, ByteMatchSet is a complex type that contains the ByteMatchSetId and Name of a ByteMatchSet, and the values that you specified when you updated the ByteMatchSet.
A complex type that contains ByteMatchTuple objects, which specify the parts of web requests that you want AWS WAF to inspect and the values that you want AWS WAF to search for. If a ByteMatchSet contains more than one ByteMatchTuple object, a request needs to match the settings in only one ByteMatchTuple to be considered a match.
A ByteMatchSet that contains no ByteMatchTuple objects.
Information about the ByteMatchSet that you specified in the GetByteMatchSet request. For more information, see the following topics:
ByteMatchSetId, ByteMatchTuples, and NameByteMatchTuples: Contains an array of ByteMatchTuple objects. Each ByteMatchTuple object contains FieldToMatch, PositionalConstraint, TargetString, and TextTransformationData and TypeAn array of ByteMatchSetSummary objects.
" + } + }, + "ByteMatchSetSummary": { + "base": "Returned by ListByteMatchSets. Each ByteMatchSetSummary object includes the Name and ByteMatchSetId for one ByteMatchSet.
In an UpdateByteMatchSet request, ByteMatchSetUpdate specifies whether to insert or delete a ByteMatchTuple and includes the settings for the ByteMatchTuple.
An array of ByteMatchSetUpdate objects that you want to insert into or delete from a ByteMatchSet. For more information, see the applicable data types:
Action and ByteMatchTupleFieldToMatch, PositionalConstraint, TargetString, and TextTransformationData and TypeThe value that you want AWS WAF to search for. AWS WAF searches for the specified string in the part of web requests that you specified in FieldToMatch. The maximum length of the value is 50 bytes.
Valid values depend on the values that you specified for FieldToMatch:
HEADER: The value that you want AWS WAF to search for in the request header that you specified in FieldToMatch, for example, the value of the User-Agent or Referer header.METHOD: The HTTP method, which indicates the type of operation specified in the request. CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.QUERY_STRING: The value that you want AWS WAF to search for in the query string, which is the part of a URL that appears after a ? character.URI: The value that you want AWS WAF to search for in the part of a URL that identifies a resource, for example, /images/daily-ad.jpg.BODY: The part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. The request body immediately follows the request headers. Note that only the first 8192 bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. For more information, see CreateSizeConstraintSet. If TargetString includes alphabetic characters A-Z and a-z, note that the value is case sensitive.
If you're using the AWS WAF API
Specify a base64-encoded version of the value. The maximum length of the value before you base64-encode it is 50 bytes.
For example, suppose the value of Type is HEADER and the value of Data is User-Agent. If you want to search the User-Agent header for the value BadBot, you base64-encode BadBot using MIME base64 encoding and include the resulting value, QmFkQm90, in the value of TargetString.
If you're using the AWS CLI or one of the AWS SDKs
The value that you want AWS WAF to search for. The SDK automatically base64 encodes the value.
" + } + }, + "ByteMatchTuple": { + "base": "The bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings.
", + "refs": { + "ByteMatchSetUpdate$ByteMatchTuple": "Information about the part of a web request that you want AWS WAF to inspect and the value that you want AWS WAF to search for. If you specify DELETE for the value of Action, the ByteMatchTuple values must exactly match the values in the ByteMatchTuple that you want to delete from the ByteMatchSet.
Specifies the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings.
" + } + }, + "ChangeAction": { + "base": null, + "refs": { + "ByteMatchSetUpdate$Action": "Specifies whether to insert or delete a ByteMatchTuple.
", + "IPSetUpdate$Action": "Specifies whether to insert or delete an IP address with UpdateIPSet.
", + "RuleUpdate$Action": "Specify INSERT to add a Predicate to a Rule. Use DELETE to remove a Predicate from a Rule.
Specify INSERT to add a SizeConstraintSetUpdate to a SizeConstraintSet. Use DELETE to remove a SizeConstraintSetUpdate from a SizeConstraintSet.
Specify INSERT to add a SqlInjectionMatchSetUpdate to a SqlInjectionMatchSet. Use DELETE to remove a SqlInjectionMatchSetUpdate from a SqlInjectionMatchSet.
Specifies whether to insert a Rule into or delete a Rule from a WebACL.
Specify INSERT to add a XssMatchSetUpdate to an XssMatchSet. Use DELETE to remove a XssMatchSetUpdate from an XssMatchSet.
The value returned by the most recent call to GetChangeToken.
", + "CreateByteMatchSetResponse$ChangeToken": "The ChangeToken that you used to submit the CreateByteMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
The value returned by the most recent call to GetChangeToken.
", + "CreateIPSetResponse$ChangeToken": "The ChangeToken that you used to submit the CreateIPSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
The value returned by the most recent call to GetChangeToken.
", + "CreateRuleResponse$ChangeToken": "The ChangeToken that you used to submit the CreateRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
The value returned by the most recent call to GetChangeToken.
", + "CreateSizeConstraintSetResponse$ChangeToken": "The ChangeToken that you used to submit the CreateSizeConstraintSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
The value returned by the most recent call to GetChangeToken.
", + "CreateSqlInjectionMatchSetResponse$ChangeToken": "The ChangeToken that you used to submit the CreateSqlInjectionMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
The value returned by the most recent call to GetChangeToken.
", + "CreateWebACLResponse$ChangeToken": "The ChangeToken that you used to submit the CreateWebACL request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
The value returned by the most recent call to GetChangeToken.
", + "CreateXssMatchSetResponse$ChangeToken": "The ChangeToken that you used to submit the CreateXssMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
The value returned by the most recent call to GetChangeToken.
", + "DeleteByteMatchSetResponse$ChangeToken": "The ChangeToken that you used to submit the DeleteByteMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
The value returned by the most recent call to GetChangeToken.
", + "DeleteIPSetResponse$ChangeToken": "The ChangeToken that you used to submit the DeleteIPSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
The value returned by the most recent call to GetChangeToken.
", + "DeleteRuleResponse$ChangeToken": "The ChangeToken that you used to submit the DeleteRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
The value returned by the most recent call to GetChangeToken.
", + "DeleteSizeConstraintSetResponse$ChangeToken": "The ChangeToken that you used to submit the DeleteSizeConstraintSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
The value returned by the most recent call to GetChangeToken.
", + "DeleteSqlInjectionMatchSetResponse$ChangeToken": "The ChangeToken that you used to submit the DeleteSqlInjectionMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
The value returned by the most recent call to GetChangeToken.
", + "DeleteWebACLResponse$ChangeToken": "The ChangeToken that you used to submit the DeleteWebACL request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
The value returned by the most recent call to GetChangeToken.
", + "DeleteXssMatchSetResponse$ChangeToken": "The ChangeToken that you used to submit the DeleteXssMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
The ChangeToken that you used in the request. Use this value in a GetChangeTokenStatus request to get the current status of the request.
The change token for which you want to get the status. This change token was previously returned in the GetChangeToken response.
The value returned by the most recent call to GetChangeToken.
", + "UpdateByteMatchSetResponse$ChangeToken": "The ChangeToken that you used to submit the UpdateByteMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
The value returned by the most recent call to GetChangeToken.
", + "UpdateIPSetResponse$ChangeToken": "The ChangeToken that you used to submit the UpdateIPSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
The value returned by the most recent call to GetChangeToken.
", + "UpdateRuleResponse$ChangeToken": "The ChangeToken that you used to submit the UpdateRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
The value returned by the most recent call to GetChangeToken.
", + "UpdateSizeConstraintSetResponse$ChangeToken": "The ChangeToken that you used to submit the UpdateSizeConstraintSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
The value returned by the most recent call to GetChangeToken.
", + "UpdateSqlInjectionMatchSetResponse$ChangeToken": "The ChangeToken that you used to submit the UpdateSqlInjectionMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
The value returned by the most recent call to GetChangeToken.
", + "UpdateWebACLResponse$ChangeToken": "The ChangeToken that you used to submit the UpdateWebACL request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
The value returned by the most recent call to GetChangeToken.
", + "UpdateXssMatchSetResponse$ChangeToken": "The ChangeToken that you used to submit the UpdateXssMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
The status of the change token.
" + } + }, + "ComparisonOperator": { + "base": null, + "refs": { + "SizeConstraint$ComparisonOperator": "The type of comparison you want AWS WAF to perform. AWS WAF uses this in combination with the provided Size and FieldToMatch to build an expression in the form of \"Size ComparisonOperator size in bytes of FieldToMatch\". If that expression is true, the SizeConstraint is considered to match.
EQ: Used to test if the Size is equal to the size of the FieldToMatch
NE: Used to test if the Size is not equal to the size of the FieldToMatch
LE: Used to test if the Size is less than or equal to the size of the FieldToMatch
LT: Used to test if the Size is strictly less than the size of the FieldToMatch
GE: Used to test if the Size is greater than or equal to the size of the FieldToMatch
GT: Used to test if the Size is strictly greater than the size of the FieldToMatch
The two-letter country code for the country that the request originated from. For a current list of country codes, see the Wikipedia entry ISO 3166-1 alpha-2.
" + } + }, + "CreateByteMatchSetRequest": { + "base": null, + "refs": { + } + }, + "CreateByteMatchSetResponse": { + "base": null, + "refs": { + } + }, + "CreateIPSetRequest": { + "base": null, + "refs": { + } + }, + "CreateIPSetResponse": { + "base": null, + "refs": { + } + }, + "CreateRuleRequest": { + "base": null, + "refs": { + } + }, + "CreateRuleResponse": { + "base": null, + "refs": { + } + }, + "CreateSizeConstraintSetRequest": { + "base": null, + "refs": { + } + }, + "CreateSizeConstraintSetResponse": { + "base": null, + "refs": { + } + }, + "CreateSqlInjectionMatchSetRequest": { + "base": "A request to create a SqlInjectionMatchSet.
", + "refs": { + } + }, + "CreateSqlInjectionMatchSetResponse": { + "base": "The response to a CreateSqlInjectionMatchSet request.
A request to create an XssMatchSet.
", + "refs": { + } + }, + "CreateXssMatchSetResponse": { + "base": "The response to a CreateXssMatchSet request.
A request to delete a SqlInjectionMatchSet from AWS WAF.
", + "refs": { + } + }, + "DeleteSqlInjectionMatchSetResponse": { + "base": "The response to a request to delete a SqlInjectionMatchSet from AWS WAF.
", + "refs": { + } + }, + "DeleteWebACLRequest": { + "base": null, + "refs": { + } + }, + "DeleteWebACLResponse": { + "base": null, + "refs": { + } + }, + "DeleteXssMatchSetRequest": { + "base": "A request to delete an XssMatchSet from AWS WAF.
", + "refs": { + } + }, + "DeleteXssMatchSetResponse": { + "base": "The response to a request to delete an XssMatchSet from AWS WAF.
", + "refs": { + } + }, + "FieldToMatch": { + "base": "Specifies where in a web request to look for TargetString.
The part of a web request that you want AWS WAF to search, such as a specified header or a query string. For more information, see FieldToMatch.
", + "SizeConstraint$FieldToMatch": null, + "SqlInjectionMatchTuple$FieldToMatch": null, + "XssMatchTuple$FieldToMatch": null + } + }, + "GetByteMatchSetRequest": { + "base": null, + "refs": { + } + }, + "GetByteMatchSetResponse": { + "base": null, + "refs": { + } + }, + "GetChangeTokenRequest": { + "base": null, + "refs": { + } + }, + "GetChangeTokenResponse": { + "base": null, + "refs": { + } + }, + "GetChangeTokenStatusRequest": { + "base": null, + "refs": { + } + }, + "GetChangeTokenStatusResponse": { + "base": null, + "refs": { + } + }, + "GetIPSetRequest": { + "base": null, + "refs": { + } + }, + "GetIPSetResponse": { + "base": null, + "refs": { + } + }, + "GetRuleRequest": { + "base": null, + "refs": { + } + }, + "GetRuleResponse": { + "base": null, + "refs": { + } + }, + "GetSampledRequestsRequest": { + "base": null, + "refs": { + } + }, + "GetSampledRequestsResponse": { + "base": null, + "refs": { + } + }, + "GetSizeConstraintSetRequest": { + "base": null, + "refs": { + } + }, + "GetSizeConstraintSetResponse": { + "base": null, + "refs": { + } + }, + "GetSqlInjectionMatchSetRequest": { + "base": "A request to get a SqlInjectionMatchSet.
", + "refs": { + } + }, + "GetSqlInjectionMatchSetResponse": { + "base": "The response to a GetSqlInjectionMatchSet request.
", + "refs": { + } + }, + "GetWebACLRequest": { + "base": null, + "refs": { + } + }, + "GetWebACLResponse": { + "base": null, + "refs": { + } + }, + "GetXssMatchSetRequest": { + "base": "A request to get an XssMatchSet.
", + "refs": { + } + }, + "GetXssMatchSetResponse": { + "base": "The response to a GetXssMatchSet request.
", + "refs": { + } + }, + "HTTPHeader": { + "base": "The response from a GetSampledRequests request includes an HTTPHeader complex type that appears as Headers in the response syntax. HTTPHeader contains the names and values of all of the headers that appear in one of the web requests that were returned by GetSampledRequests.
A complex type that contains two values for each header in the sampled web request: the name of the header and the value of the header.
" + } + }, + "HTTPMethod": { + "base": null, + "refs": { + "HTTPRequest$Method": "The HTTP method specified in the sampled web request. CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.
The response from a GetSampledRequests request includes an HTTPRequest complex type that appears as Request in the response syntax. HTTPRequest contains information about one of the web requests that were returned by GetSampledRequests.
A complex type that contains detailed information about the request.
" + } + }, + "HTTPVersion": { + "base": null, + "refs": { + "HTTPRequest$HTTPVersion": "The HTTP version specified in the sampled web request, for example, HTTP/1.1.
The name of one of the headers in the sampled web request.
" + } + }, + "HeaderValue": { + "base": null, + "refs": { + "HTTPHeader$Value": "The value of one of the headers in the sampled web request.
" + } + }, + "IPSet": { + "base": "Contains one or more IP addresses or blocks of IP addresses specified in Classless Inter-Domain Routing (CIDR) notation. To specify an individual IP address, you specify the four-part IP address followed by a /32, for example, 192.0.2.0/31. To block a range of IP addresses, you can specify a /24, a /16, or a /8 CIDR. For more information about CIDR notation, perform an Internet search on cidr notation.
The IPSet returned in the CreateIPSet response.
Information about the IPSet that you specified in the GetIPSet request. For more information, see the following topics:
IPSetDescriptors, IPSetId, and NameIPSetDescriptors: Contains an array of IPSetDescriptor objects. Each IPSetDescriptor object contains Type and ValueSpecifies the IP address type (IPV4) and the IP address range (in CIDR format) that web requests originate from.
The IP address type (IPV4) and the IP address range (in CIDR notation) that web requests originate from.
Specify IPV4.
Specify an IPv4 address by using CIDR notation. For example:
192.0.2.44/32.192.0.2.0/24.AWS WAF supports only /8, /16, /24, and /32 IP addresses.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
" + } + }, + "IPSetDescriptors": { + "base": null, + "refs": { + "IPSet$IPSetDescriptors": "The IP address type (IPV4) and the IP address range (in CIDR notation) that web requests originate from. If the WebACL is associated with a CloudFront distribution, this is the value of one of the following fields in CloudFront access logs:
c-ip, if the viewer did not use an HTTP proxy or a load balancer to send the requestx-forwarded-for, if the viewer did use an HTTP proxy or a load balancer to send the requestAn array of IPSetSummary objects.
" + } + }, + "IPSetSummary": { + "base": "Contains the identifier and the name of the IPSet.
Specifies the type of update to perform to an IPSet with UpdateIPSet.
", + "refs": { + "IPSetUpdates$member": null + } + }, + "IPSetUpdates": { + "base": null, + "refs": { + "UpdateIPSetRequest$Updates": "An array of IPSetUpdate objects that you want to insert into or delete from an IPSet. For more information, see the applicable data types:
Action and IPSetDescriptorType and ValueThe IP address that the request originated from. If the WebACL is associated with a CloudFront distribution, this is the value of one of the following fields in CloudFront access logs:
c-ip, if the viewer did not use an HTTP proxy or a load balancer to send the requestx-forwarded-for, if the viewer did use an HTTP proxy or a load balancer to send the requestThe number of requests that you want AWS WAF to return from among the first 5,000 requests that your AWS resource received during the time range. If your resource received fewer requests than the value of MaxItems, GetSampledRequests returns information about all of them.
A request to list the SqlInjectionMatchSet objects created by the current AWS account.
", + "refs": { + } + }, + "ListSqlInjectionMatchSetsResponse": { + "base": "The response to a ListSqlInjectionMatchSets request.
", + "refs": { + } + }, + "ListWebACLsRequest": { + "base": null, + "refs": { + } + }, + "ListWebACLsResponse": { + "base": null, + "refs": { + } + }, + "ListXssMatchSetsRequest": { + "base": "A request to list the XssMatchSet objects created by the current AWS account.
", + "refs": { + } + }, + "ListXssMatchSetsResponse": { + "base": "The response to a ListXssMatchSets request.
", + "refs": { + } + }, + "MatchFieldData": { + "base": null, + "refs": { + "FieldToMatch$Data": "When the value of Type is HEADER, enter the name of the header that you want AWS WAF to search, for example, User-Agent or Referer. If the value of Type is any other value, omit Data.
The name of the header is not case sensitive.
" + } + }, + "MatchFieldType": { + "base": null, + "refs": { + "FieldToMatch$Type": "The part of the web request that you want AWS WAF to search for a specified string. Parts of a request that you can search include the following:
HEADER: A specified request header, for example, the value of the User-Agent or Referer header. If you choose HEADER for the type, specify the name of the header in Data.METHOD: The HTTP method, which indicated the type of operation that the request is asking the origin to perform. Amazon CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.QUERY_STRING: A query string, which is the part of a URL that appears after a ? character, if any.URI: The part of a web request that identifies a resource, for example, /images/daily-ad.jpg.BODY: The part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. The request body immediately follows the request headers. Note that only the first 8192 bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. For more information, see CreateSizeConstraintSet. A friendly name or description for the metrics for this Rule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change the name of the metric after you create the Rule.
A friendly name or description for the metrics for this WebACL. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change MetricName after you create the WebACL.
Set Negated to False if you want AWS WAF to allow, block, or count requests based on the settings in the specified ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, or SizeConstraintSet. For example, if an IPSet includes the IP address 192.0.2.44, AWS WAF will allow or block requests based on that IP address.
Set Negated to True if you want AWS WAF to allow or block a request based on the negation of the settings in the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, or SizeConstraintSet. For example, if an IPSet includes the IP address 192.0.2.44, AWS WAF will allow, block, or count requests based on all IP addresses except 192.0.2.44.
If you specify a value for Limit and you have more ByteMatchSets than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of ByteMatchSets. For the second and subsequent ListByteMatchSets requests, specify the value of NextMarker from the previous response to get information about another batch of ByteMatchSets.
If you have more ByteMatchSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more ByteMatchSet objects, submit another ListByteMatchSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.
If you specify a value for Limit and you have more IPSets than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of IPSets. For the second and subsequent ListIPSets requests, specify the value of NextMarker from the previous response to get information about another batch of ByteMatchSets.
If you have more IPSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more IPSet objects, submit another ListIPSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.
If you specify a value for Limit and you have more Rules than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of Rules. For the second and subsequent ListRules requests, specify the value of NextMarker from the previous response to get information about another batch of Rules.
If you have more Rules than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more Rules, submit another ListRules request, and specify the NextMarker value from the response in the NextMarker value in the next request.
If you specify a value for Limit and you have more SizeConstraintSets than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of SizeConstraintSets. For the second and subsequent ListSizeConstraintSets requests, specify the value of NextMarker from the previous response to get information about another batch of SizeConstraintSets.
If you have more SizeConstraintSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more SizeConstraintSet objects, submit another ListSizeConstraintSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.
If you specify a value for Limit and you have more SqlInjectionMatchSet objects than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of SqlInjectionMatchSets. For the second and subsequent ListSqlInjectionMatchSets requests, specify the value of NextMarker from the previous response to get information about another batch of SqlInjectionMatchSets.
If you have more SqlInjectionMatchSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more SqlInjectionMatchSet objects, submit another ListSqlInjectionMatchSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.
If you specify a value for Limit and you have more WebACL objects than the number that you specify for Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of WebACL objects. For the second and subsequent ListWebACLs requests, specify the value of NextMarker from the previous response to get information about another batch of WebACL objects.
If you have more WebACL objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more WebACL objects, submit another ListWebACLs request, and specify the NextMarker value from the response in the NextMarker value in the next request.
If you specify a value for Limit and you have more XssMatchSet objects than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of XssMatchSets. For the second and subsequent ListXssMatchSets requests, specify the value of NextMarker from the previous response to get information about another batch of XssMatchSets.
If you have more XssMatchSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more XssMatchSet objects, submit another ListXssMatchSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.
Specifies the number of ByteMatchSet objects that you want AWS WAF to return for this request. If you have more ByteMatchSets objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of ByteMatchSet objects.
Specifies the number of IPSet objects that you want AWS WAF to return for this request. If you have more IPSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of IPSet objects.
Specifies the number of Rules that you want AWS WAF to return for this request. If you have more Rules than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of Rules.
Specifies the number of SizeConstraintSet objects that you want AWS WAF to return for this request. If you have more SizeConstraintSets objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of SizeConstraintSet objects.
Specifies the number of SqlInjectionMatchSet objects that you want AWS WAF to return for this request. If you have more SqlInjectionMatchSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of Rules.
Specifies the number of WebACL objects that you want AWS WAF to return for this request. If you have more WebACL objects than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of WebACL objects.
Specifies the number of XssMatchSet objects that you want AWS WAF to return for this request. If you have more XssMatchSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of Rules.
The total number of requests from which GetSampledRequests got a sample of MaxItems requests. If PopulationSize is less than MaxItems, the sample includes every request that your AWS resource received during the specified time range.
Within the portion of a web request that you want to search (for example, in the query string, if any), specify where you want AWS WAF to search. Valid values include the following:
CONTAINS
The specified part of the web request must include the value of TargetString, but the location doesn't matter.
CONTAINS_WORD
The specified part of the web request must include the value of TargetString, and TargetString must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In addition, TargetString must be a word, which means one of the following:
TargetString exactly matches the value of the specified part of the web request, such as the value of a header.TargetString is at the beginning of the specified part of the web request and is followed by a character other than an alphanumeric character or underscore (_), for example, BadBot;.TargetString is at the end of the specified part of the web request and is preceded by a character other than an alphanumeric character or underscore (_), for example, ;BadBot.TargetString is in the middle of the specified part of the web request and is preceded and followed by characters other than alphanumeric characters or underscore (_), for example, -BadBot;.EXACTLY
The value of the specified part of the web request must exactly match the value of TargetString.
STARTS_WITH
The value of TargetString must appear at the beginning of the specified part of the web request.
ENDS_WITH
The value of TargetString must appear at the end of the specified part of the web request.
Specifies the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, and SizeConstraintSet objects that you want to add to a Rule and, for each object, indicates whether you want to negate the settings, for example, requests that do NOT originate from the IP address 192.0.2.44.
The ID of the Predicate (such as an IPSet) that you want to add to a Rule.
The type of predicate in a Rule, such as ByteMatchSet or IPSet.
The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a Rule.
The RuleId for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).
RuleId is returned by CreateRule and by ListRules.
The ByteMatchSetId for a ByteMatchSet. You use ByteMatchSetId to get information about a ByteMatchSet (see GetByteMatchSet), update a ByteMatchSet (see UpdateByteMatchSet), insert a ByteMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a ByteMatchSet from AWS WAF (see DeleteByteMatchSet).
ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.
The ByteMatchSetId for a ByteMatchSet. You use ByteMatchSetId to get information about a ByteMatchSet, update a ByteMatchSet, remove a ByteMatchSet from a Rule, and delete a ByteMatchSet from AWS WAF.
ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.
The ByteMatchSetId of the ByteMatchSet that you want to delete. ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.
The IPSetId of the IPSet that you want to delete. IPSetId is returned by CreateIPSet and by ListIPSets.
The RuleId of the Rule that you want to delete. RuleId is returned by CreateRule and by ListRules.
The SizeConstraintSetId of the SizeConstraintSet that you want to delete. SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.
The SqlInjectionMatchSetId of the SqlInjectionMatchSet that you want to delete. SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.
The WebACLId of the WebACL that you want to delete. WebACLId is returned by CreateWebACL and by ListWebACLs.
The XssMatchSetId of the XssMatchSet that you want to delete. XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.
The ByteMatchSetId of the ByteMatchSet that you want to get. ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.
The IPSetId of the IPSet that you want to get. IPSetId is returned by CreateIPSet and by ListIPSets.
The RuleId of the Rule that you want to get. RuleId is returned by CreateRule and by ListRules.
The WebACLId of the WebACL for which you want GetSampledRequests to return a sample of requests.
RuleId is one of two values:
RuleId of the Rule for which you want GetSampledRequests to return a sample of requests.Default_Action, which causes GetSampledRequests to return a sample of the requests that didn't match any of the rules in the specified WebACL.The SizeConstraintSetId of the SizeConstraintSet that you want to get. SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.
The SqlInjectionMatchSetId of the SqlInjectionMatchSet that you want to get. SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.
The WebACLId of the WebACL that you want to get. WebACLId is returned by CreateWebACL and by ListWebACLs.
The XssMatchSetId of the XssMatchSet that you want to get. XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.
The IPSetId for an IPSet. You use IPSetId to get information about an IPSet (see GetIPSet), update an IPSet (see UpdateIPSet), insert an IPSet into a Rule or delete one from a Rule (see UpdateRule), and delete an IPSet from AWS WAF (see DeleteIPSet).
IPSetId is returned by CreateIPSet and by ListIPSets.
The IPSetId for an IPSet. You can use IPSetId in a GetIPSet request to get detailed information about an IPSet.
A unique identifier for a predicate in a Rule, such as ByteMatchSetId or IPSetId. The ID is returned by the corresponding Create or List command.
A unique identifier for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).
RuleId is returned by CreateRule and by ListRules.
A unique identifier for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).
RuleId is returned by CreateRule and by ListRules.
A unique identifier for a SizeConstraintSet. You use SizeConstraintSetId to get information about a SizeConstraintSet (see GetSizeConstraintSet), update a SizeConstraintSet (see UpdateSizeConstraintSet), insert a SizeConstraintSet into a Rule or delete one from a Rule (see UpdateRule), and delete a SizeConstraintSet from AWS WAF (see DeleteSizeConstraintSet).
SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.
A unique identifier for a SizeConstraintSet. You use SizeConstraintSetId to get information about a SizeConstraintSet (see GetSizeConstraintSet), update a SizeConstraintSet (see UpdateSizeConstraintSet), insert a SizeConstraintSet into a Rule or delete one from a Rule (see UpdateRule), and delete a SizeConstraintSet from AWS WAF (see DeleteSizeConstraintSet).
SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.
A unique identifier for a SqlInjectionMatchSet. You use SqlInjectionMatchSetId to get information about a SqlInjectionMatchSet (see GetSqlInjectionMatchSet), update a SqlInjectionMatchSet (see UpdateSqlInjectionMatchSet), insert a SqlInjectionMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a SqlInjectionMatchSet from AWS WAF (see DeleteSqlInjectionMatchSet).
SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.
A unique identifier for a SqlInjectionMatchSet. You use SqlInjectionMatchSetId to get information about a SqlInjectionMatchSet (see GetSqlInjectionMatchSet), update a SqlInjectionMatchSet (see UpdateSqlInjectionMatchSet), insert a SqlInjectionMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a SqlInjectionMatchSet from AWS WAF (see DeleteSqlInjectionMatchSet).
SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.
The ByteMatchSetId of the ByteMatchSet that you want to update. ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.
The IPSetId of the IPSet that you want to update. IPSetId is returned by CreateIPSet and by ListIPSets.
The RuleId of the Rule that you want to update. RuleId is returned by CreateRule and by ListRules.
The SizeConstraintSetId of the SizeConstraintSet that you want to update. SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.
The SqlInjectionMatchSetId of the SqlInjectionMatchSet that you want to update. SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.
The WebACLId of the WebACL that you want to update. WebACLId is returned by CreateWebACL and by ListWebACLs.
The XssMatchSetId of the XssMatchSet that you want to update. XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.
A unique identifier for a WebACL. You use WebACLId to get information about a WebACL (see GetWebACL), update a WebACL (see UpdateWebACL), and delete a WebACL from AWS WAF (see DeleteWebACL).
WebACLId is returned by CreateWebACL and by ListWebACLs.
A unique identifier for a WebACL. You use WebACLId to get information about a WebACL (see GetWebACL), update a WebACL (see UpdateWebACL), and delete a WebACL from AWS WAF (see DeleteWebACL).
WebACLId is returned by CreateWebACL and by ListWebACLs.
A unique identifier for an XssMatchSet. You use XssMatchSetId to get information about an XssMatchSet (see GetXssMatchSet), update an XssMatchSet (see UpdateXssMatchSet), insert an XssMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete an XssMatchSet from AWS WAF (see DeleteXssMatchSet).
XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.
A unique identifier for an XssMatchSet. You use XssMatchSetId to get information about a XssMatchSet (see GetXssMatchSet), update an XssMatchSet (see UpdateXssMatchSet), insert an XssMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete an XssMatchSet from AWS WAF (see DeleteXssMatchSet).
XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.
A friendly name or description of the ByteMatchSet. You can't change Name after you create a ByteMatchSet.
A friendly name or description of the ByteMatchSet. You can't change Name after you create a ByteMatchSet.
A friendly name or description of the ByteMatchSet. You can't change Name after you create a ByteMatchSet.
A friendly name or description of the IPSet. You can't change Name after you create the IPSet.
A friendly name or description of the Rule. You can't change the name of a Rule after you create it.
A friendly name or description of the SizeConstraintSet. You can't change Name after you create a SizeConstraintSet.
A friendly name or description for the SqlInjectionMatchSet that you're creating. You can't change Name after you create the SqlInjectionMatchSet.
A friendly name or description of the WebACL. You can't change Name after you create the WebACL.
A friendly name or description for the XssMatchSet that you're creating. You can't change Name after you create the XssMatchSet.
A friendly name or description of the IPSet. You can't change the name of an IPSet after you create it.
A friendly name or description of the IPSet. You can't change the name of an IPSet after you create it.
The friendly name or description for the Rule. You can't change the name of a Rule after you create it.
A friendly name or description of the Rule. You can't change the name of a Rule after you create it.
The name, if any, of the SizeConstraintSet.
The name of the SizeConstraintSet, if any.
The name, if any, of the SqlInjectionMatchSet.
The name of the SqlInjectionMatchSet, if any, specified by Id.
A friendly name or description of the WebACL. You can't change the name of a WebACL after you create it.
A friendly name or description of the WebACL. You can't change the name of a WebACL after you create it.
The name, if any, of the XssMatchSet.
The name of the XssMatchSet, if any, specified by Id.
A combination of ByteMatchSet, IPSet, and/or SqlInjectionMatchSet objects that identify the web requests that you want to allow, block, or count. For example, you might create a Rule that includes the following predicates:
IPSet that causes AWS WAF to search for web requests that originate from the IP address 192.0.2.44ByteMatchSet that causes AWS WAF to search for web requests for which the value of the User-Agent header is BadBot.To match the settings in this Rule, a request must originate from 192.0.2.44 AND include a User-Agent header for which the value is BadBot.
The Rule returned in the CreateRule response.
Information about the Rule that you specified in the GetRule request. For more information, see the following topics:
MetricName, Name, an array of Predicate objects, and RuleIdPredicate object contains DataId, Negated, and TypeSpecifies the order in which the Rules in a WebACL are evaluated. Rules with a lower value for Priority are evaluated before Rules with a higher value. The value must be a unique integer. If you add multiple Rules to a WebACL, the values don't need to be consecutive.
An array of RuleSummary objects.
" + } + }, + "RuleSummary": { + "base": "Contains the identifier and the friendly name or description of the Rule.
Specifies a Predicate (such as an IPSet) and indicates whether you want to add it to a Rule or delete it from a Rule.
An array of RuleUpdate objects that you want to insert into or delete from a Rule. For more information, see the applicable data types:
Action and PredicateDataId, Negated, and TypeData and TypeA value that indicates how one result in the response relates proportionally to other results in the response. A result that has a weight of 2 represents roughly twice as many CloudFront web requests as a result that has a weight of 1.
The response from a GetSampledRequests request includes a SampledHTTPRequests complex type that appears as SampledRequests in the response syntax. SampledHTTPRequests contains one SampledHTTPRequest object for each web request that is returned by GetSampledRequests.
A complex type that contains detailed information about each of the requests in the sample.
" + } + }, + "Size": { + "base": null, + "refs": { + "SizeConstraint$Size": "The size in bytes that you want AWS WAF to compare against the size of the specified FieldToMatch. AWS WAF uses this in combination with ComparisonOperator and FieldToMatch to build an expression in the form of \"Size ComparisonOperator size in bytes of FieldToMatch\". If that expression is true, the SizeConstraint is considered to match.
Valid values for size are 0 - 21474836480 bytes (0 - 20 GB).
If you specify URI for the value of Type, the / in the URI counts as one character. For example, the URI /logo.jpg is nine characters long.
Specifies a constraint on the size of a part of the web request. AWS WAF uses the Size, ComparisonOperator, and FieldToMatch to build an expression in the form of \"Size ComparisonOperator size in bytes of FieldToMatch\". If that expression is true, the SizeConstraint is considered to match.
Specifies a constraint on the size of a part of the web request. AWS WAF uses the Size, ComparisonOperator, and FieldToMatch to build an expression in the form of \"Size ComparisonOperator size in bytes of FieldToMatch\". If that expression is true, the SizeConstraint is considered to match.
A complex type that contains SizeConstraint objects, which specify the parts of web requests that you want AWS WAF to inspect the size of. If a SizeConstraintSet contains more than one SizeConstraint object, a request only needs to match one constraint to be considered a match.
A SizeConstraintSet that contains no SizeConstraint objects.
Information about the SizeConstraintSet that you specified in the GetSizeConstraintSet request. For more information, see the following topics:
SizeConstraintSetId, SizeConstraints, and NameSizeConstraints: Contains an array of SizeConstraint objects. Each SizeConstraint object contains FieldToMatch, TextTransformation, ComparisonOperator, and SizeData and TypeAn array of SizeConstraintSetSummary objects.
" + } + }, + "SizeConstraintSetSummary": { + "base": "The Id and Name of a SizeConstraintSet.
Specifies the part of a web request that you want to inspect the size of and indicates whether you want to add the specification to a SizeConstraintSet or delete it from a SizeConstraintSet.
An array of SizeConstraintSetUpdate objects that you want to insert into or delete from a SizeConstraintSet. For more information, see the applicable data types:
Action and SizeConstraintFieldToMatch, TextTransformation, ComparisonOperator, and SizeData and TypeSpecifies the parts of web requests that you want to inspect the size of.
" + } + }, + "SqlInjectionMatchSet": { + "base": "A complex type that contains SqlInjectionMatchTuple objects, which specify the parts of web requests that you want AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header. If a SqlInjectionMatchSet contains more than one SqlInjectionMatchTuple object, a request needs to include snippets of SQL code in only one of the specified parts of the request to be considered a match.
Information about the SqlInjectionMatchSet that you specified in the GetSqlInjectionMatchSet request. For more information, see the following topics:
Name, SqlInjectionMatchSetId, and an array of SqlInjectionMatchTuple objectsSqlInjectionMatchTuple object contains FieldToMatch and TextTransformationData and TypeAn array of SqlInjectionMatchSetSummary objects.
" + } + }, + "SqlInjectionMatchSetSummary": { + "base": "The Id and Name of a SqlInjectionMatchSet.
Specifies the part of a web request that you want to inspect for snippets of malicious SQL code and indicates whether you want to add the specification to a SqlInjectionMatchSet or delete it from a SqlInjectionMatchSet.
An array of SqlInjectionMatchSetUpdate objects that you want to insert into or delete from a SqlInjectionMatchSet. For more information, see the applicable data types:
Action and SqlInjectionMatchTupleFieldToMatch and TextTransformationData and TypeSpecifies the part of a web request that you want AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header.
", + "refs": { + "SqlInjectionMatchSetUpdate$SqlInjectionMatchTuple": "Specifies the part of a web request that you want AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header.
", + "SqlInjectionMatchTuples$member": null + } + }, + "SqlInjectionMatchTuples": { + "base": null, + "refs": { + "SqlInjectionMatchSet$SqlInjectionMatchTuples": "Specifies the parts of web requests that you want to inspect for snippets of malicious SQL code.
" + } + }, + "TextTransformation": { + "base": null, + "refs": { + "ByteMatchTuple$TextTransformation": "Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on TargetString before inspecting a request for a match.
CMD_LINE
When you're concerned that attackers are injecting an operating system commandline command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:
COMPRESS_WHITE_SPACE
Use this option to replace the following characters with a space character (decimal 32):
COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.
HTML_ENTITY_DECODE
Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:
(ampersand)quot; with \"(ampersand)nbsp; with a non-breaking space, decimal 160(ampersand)lt; with a \"less than\" symbol(ampersand)gt; with >(ampersand)#xhhhh;, with the corresponding characters(ampersand)#nnnn;, with the corresponding charactersLOWERCASE
Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
URL_DECODE
Use this option to decode a URL-encoded value.
NONE
Specify NONE if you don't want to perform any text transformations.
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting a request for a match.
Note that if you choose BODY for the value of Type, you must choose NONE for TextTransformation because CloudFront forwards only the first 8192 bytes for inspection.
NONE
Specify NONE if you don't want to perform any text transformations.
CMD_LINE
When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:
COMPRESS_WHITE_SPACE
Use this option to replace the following characters with a space character (decimal 32):
COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.
HTML_ENTITY_DECODE
Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:
(ampersand)quot; with \"(ampersand)nbsp; with a non-breaking space, decimal 160(ampersand)lt; with a \"less than\" symbol(ampersand)gt; with >(ampersand)#xhhhh;, with the corresponding characters(ampersand)#nnnn;, with the corresponding charactersLOWERCASE
Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
URL_DECODE
Use this option to decode a URL-encoded value.
", + "SqlInjectionMatchTuple$TextTransformation": "Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting a request for a match.
CMD_LINE
When you're concerned that attackers are injecting an operating system commandline command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:
COMPRESS_WHITE_SPACE
Use this option to replace the following characters with a space character (decimal 32):
COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.
HTML_ENTITY_DECODE
Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:
(ampersand)quot; with \"(ampersand)nbsp; with a non-breaking space, decimal 160(ampersand)lt; with a \"less than\" symbol(ampersand)gt; with >(ampersand)#xhhhh;, with the corresponding characters(ampersand)#nnnn;, with the corresponding charactersLOWERCASE
Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
URL_DECODE
Use this option to decode a URL-encoded value.
NONE
Specify NONE if you don't want to perform any text transformations.
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting a request for a match.
CMD_LINE
When you're concerned that attackers are injecting an operating system commandline command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:
COMPRESS_WHITE_SPACE
Use this option to replace the following characters with a space character (decimal 32):
COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.
HTML_ENTITY_DECODE
Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:
(ampersand)quot; with \"(ampersand)nbsp; with a non-breaking space, decimal 160(ampersand)lt; with a \"less than\" symbol(ampersand)gt; with >(ampersand)#xhhhh;, with the corresponding characters(ampersand)#nnnn;, with the corresponding charactersLOWERCASE
Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
URL_DECODE
Use this option to decode a URL-encoded value.
NONE
Specify NONE if you don't want to perform any text transformations.
In a GetSampledRequests request, the StartTime and EndTime objects specify the time range for which you want AWS WAF to return a sample of web requests.
In a GetSampledRequests response, the StartTime and EndTime objects specify the time range for which AWS WAF actually returned a sample of web requests. AWS WAF gets the specified number of requests from among the first 5,000 requests that your AWS resource receives during the specified time period. If your resource receives more than 5,000 requests during that period, AWS WAF stops sampling after the 5,000th request. In that case, EndTime is the time that AWS WAF received the 5,000th request.
The start date and time and the end date and time of the range for which you want GetSampledRequests to return a sample of requests. Specify the date and time in Unix time format (in seconds). You can specify any time range in the previous three hours.
Usually, TimeWindow is the time range that you specified in the GetSampledRequests request. However, if your AWS resource received more than 5,000 requests during the time range that you specified in the request, GetSampledRequests returns the time range for the first 5,000 requests.
The time at which AWS WAF received the request from your AWS resource, in Unix time format (in seconds).
", + "TimeWindow$StartTime": "The beginning of the time range from which you want GetSampledRequests to return a sample of the requests that your AWS resource received. You can specify any time range in the previous three hours.
The end of the time range from which you want GetSampledRequests to return a sample of the requests that your AWS resource received. You can specify any time range in the previous three hours.
The part of a web request that identifies the resource, for example, /images/daily-ad.jpg.
A request to update a SqlInjectionMatchSet.
", + "refs": { + } + }, + "UpdateSqlInjectionMatchSetResponse": { + "base": "The response to an UpdateSqlInjectionMatchSets request.
", + "refs": { + } + }, + "UpdateWebACLRequest": { + "base": null, + "refs": { + } + }, + "UpdateWebACLResponse": { + "base": null, + "refs": { + } + }, + "UpdateXssMatchSetRequest": { + "base": "A request to update an XssMatchSet.
", + "refs": { + } + }, + "UpdateXssMatchSetResponse": { + "base": "The response to an UpdateXssMatchSets request.
", + "refs": { + } + }, + "WAFDisallowedNameException": { + "base": "The name specified is invalid.
", + "refs": { + } + }, + "WAFInternalErrorException": { + "base": "The operation failed because of a system problem, even though the request was valid. Retry your request.
", + "refs": { + } + }, + "WAFInvalidAccountException": { + "base": "The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
", + "refs": { + } + }, + "WAFInvalidOperationException": { + "base": "The operation failed because there was nothing to do. For example:
Rule from a WebACL, but the Rule isn't in the specified WebACL.IPSet, but the IP address isn't in the specified IPSet.ByteMatchTuple from a ByteMatchSet, but the ByteMatchTuple isn't in the specified WebACL.Rule to a WebACL, but the Rule already exists in the specified WebACL.IPSet, but the IP address already exists in the specified IPSet.ByteMatchTuple to a ByteMatchSet, but the ByteMatchTuple already exists in the specified WebACL.The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE.WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT.WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT.ByteMatchSet with a FieldToMatch Type other than HEADER, QUERY_STRING, or URI.ByteMatchSet with a Field of HEADER but no value for Data.The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide.
The operation failed because you tried to delete an object that isn't empty. For example:
WebACL that still contains one or more Rule objects.Rule that still contains one or more ByteMatchSet objects or other predicates.ByteMatchSet that contains one or more ByteMatchTuple objects.IPSet that references one or more IP addresses.The operation failed because you tried to add an object to or delete an object from another object that doesn't exist. For example:
Rule to or delete a Rule from a WebACL that doesn't exist.ByteMatchSet to or delete a ByteMatchSet from a Rule that doesn't exist.IPSet that doesn't exist.ByteMatchTuple to or delete a ByteMatchTuple from a ByteMatchSet that doesn't exist.The operation failed because the referenced object doesn't exist.
", + "refs": { + } + }, + "WAFReferencedItemException": { + "base": "The operation failed because you tried to delete an object that is still in use. For example:
ByteMatchSet that is still referenced by a Rule.Rule that is still referenced by a WebACL.The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
", + "refs": { + } + }, + "WafAction": { + "base": "For the action that is associated with a rule in a WebACL, specifies the action that you want AWS WAF to perform when a web request matches all of the conditions in a rule. For the default action in a WebACL, specifies the action that you want AWS WAF to take when a web request doesn't match all of the conditions in any of the rules in a WebACL.
Specifies the action that CloudFront or AWS WAF takes when a web request matches the conditions in the Rule. Valid values for Action include the following:
ALLOW: CloudFront responds with the requested object.BLOCK: CloudFront responds with an HTTP 403 (Forbidden) status code.COUNT: AWS WAF increments a counter of requests that match the conditions in the rule and then continues to inspect the web request based on the remaining rules in the web ACL. The action that you want AWS WAF to take when a request doesn't match the criteria specified in any of the Rule objects that are associated with the WebACL.
The action to perform if none of the Rules contained in the WebACL match. The action is specified by the WafAction object.
Specifies how you want AWS WAF to respond to requests that match the settings in a Rule. Valid settings include the following:
ALLOW: AWS WAF allows requestsBLOCK: AWS WAF blocks requestsCOUNT: AWS WAF increments a counter of the requests that match all of the conditions in the rule. AWS WAF then continues to inspect the web request based on the remaining rules in the web ACL. You can't specify COUNT for the default action for a WebACL.Contains the Rules that identify the requests that you want to allow, block, or count. In a WebACL, you also specify a default action (ALLOW or BLOCK), and the action for each Rule that you add to a WebACL, for example, block requests from specified IP addresses or block requests from specified referrers. You also associate the WebACL with a CloudFront distribution to identify the requests that you want AWS WAF to filter. If you add more than one Rule to a WebACL, a request needs to match only one of the specifications to be allowed, blocked, or counted. For more information, see UpdateWebACL.
The WebACL returned in the CreateWebACL response.
Information about the WebACL that you specified in the GetWebACL request. For more information, see the following topics:
DefaultAction, MetricName, Name, an array of Rule objects, and WebACLIdDefaultAction (Data type is WafAction): Contains TypeRules: Contains an array of ActivatedRule objects, which contain Action, Priority, and RuleIdAction: Contains TypeAn array of WebACLSummary objects.
" + } + }, + "WebACLSummary": { + "base": "Contains the identifier and the name or description of the WebACL.
", + "refs": { + "WebACLSummaries$member": null + } + }, + "WebACLUpdate": { + "base": "Specifies whether to insert a Rule into or delete a Rule from a WebACL.
An array of updates to make to the WebACL.
An array of WebACLUpdate objects that you want to insert into or delete from a WebACL. For more information, see the applicable data types:
Action and ActivatedRuleAction, Priority, and RuleIdTypeA complex type that contains XssMatchTuple objects, which specify the parts of web requests that you want AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of the header. If a XssMatchSet contains more than one XssMatchTuple object, a request needs to include cross-site scripting attacks in only one of the specified parts of the request to be considered a match.
An XssMatchSet.
", + "GetXssMatchSetResponse$XssMatchSet": "Information about the XssMatchSet that you specified in the GetXssMatchSet request. For more information, see the following topics:
Name, XssMatchSetId, and an array of XssMatchTuple objectsXssMatchTuple object contains FieldToMatch and TextTransformationData and TypeAn array of XssMatchSetSummary objects.
" + } + }, + "XssMatchSetSummary": { + "base": "The Id and Name of an XssMatchSet.
Specifies the part of a web request that you want to inspect for cross-site scripting attacks and indicates whether you want to add the specification to an XssMatchSet or delete it from an XssMatchSet.
An array of XssMatchSetUpdate objects that you want to insert into or delete from a XssMatchSet. For more information, see the applicable data types:
Action and XssMatchTupleFieldToMatch and TextTransformationData and TypeSpecifies the part of a web request that you want AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of the header.
", + "refs": { + "XssMatchSetUpdate$XssMatchTuple": "Specifies the part of a web request that you want AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of the header.
", + "XssMatchTuples$member": null + } + }, + "XssMatchTuples": { + "base": null, + "refs": { + "XssMatchSet$XssMatchTuples": "Specifies the parts of web requests that you want to inspect for cross-site scripting attacks.
" + } + }, + "errorMessage": { + "base": null, + "refs": { + "WAFDisallowedNameException$message": null, + "WAFInternalErrorException$message": null, + "WAFInvalidOperationException$message": null, + "WAFLimitsExceededException$message": null, + "WAFNonEmptyEntityException$message": null, + "WAFNonexistentContainerException$message": null, + "WAFNonexistentItemException$message": null, + "WAFReferencedItemException$message": null, + "WAFStaleDataException$message": null + } + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/waf/2015-08-24/examples-1.json b/vendor/github.com/aws/aws-sdk-go/models/apis/waf/2015-08-24/examples-1.json new file mode 100644 index 000000000..0ea7e3b0b --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/waf/2015-08-24/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/workspaces/2015-04-08/api-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/workspaces/2015-04-08/api-2.json new file mode 100644 index 000000000..f9d661b1a --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/workspaces/2015-04-08/api-2.json @@ -0,0 +1,632 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2015-04-08", + "endpointPrefix":"workspaces", + "jsonVersion":"1.1", + "protocol":"json", + "serviceFullName":"Amazon WorkSpaces", + "signatureVersion":"v4", + "targetPrefix":"WorkspacesService" + }, + "operations":{ + "CreateTags":{ + "name":"CreateTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateTagsRequest"}, + "output":{"shape":"CreateTagsResult"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValuesException"}, + {"shape":"ResourceLimitExceededException"} + ] + }, + "CreateWorkspaces":{ + "name":"CreateWorkspaces", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateWorkspacesRequest"}, + "output":{"shape":"CreateWorkspacesResult"}, + "errors":[ + {"shape":"ResourceLimitExceededException"}, + {"shape":"InvalidParameterValuesException"} + ] + }, + "DeleteTags":{ + "name":"DeleteTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteTagsRequest"}, + "output":{"shape":"DeleteTagsResult"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValuesException"} + ] + }, + "DescribeTags":{ + "name":"DescribeTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeTagsRequest"}, + "output":{"shape":"DescribeTagsResult"}, + "errors":[ + {"shape":"ResourceNotFoundException"} + ] + }, + "DescribeWorkspaceBundles":{ + "name":"DescribeWorkspaceBundles", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeWorkspaceBundlesRequest"}, + "output":{"shape":"DescribeWorkspaceBundlesResult"}, + "errors":[ + {"shape":"InvalidParameterValuesException"} + ] + }, + "DescribeWorkspaceDirectories":{ + "name":"DescribeWorkspaceDirectories", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeWorkspaceDirectoriesRequest"}, + "output":{"shape":"DescribeWorkspaceDirectoriesResult"}, + "errors":[ + {"shape":"InvalidParameterValuesException"} + ] + }, + "DescribeWorkspaces":{ + "name":"DescribeWorkspaces", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeWorkspacesRequest"}, + "output":{"shape":"DescribeWorkspacesResult"}, + "errors":[ + {"shape":"InvalidParameterValuesException"}, + {"shape":"ResourceUnavailableException"} + ] + }, + "RebootWorkspaces":{ + "name":"RebootWorkspaces", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RebootWorkspacesRequest"}, + "output":{"shape":"RebootWorkspacesResult"} + }, + "RebuildWorkspaces":{ + "name":"RebuildWorkspaces", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RebuildWorkspacesRequest"}, + "output":{"shape":"RebuildWorkspacesResult"} + }, + "TerminateWorkspaces":{ + "name":"TerminateWorkspaces", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TerminateWorkspacesRequest"}, + "output":{"shape":"TerminateWorkspacesResult"} + } + }, + "shapes":{ + "ARN":{ + "type":"string", + "pattern":"^arn:aws:[A-Za-z0-9][A-za-z0-9_/.-]{0,62}:[A-za-z0-9_/.-]{0,63}:[A-za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-za-z0-9_/.-]{0,127}$" + }, + "Alias":{"type":"string"}, + "BooleanObject":{"type":"boolean"}, + "BundleId":{ + "type":"string", + "pattern":"^wsb-[0-9a-z]{8,63}$" + }, + "BundleIdList":{ + "type":"list", + "member":{"shape":"BundleId"}, + "max":25, + "min":1 + }, + "BundleList":{ + "type":"list", + "member":{"shape":"WorkspaceBundle"} + }, + "BundleOwner":{"type":"string"}, + "Compute":{ + "type":"string", + "enum":[ + "VALUE", + "STANDARD", + "PERFORMANCE" + ] + }, + "ComputeType":{ + "type":"structure", + "members":{ + "Name":{"shape":"Compute"} + } + }, + "ComputerName":{"type":"string"}, + "CreateTagsRequest":{ + "type":"structure", + "required":[ + "ResourceId", + "Tags" + ], + "members":{ + "ResourceId":{"shape":"NonEmptyString"}, + "Tags":{"shape":"TagList"} + } + }, + "CreateTagsResult":{ + "type":"structure", + "members":{ + } + }, + "CreateWorkspacesRequest":{ + "type":"structure", + "required":["Workspaces"], + "members":{ + "Workspaces":{"shape":"WorkspaceRequestList"} + } + }, + "CreateWorkspacesResult":{ + "type":"structure", + "members":{ + "FailedRequests":{"shape":"FailedCreateWorkspaceRequests"}, + "PendingRequests":{"shape":"WorkspaceList"} + } + }, + "DefaultOu":{"type":"string"}, + "DefaultWorkspaceCreationProperties":{ + "type":"structure", + "members":{ + "EnableWorkDocs":{"shape":"BooleanObject"}, + "EnableInternetAccess":{"shape":"BooleanObject"}, + "DefaultOu":{"shape":"DefaultOu"}, + "CustomSecurityGroupId":{"shape":"SecurityGroupId"}, + "UserEnabledAsLocalAdministrator":{"shape":"BooleanObject"} + } + }, + "DeleteTagsRequest":{ + "type":"structure", + "required":[ + "ResourceId", + "TagKeys" + ], + "members":{ + "ResourceId":{"shape":"NonEmptyString"}, + "TagKeys":{"shape":"TagKeyList"} + } + }, + "DeleteTagsResult":{ + "type":"structure", + "members":{ + } + }, + "DescribeTagsRequest":{ + "type":"structure", + "required":["ResourceId"], + "members":{ + "ResourceId":{"shape":"NonEmptyString"} + } + }, + "DescribeTagsResult":{ + "type":"structure", + "members":{ + "TagList":{"shape":"TagList"} + } + }, + "DescribeWorkspaceBundlesRequest":{ + "type":"structure", + "members":{ + "BundleIds":{"shape":"BundleIdList"}, + "Owner":{"shape":"BundleOwner"}, + "NextToken":{"shape":"PaginationToken"} + } + }, + "DescribeWorkspaceBundlesResult":{ + "type":"structure", + "members":{ + "Bundles":{"shape":"BundleList"}, + "NextToken":{"shape":"PaginationToken"} + } + }, + "DescribeWorkspaceDirectoriesRequest":{ + "type":"structure", + "members":{ + "DirectoryIds":{"shape":"DirectoryIdList"}, + "NextToken":{"shape":"PaginationToken"} + } + }, + "DescribeWorkspaceDirectoriesResult":{ + "type":"structure", + "members":{ + "Directories":{"shape":"DirectoryList"}, + "NextToken":{"shape":"PaginationToken"} + } + }, + "DescribeWorkspacesRequest":{ + "type":"structure", + "members":{ + "WorkspaceIds":{"shape":"WorkspaceIdList"}, + "DirectoryId":{"shape":"DirectoryId"}, + "UserName":{"shape":"UserName"}, + "BundleId":{"shape":"BundleId"}, + "Limit":{"shape":"Limit"}, + "NextToken":{"shape":"PaginationToken"} + } + }, + "DescribeWorkspacesResult":{ + "type":"structure", + "members":{ + "Workspaces":{"shape":"WorkspaceList"}, + "NextToken":{"shape":"PaginationToken"} + } + }, + "Description":{"type":"string"}, + "DirectoryId":{ + "type":"string", + "pattern":"^d-[0-9a-f]{8,63}$" + }, + "DirectoryIdList":{ + "type":"list", + "member":{"shape":"DirectoryId"}, + "max":25, + "min":1 + }, + "DirectoryList":{ + "type":"list", + "member":{"shape":"WorkspaceDirectory"} + }, + "DirectoryName":{"type":"string"}, + "DnsIpAddresses":{ + "type":"list", + "member":{"shape":"IpAddress"} + }, + "ErrorType":{"type":"string"}, + "ExceptionMessage":{"type":"string"}, + "FailedCreateWorkspaceRequest":{ + "type":"structure", + "members":{ + "WorkspaceRequest":{"shape":"WorkspaceRequest"}, + "ErrorCode":{"shape":"ErrorType"}, + "ErrorMessage":{"shape":"Description"} + } + }, + "FailedCreateWorkspaceRequests":{ + "type":"list", + "member":{"shape":"FailedCreateWorkspaceRequest"} + }, + "FailedRebootWorkspaceRequests":{ + "type":"list", + "member":{"shape":"FailedWorkspaceChangeRequest"} + }, + "FailedRebuildWorkspaceRequests":{ + "type":"list", + "member":{"shape":"FailedWorkspaceChangeRequest"} + }, + "FailedTerminateWorkspaceRequests":{ + "type":"list", + "member":{"shape":"FailedWorkspaceChangeRequest"} + }, + "FailedWorkspaceChangeRequest":{ + "type":"structure", + "members":{ + "WorkspaceId":{"shape":"WorkspaceId"}, + "ErrorCode":{"shape":"ErrorType"}, + "ErrorMessage":{"shape":"Description"} + } + }, + "InvalidParameterValuesException":{ + "type":"structure", + "members":{ + "message":{"shape":"ExceptionMessage"} + }, + "exception":true + }, + "IpAddress":{"type":"string"}, + "Limit":{ + "type":"integer", + "max":25, + "min":1 + }, + "NonEmptyString":{ + "type":"string", + "min":1 + }, + "PaginationToken":{ + "type":"string", + "max":63, + "min":1 + }, + "RebootRequest":{ + "type":"structure", + "required":["WorkspaceId"], + "members":{ + "WorkspaceId":{"shape":"WorkspaceId"} + } + }, + "RebootWorkspaceRequests":{ + "type":"list", + "member":{"shape":"RebootRequest"}, + "max":25, + "min":1 + }, + "RebootWorkspacesRequest":{ + "type":"structure", + "required":["RebootWorkspaceRequests"], + "members":{ + "RebootWorkspaceRequests":{"shape":"RebootWorkspaceRequests"} + } + }, + "RebootWorkspacesResult":{ + "type":"structure", + "members":{ + "FailedRequests":{"shape":"FailedRebootWorkspaceRequests"} + } + }, + "RebuildRequest":{ + "type":"structure", + "required":["WorkspaceId"], + "members":{ + "WorkspaceId":{"shape":"WorkspaceId"} + } + }, + "RebuildWorkspaceRequests":{ + "type":"list", + "member":{"shape":"RebuildRequest"}, + "max":1, + "min":1 + }, + "RebuildWorkspacesRequest":{ + "type":"structure", + "required":["RebuildWorkspaceRequests"], + "members":{ + "RebuildWorkspaceRequests":{"shape":"RebuildWorkspaceRequests"} + } + }, + "RebuildWorkspacesResult":{ + "type":"structure", + "members":{ + "FailedRequests":{"shape":"FailedRebuildWorkspaceRequests"} + } + }, + "RegistrationCode":{ + "type":"string", + "max":20, + "min":1 + }, + "ResourceLimitExceededException":{ + "type":"structure", + "members":{ + "message":{"shape":"ExceptionMessage"} + }, + "exception":true + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"ExceptionMessage"}, + "ResourceId":{"shape":"NonEmptyString"} + }, + "exception":true + }, + "ResourceUnavailableException":{ + "type":"structure", + "members":{ + "message":{"shape":"ExceptionMessage"}, + "ResourceId":{"shape":"NonEmptyString"} + }, + "exception":true + }, + "SecurityGroupId":{ + "type":"string", + "pattern":"^(sg-[0-9a-f]{8})$" + }, + "SubnetId":{ + "type":"string", + "pattern":"^(subnet-[0-9a-f]{8})$" + }, + "SubnetIds":{ + "type":"list", + "member":{"shape":"SubnetId"} + }, + "Tag":{ + "type":"structure", + "required":["Key"], + "members":{ + "Key":{"shape":"TagKey"}, + "Value":{"shape":"TagValue"} + } + }, + "TagKey":{ + "type":"string", + "max":127, + "min":1 + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"NonEmptyString"} + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"} + }, + "TagValue":{ + "type":"string", + "max":255 + }, + "TerminateRequest":{ + "type":"structure", + "required":["WorkspaceId"], + "members":{ + "WorkspaceId":{"shape":"WorkspaceId"} + } + }, + "TerminateWorkspaceRequests":{ + "type":"list", + "member":{"shape":"TerminateRequest"}, + "max":25, + "min":1 + }, + "TerminateWorkspacesRequest":{ + "type":"structure", + "required":["TerminateWorkspaceRequests"], + "members":{ + "TerminateWorkspaceRequests":{"shape":"TerminateWorkspaceRequests"} + } + }, + "TerminateWorkspacesResult":{ + "type":"structure", + "members":{ + "FailedRequests":{"shape":"FailedTerminateWorkspaceRequests"} + } + }, + "UserName":{ + "type":"string", + "max":63, + "min":1 + }, + "UserStorage":{ + "type":"structure", + "members":{ + "Capacity":{"shape":"NonEmptyString"} + } + }, + "VolumeEncryptionKey":{"type":"string"}, + "Workspace":{ + "type":"structure", + "members":{ + "WorkspaceId":{"shape":"WorkspaceId"}, + "DirectoryId":{"shape":"DirectoryId"}, + "UserName":{"shape":"UserName"}, + "IpAddress":{"shape":"IpAddress"}, + "State":{"shape":"WorkspaceState"}, + "BundleId":{"shape":"BundleId"}, + "SubnetId":{"shape":"SubnetId"}, + "ErrorMessage":{"shape":"Description"}, + "ErrorCode":{"shape":"WorkspaceErrorCode"}, + "ComputerName":{"shape":"ComputerName"}, + "VolumeEncryptionKey":{"shape":"VolumeEncryptionKey"}, + "UserVolumeEncryptionEnabled":{"shape":"BooleanObject"}, + "RootVolumeEncryptionEnabled":{"shape":"BooleanObject"} + } + }, + "WorkspaceBundle":{ + "type":"structure", + "members":{ + "BundleId":{"shape":"BundleId"}, + "Name":{"shape":"NonEmptyString"}, + "Owner":{"shape":"BundleOwner"}, + "Description":{"shape":"Description"}, + "UserStorage":{"shape":"UserStorage"}, + "ComputeType":{"shape":"ComputeType"} + } + }, + "WorkspaceDirectory":{ + "type":"structure", + "members":{ + "DirectoryId":{"shape":"DirectoryId"}, + "Alias":{"shape":"Alias"}, + "DirectoryName":{"shape":"DirectoryName"}, + "RegistrationCode":{"shape":"RegistrationCode"}, + "SubnetIds":{"shape":"SubnetIds"}, + "DnsIpAddresses":{"shape":"DnsIpAddresses"}, + "CustomerUserName":{"shape":"UserName"}, + "IamRoleId":{"shape":"ARN"}, + "DirectoryType":{"shape":"WorkspaceDirectoryType"}, + "WorkspaceSecurityGroupId":{"shape":"SecurityGroupId"}, + "State":{"shape":"WorkspaceDirectoryState"}, + "WorkspaceCreationProperties":{"shape":"DefaultWorkspaceCreationProperties"} + } + }, + "WorkspaceDirectoryState":{ + "type":"string", + "enum":[ + "REGISTERING", + "REGISTERED", + "DEREGISTERING", + "DEREGISTERED", + "ERROR" + ] + }, + "WorkspaceDirectoryType":{ + "type":"string", + "enum":[ + "SIMPLE_AD", + "AD_CONNECTOR" + ] + }, + "WorkspaceErrorCode":{"type":"string"}, + "WorkspaceId":{ + "type":"string", + "pattern":"^ws-[0-9a-z]{8,63}$" + }, + "WorkspaceIdList":{ + "type":"list", + "member":{"shape":"WorkspaceId"}, + "max":25, + "min":1 + }, + "WorkspaceList":{ + "type":"list", + "member":{"shape":"Workspace"} + }, + "WorkspaceRequest":{ + "type":"structure", + "required":[ + "DirectoryId", + "UserName", + "BundleId" + ], + "members":{ + "DirectoryId":{"shape":"DirectoryId"}, + "UserName":{"shape":"UserName"}, + "BundleId":{"shape":"BundleId"}, + "VolumeEncryptionKey":{"shape":"VolumeEncryptionKey"}, + "UserVolumeEncryptionEnabled":{"shape":"BooleanObject"}, + "RootVolumeEncryptionEnabled":{"shape":"BooleanObject"}, + "Tags":{"shape":"TagList"} + } + }, + "WorkspaceRequestList":{ + "type":"list", + "member":{"shape":"WorkspaceRequest"}, + "max":25, + "min":1 + }, + "WorkspaceState":{ + "type":"string", + "enum":[ + "PENDING", + "AVAILABLE", + "IMPAIRED", + "UNHEALTHY", + "REBOOTING", + "REBUILDING", + "TERMINATING", + "TERMINATED", + "SUSPENDED", + "ERROR" + ] + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/workspaces/2015-04-08/docs-2.json b/vendor/github.com/aws/aws-sdk-go/models/apis/workspaces/2015-04-08/docs-2.json new file mode 100644 index 000000000..a48b752c5 --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/workspaces/2015-04-08/docs-2.json @@ -0,0 +1,550 @@ +{ + "version": "2.0", + "service": "This is the Amazon WorkSpaces API Reference. This guide provides detailed information about Amazon WorkSpaces operations, data types, parameters, and errors.
", + "operations": { + "CreateTags": "Creates tags for a WorkSpace.
", + "CreateWorkspaces": "Creates one or more WorkSpaces.
This operation is asynchronous and returns before the WorkSpaces are created.
Deletes tags from a WorkSpace.
", + "DescribeTags": "Describes tags for a WorkSpace.
", + "DescribeWorkspaceBundles": "Obtains information about the WorkSpace bundles that are available to your account in the specified region.
You can filter the results with either the BundleIds parameter, or the Owner parameter, but not both.
This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the NextToken response member contains a token that you pass in the next call to this operation to retrieve the next set of items.
Retrieves information about the AWS Directory Service directories in the region that are registered with Amazon WorkSpaces and are available to your account.
This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the NextToken response member contains a token that you pass in the next call to this operation to retrieve the next set of items.
Obtains information about the specified WorkSpaces.
Only one of the filter parameters, such as BundleId, DirectoryId, or WorkspaceIds, can be specified at a time.
This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the NextToken response member contains a token that you pass in the next call to this operation to retrieve the next set of items.
Reboots the specified WorkSpaces.
To be able to reboot a WorkSpace, the WorkSpace must have a State of AVAILABLE, IMPAIRED, or INOPERABLE.
This operation is asynchronous and will return before the WorkSpaces have rebooted.
Rebuilds the specified WorkSpaces.
Rebuilding a WorkSpace is a potentially destructive action that can result in the loss of data. Rebuilding a WorkSpace causes the following to occur:
To be able to rebuild a WorkSpace, the WorkSpace must have a State of AVAILABLE or ERROR.
This operation is asynchronous and will return before the WorkSpaces have been completely rebuilt.
Terminates the specified WorkSpaces.
Terminating a WorkSpace is a permanent action and cannot be undone. The user's data is not maintained and will be destroyed. If you need to archive any user data, contact Amazon Web Services before terminating the WorkSpace.
You can terminate a WorkSpace that is in any state except SUSPENDED.
This operation is asynchronous and will return before the WorkSpaces have been completely terminated.
The identifier of the IAM role. This is the role that allows Amazon WorkSpaces to make calls to other services, such as Amazon EC2, on your behalf.
" + } + }, + "Alias": { + "base": null, + "refs": { + "WorkspaceDirectory$Alias": "The directory alias.
" + } + }, + "BooleanObject": { + "base": null, + "refs": { + "DefaultWorkspaceCreationProperties$EnableWorkDocs": "Specifies if the directory is enabled for Amazon WorkDocs.
", + "DefaultWorkspaceCreationProperties$EnableInternetAccess": "A public IP address will be attached to all WorkSpaces that are created or rebuilt.
", + "DefaultWorkspaceCreationProperties$UserEnabledAsLocalAdministrator": "The WorkSpace user is an administrator on the WorkSpace.
", + "Workspace$UserVolumeEncryptionEnabled": "Specifies whether the data stored on the user volume, or D: drive, is encrypted.
", + "Workspace$RootVolumeEncryptionEnabled": "Specifies whether the data stored on the root volume, or C: drive, is encrypted.
", + "WorkspaceRequest$UserVolumeEncryptionEnabled": "Specifies whether the data stored on the user volume, or D: drive, is encrypted.
", + "WorkspaceRequest$RootVolumeEncryptionEnabled": "Specifies whether the data stored on the root volume, or C: drive, is encrypted.
" + } + }, + "BundleId": { + "base": null, + "refs": { + "BundleIdList$member": null, + "DescribeWorkspacesRequest$BundleId": "The identifier of a bundle to obtain the WorkSpaces for. All WorkSpaces that are created from this bundle will be retrieved. This parameter cannot be combined with any other filter parameter.
", + "Workspace$BundleId": "The identifier of the bundle that the WorkSpace was created from.
", + "WorkspaceBundle$BundleId": "The bundle identifier.
", + "WorkspaceRequest$BundleId": "The identifier of the bundle to create the WorkSpace from. You can use the DescribeWorkspaceBundles operation to obtain a list of the bundles that are available.
" + } + }, + "BundleIdList": { + "base": null, + "refs": { + "DescribeWorkspaceBundlesRequest$BundleIds": "An array of strings that contains the identifiers of the bundles to retrieve. This parameter cannot be combined with any other filter parameter.
" + } + }, + "BundleList": { + "base": null, + "refs": { + "DescribeWorkspaceBundlesResult$Bundles": "An array of structures that contain information about the bundles.
" + } + }, + "BundleOwner": { + "base": null, + "refs": { + "DescribeWorkspaceBundlesRequest$Owner": "The owner of the bundles to retrieve. This parameter cannot be combined with any other filter parameter.
This contains one of the following values:
AMAZON - Retrieves the bundles that are provided by AWS.The owner of the bundle. This contains the owner's account identifier, or AMAZON if the bundle is provided by AWS.
The name of the compute type for the bundle.
" + } + }, + "ComputeType": { + "base": "Contains information about the compute type of a WorkSpace bundle.
", + "refs": { + "WorkspaceBundle$ComputeType": "A ComputeType object that specifies the compute type for the bundle.
" + } + }, + "ComputerName": { + "base": null, + "refs": { + "Workspace$ComputerName": "The name of the WorkSpace as seen by the operating system.
" + } + }, + "CreateTagsRequest": { + "base": "The request of the create tags action.
", + "refs": { + } + }, + "CreateTagsResult": { + "base": "The result of the create tags action.
", + "refs": { + } + }, + "CreateWorkspacesRequest": { + "base": "Contains the inputs for the CreateWorkspaces operation.
", + "refs": { + } + }, + "CreateWorkspacesResult": { + "base": "Contains the result of the CreateWorkspaces operation.
", + "refs": { + } + }, + "DefaultOu": { + "base": null, + "refs": { + "DefaultWorkspaceCreationProperties$DefaultOu": "The organizational unit (OU) in the directory that the WorkSpace machine accounts are placed in.
" + } + }, + "DefaultWorkspaceCreationProperties": { + "base": "Contains default WorkSpace creation information.
", + "refs": { + "WorkspaceDirectory$WorkspaceCreationProperties": "A structure that specifies the default creation properties for all WorkSpaces in the directory.
" + } + }, + "DeleteTagsRequest": { + "base": "The request of the delete tags action.
", + "refs": { + } + }, + "DeleteTagsResult": { + "base": "The result of the delete tags action.
", + "refs": { + } + }, + "DescribeTagsRequest": { + "base": "The request of the describe tags action.
", + "refs": { + } + }, + "DescribeTagsResult": { + "base": "The result of the describe tags action.
", + "refs": { + } + }, + "DescribeWorkspaceBundlesRequest": { + "base": "Contains the inputs for the DescribeWorkspaceBundles operation.
", + "refs": { + } + }, + "DescribeWorkspaceBundlesResult": { + "base": "Contains the results of the DescribeWorkspaceBundles operation.
", + "refs": { + } + }, + "DescribeWorkspaceDirectoriesRequest": { + "base": "Contains the inputs for the DescribeWorkspaceDirectories operation.
", + "refs": { + } + }, + "DescribeWorkspaceDirectoriesResult": { + "base": "Contains the results of the DescribeWorkspaceDirectories operation.
", + "refs": { + } + }, + "DescribeWorkspacesRequest": { + "base": "Contains the inputs for the DescribeWorkspaces operation.
", + "refs": { + } + }, + "DescribeWorkspacesResult": { + "base": "Contains the results for the DescribeWorkspaces operation.
", + "refs": { + } + }, + "Description": { + "base": null, + "refs": { + "FailedCreateWorkspaceRequest$ErrorMessage": "The textual error message.
", + "FailedWorkspaceChangeRequest$ErrorMessage": "The textual error message.
", + "Workspace$ErrorMessage": "If the WorkSpace could not be created, this contains a textual error message that describes the failure.
", + "WorkspaceBundle$Description": "The bundle description.
" + } + }, + "DirectoryId": { + "base": null, + "refs": { + "DescribeWorkspacesRequest$DirectoryId": "Specifies the directory identifier to which to limit the WorkSpaces. Optionally, you can specify a specific directory user with the UserName parameter. This parameter cannot be combined with any other filter parameter.
The identifier of the AWS Directory Service directory that the WorkSpace belongs to.
", + "WorkspaceDirectory$DirectoryId": "The directory identifier.
", + "WorkspaceRequest$DirectoryId": "The identifier of the AWS Directory Service directory to create the WorkSpace in. You can use the DescribeWorkspaceDirectories operation to obtain a list of the directories that are available.
" + } + }, + "DirectoryIdList": { + "base": null, + "refs": { + "DescribeWorkspaceDirectoriesRequest$DirectoryIds": "An array of strings that contains the directory identifiers to retrieve information for. If this member is null, all directories are retrieved.
" + } + }, + "DirectoryList": { + "base": null, + "refs": { + "DescribeWorkspaceDirectoriesResult$Directories": "An array of structures that contain information about the directories.
" + } + }, + "DirectoryName": { + "base": null, + "refs": { + "WorkspaceDirectory$DirectoryName": "The name of the directory.
" + } + }, + "DnsIpAddresses": { + "base": null, + "refs": { + "WorkspaceDirectory$DnsIpAddresses": "An array of strings that contains the IP addresses of the DNS servers for the directory.
" + } + }, + "ErrorType": { + "base": null, + "refs": { + "FailedCreateWorkspaceRequest$ErrorCode": "The error code.
", + "FailedWorkspaceChangeRequest$ErrorCode": "The error code.
" + } + }, + "ExceptionMessage": { + "base": null, + "refs": { + "InvalidParameterValuesException$message": "The exception error message.
", + "ResourceLimitExceededException$message": "The exception error message.
", + "ResourceNotFoundException$message": "The resource could not be found.
", + "ResourceUnavailableException$message": "The exception error message.
" + } + }, + "FailedCreateWorkspaceRequest": { + "base": "Contains information about a WorkSpace that could not be created.
", + "refs": { + "FailedCreateWorkspaceRequests$member": null + } + }, + "FailedCreateWorkspaceRequests": { + "base": null, + "refs": { + "CreateWorkspacesResult$FailedRequests": "An array of structures that represent the WorkSpaces that could not be created.
" + } + }, + "FailedRebootWorkspaceRequests": { + "base": null, + "refs": { + "RebootWorkspacesResult$FailedRequests": "An array of structures that represent any WorkSpaces that could not be rebooted.
" + } + }, + "FailedRebuildWorkspaceRequests": { + "base": null, + "refs": { + "RebuildWorkspacesResult$FailedRequests": "An array of structures that represent any WorkSpaces that could not be rebuilt.
" + } + }, + "FailedTerminateWorkspaceRequests": { + "base": null, + "refs": { + "TerminateWorkspacesResult$FailedRequests": "An array of structures that represent any WorkSpaces that could not be terminated.
" + } + }, + "FailedWorkspaceChangeRequest": { + "base": "Contains information about a WorkSpace that could not be rebooted (RebootWorkspaces), rebuilt (RebuildWorkspaces), or terminated (TerminateWorkspaces).
", + "refs": { + "FailedRebootWorkspaceRequests$member": null, + "FailedRebuildWorkspaceRequests$member": null, + "FailedTerminateWorkspaceRequests$member": null + } + }, + "InvalidParameterValuesException": { + "base": "One or more parameter values are not valid.
", + "refs": { + } + }, + "IpAddress": { + "base": null, + "refs": { + "DnsIpAddresses$member": null, + "Workspace$IpAddress": "The IP address of the WorkSpace.
" + } + }, + "Limit": { + "base": null, + "refs": { + "DescribeWorkspacesRequest$Limit": "The maximum number of items to return.
" + } + }, + "NonEmptyString": { + "base": null, + "refs": { + "CreateTagsRequest$ResourceId": "The resource ID of the request.
", + "DeleteTagsRequest$ResourceId": "The resource ID of the request.
", + "DescribeTagsRequest$ResourceId": "The resource ID of the request.
", + "ResourceNotFoundException$ResourceId": "The resource could not be found.
", + "ResourceUnavailableException$ResourceId": "The identifier of the resource that is not available.
", + "TagKeyList$member": null, + "UserStorage$Capacity": "The amount of user storage for the bundle.
", + "WorkspaceBundle$Name": "The name of the bundle.
" + } + }, + "PaginationToken": { + "base": null, + "refs": { + "DescribeWorkspaceBundlesRequest$NextToken": "The NextToken value from a previous call to this operation. Pass null if this is the first call.
If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to this operation to retrieve the next set of items. This token is valid for one day and must be used within that timeframe.
The NextToken value from a previous call to this operation. Pass null if this is the first call.
If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to this operation to retrieve the next set of items. This token is valid for one day and must be used within that timeframe.
The NextToken value from a previous call to this operation. Pass null if this is the first call.
If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to this operation to retrieve the next set of items. This token is valid for one day and must be used within that timeframe.
Contains information used with the RebootWorkspaces operation to reboot a WorkSpace.
", + "refs": { + "RebootWorkspaceRequests$member": null + } + }, + "RebootWorkspaceRequests": { + "base": null, + "refs": { + "RebootWorkspacesRequest$RebootWorkspaceRequests": "An array of structures that specify the WorkSpaces to reboot.
" + } + }, + "RebootWorkspacesRequest": { + "base": "Contains the inputs for the RebootWorkspaces operation.
", + "refs": { + } + }, + "RebootWorkspacesResult": { + "base": "Contains the results of the RebootWorkspaces operation.
", + "refs": { + } + }, + "RebuildRequest": { + "base": "Contains information used with the RebuildWorkspaces operation to rebuild a WorkSpace.
", + "refs": { + "RebuildWorkspaceRequests$member": null + } + }, + "RebuildWorkspaceRequests": { + "base": null, + "refs": { + "RebuildWorkspacesRequest$RebuildWorkspaceRequests": "An array of structures that specify the WorkSpaces to rebuild.
" + } + }, + "RebuildWorkspacesRequest": { + "base": "Contains the inputs for the RebuildWorkspaces operation.
", + "refs": { + } + }, + "RebuildWorkspacesResult": { + "base": "Contains the results of the RebuildWorkspaces operation.
", + "refs": { + } + }, + "RegistrationCode": { + "base": null, + "refs": { + "WorkspaceDirectory$RegistrationCode": "The registration code for the directory. This is the code that users enter in their Amazon WorkSpaces client application to connect to the directory.
" + } + }, + "ResourceLimitExceededException": { + "base": "Your resource limits have been exceeded.
", + "refs": { + } + }, + "ResourceNotFoundException": { + "base": "The resource could not be found.
", + "refs": { + } + }, + "ResourceUnavailableException": { + "base": "The specified resource is not available.
", + "refs": { + } + }, + "SecurityGroupId": { + "base": null, + "refs": { + "DefaultWorkspaceCreationProperties$CustomSecurityGroupId": "The identifier of any custom security groups that are applied to the WorkSpaces when they are created.
", + "WorkspaceDirectory$WorkspaceSecurityGroupId": "The identifier of the security group that is assigned to new WorkSpaces.
" + } + }, + "SubnetId": { + "base": null, + "refs": { + "SubnetIds$member": null, + "Workspace$SubnetId": "The identifier of the subnet that the WorkSpace is in.
" + } + }, + "SubnetIds": { + "base": null, + "refs": { + "WorkspaceDirectory$SubnetIds": "An array of strings that contains the identifiers of the subnets used with the directory.
" + } + }, + "Tag": { + "base": "Describes the tag of the WorkSpace.
", + "refs": { + "TagList$member": null + } + }, + "TagKey": { + "base": null, + "refs": { + "Tag$Key": "The key of the tag.
" + } + }, + "TagKeyList": { + "base": null, + "refs": { + "DeleteTagsRequest$TagKeys": "The tag keys of the request.
" + } + }, + "TagList": { + "base": null, + "refs": { + "CreateTagsRequest$Tags": "The tags of the request.
", + "DescribeTagsResult$TagList": "The list of tags.
", + "WorkspaceRequest$Tags": "The tags of the WorkSpace request.
" + } + }, + "TagValue": { + "base": null, + "refs": { + "Tag$Value": "The value of the tag.
" + } + }, + "TerminateRequest": { + "base": "Contains information used with the TerminateWorkspaces operation to terminate a WorkSpace.
", + "refs": { + "TerminateWorkspaceRequests$member": null + } + }, + "TerminateWorkspaceRequests": { + "base": null, + "refs": { + "TerminateWorkspacesRequest$TerminateWorkspaceRequests": "An array of structures that specify the WorkSpaces to terminate.
" + } + }, + "TerminateWorkspacesRequest": { + "base": "Contains the inputs for the TerminateWorkspaces operation.
", + "refs": { + } + }, + "TerminateWorkspacesResult": { + "base": "Contains the results of the TerminateWorkspaces operation.
", + "refs": { + } + }, + "UserName": { + "base": null, + "refs": { + "DescribeWorkspacesRequest$UserName": "Used with the DirectoryId parameter to specify the directory user for which to obtain the WorkSpace.
The user that the WorkSpace is assigned to.
", + "WorkspaceDirectory$CustomerUserName": "The user name for the service account.
", + "WorkspaceRequest$UserName": "The username that the WorkSpace is assigned to. This username must exist in the AWS Directory Service directory specified by the DirectoryId member.
Contains information about the user storage for a WorkSpace bundle.
", + "refs": { + "WorkspaceBundle$UserStorage": "A UserStorage object that specifies the amount of user storage that the bundle contains.
" + } + }, + "VolumeEncryptionKey": { + "base": null, + "refs": { + "Workspace$VolumeEncryptionKey": "The KMS key used to encrypt data stored on your WorkSpace.
", + "WorkspaceRequest$VolumeEncryptionKey": "The KMS key used to encrypt data stored on your WorkSpace.
" + } + }, + "Workspace": { + "base": "Contains information about a WorkSpace.
", + "refs": { + "WorkspaceList$member": null + } + }, + "WorkspaceBundle": { + "base": "Contains information about a WorkSpace bundle.
", + "refs": { + "BundleList$member": null + } + }, + "WorkspaceDirectory": { + "base": "Contains information about an AWS Directory Service directory for use with Amazon WorkSpaces.
", + "refs": { + "DirectoryList$member": null + } + }, + "WorkspaceDirectoryState": { + "base": null, + "refs": { + "WorkspaceDirectory$State": "The state of the directory's registration with Amazon WorkSpaces
" + } + }, + "WorkspaceDirectoryType": { + "base": null, + "refs": { + "WorkspaceDirectory$DirectoryType": "The directory type.
" + } + }, + "WorkspaceErrorCode": { + "base": null, + "refs": { + "Workspace$ErrorCode": "If the WorkSpace could not be created, this contains the error code.
" + } + }, + "WorkspaceId": { + "base": null, + "refs": { + "FailedWorkspaceChangeRequest$WorkspaceId": "The identifier of the WorkSpace.
", + "RebootRequest$WorkspaceId": "The identifier of the WorkSpace to reboot.
", + "RebuildRequest$WorkspaceId": "The identifier of the WorkSpace to rebuild.
", + "TerminateRequest$WorkspaceId": "The identifier of the WorkSpace to terminate.
", + "Workspace$WorkspaceId": "The identifier of the WorkSpace.
", + "WorkspaceIdList$member": null + } + }, + "WorkspaceIdList": { + "base": null, + "refs": { + "DescribeWorkspacesRequest$WorkspaceIds": "An array of strings that contain the identifiers of the WorkSpaces for which to retrieve information. This parameter cannot be combined with any other filter parameter.
Because the CreateWorkspaces operation is asynchronous, the identifier returned by CreateWorkspaces is not immediately available. If you immediately call DescribeWorkspaces with this identifier, no information will be returned.
" + } + }, + "WorkspaceList": { + "base": null, + "refs": { + "CreateWorkspacesResult$PendingRequests": "An array of structures that represent the WorkSpaces that were created.
Because this operation is asynchronous, the identifier in WorkspaceId is not immediately available. If you immediately call DescribeWorkspaces with this identifier, no information will be returned.
An array of structures that contain the information about the WorkSpaces.
Because the CreateWorkspaces operation is asynchronous, some of this information may be incomplete for a newly-created WorkSpace.
" + } + }, + "WorkspaceRequest": { + "base": "Contains information about a WorkSpace creation request.
", + "refs": { + "FailedCreateWorkspaceRequest$WorkspaceRequest": "A WorkspaceRequest object that contains the information about the WorkSpace that could not be created.
", + "WorkspaceRequestList$member": null + } + }, + "WorkspaceRequestList": { + "base": null, + "refs": { + "CreateWorkspacesRequest$Workspaces": "An array of structures that specify the WorkSpaces to create.
" + } + }, + "WorkspaceState": { + "base": null, + "refs": { + "Workspace$State": "The operational state of the WorkSpace.
" + } + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/workspaces/2015-04-08/examples-1.json b/vendor/github.com/aws/aws-sdk-go/models/apis/workspaces/2015-04-08/examples-1.json new file mode 100644 index 000000000..0ea7e3b0b --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/workspaces/2015-04-08/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/apis/workspaces/2015-04-08/paginators-1.json b/vendor/github.com/aws/aws-sdk-go/models/apis/workspaces/2015-04-08/paginators-1.json new file mode 100644 index 000000000..efa8cbad2 --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/apis/workspaces/2015-04-08/paginators-1.json @@ -0,0 +1,20 @@ +{ + "pagination": { + "DescribeWorkspaceBundles": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "Bundles" + }, + "DescribeWorkspaceDirectories": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "Directories" + }, + "DescribeWorkspaces": { + "limit_key": "Limit", + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "Workspaces" + } + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/protocol_tests/generate.go b/vendor/github.com/aws/aws-sdk-go/models/protocol_tests/generate.go new file mode 100644 index 000000000..50a56c3f1 --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/protocol_tests/generate.go @@ -0,0 +1,432 @@ +package main + +import ( + "bytes" + "encoding/json" + "fmt" + "net/url" + "os" + "os/exec" + "reflect" + "regexp" + "sort" + "strconv" + "strings" + "text/template" + + "github.com/aws/aws-sdk-go/private/model/api" + "github.com/aws/aws-sdk-go/private/util" +) + +// TestSuiteTypeInput input test +// TestSuiteTypeInput output test +const ( + TestSuiteTypeInput = iota + TestSuiteTypeOutput +) + +type testSuite struct { + *api.API + Description string + Cases []testCase + Type uint + title string +} + +type testCase struct { + TestSuite *testSuite + Given *api.Operation + Params interface{} `json:",omitempty"` + Data interface{} `json:"result,omitempty"` + InputTest testExpectation `json:"serialized"` + OutputTest testExpectation `json:"response"` +} + +type testExpectation struct { + Body string + URI string + Headers map[string]string + StatusCode uint `json:"status_code"` +} + +const preamble = ` +var _ bytes.Buffer // always import bytes +var _ http.Request +var _ json.Marshaler +var _ time.Time +var _ xmlutil.XMLNode +var _ xml.Attr +var _ = ioutil.Discard +var _ = util.Trim("") +var _ = url.Values{} +var _ = io.EOF +var _ = aws.String +var _ = fmt.Println + +func init() { + protocol.RandReader = &awstesting.ZeroReader{} +} +` + +var reStripSpace = regexp.MustCompile(`\s(\w)`) + +var reImportRemoval = regexp.MustCompile(`(?s:import \((.+?)\))`) + +func removeImports(code string) string { + return reImportRemoval.ReplaceAllString(code, "") +} + +var extraImports = []string{ + "bytes", + "encoding/json", + "encoding/xml", + "fmt", + "io", + "io/ioutil", + "net/http", + "testing", + "time", + "net/url", + "", + "github.com/aws/aws-sdk-go/awstesting", + "github.com/aws/aws-sdk-go/aws/session", + "github.com/aws/aws-sdk-go/private/protocol", + "github.com/aws/aws-sdk-go/private/protocol/xml/xmlutil", + "github.com/aws/aws-sdk-go/private/util", + "github.com/stretchr/testify/assert", +} + +func addImports(code string) string { + importNames := make([]string, len(extraImports)) + for i, n := range extraImports { + if n != "" { + importNames[i] = fmt.Sprintf("%q", n) + } + } + + str := reImportRemoval.ReplaceAllString(code, "import (\n"+strings.Join(importNames, "\n")+"$1\n)") + return str +} + +func (t *testSuite) TestSuite() string { + var buf bytes.Buffer + + t.title = reStripSpace.ReplaceAllStringFunc(t.Description, func(x string) string { + return strings.ToUpper(x[1:]) + }) + t.title = regexp.MustCompile(`\W`).ReplaceAllString(t.title, "") + + for idx, c := range t.Cases { + c.TestSuite = t + buf.WriteString(c.TestCase(idx) + "\n") + } + return buf.String() +} + +var tplInputTestCase = template.Must(template.New("inputcase").Parse(` +func Test{{ .OpName }}(t *testing.T) { + sess := session.New() + svc := New{{ .TestCase.TestSuite.API.StructName }}(sess, &aws.Config{Endpoint: aws.String("https://test")}) + {{ if ne .ParamsString "" }}input := {{ .ParamsString }} + req, _ := svc.{{ .TestCase.Given.ExportedName }}Request(input){{ else }}req, _ := svc.{{ .TestCase.Given.ExportedName }}Request(nil){{ end }} + r := req.HTTPRequest + + // build request + {{ .TestCase.TestSuite.API.ProtocolPackage }}.Build(req) + assert.NoError(t, req.Error) + + {{ if ne .TestCase.InputTest.Body "" }}// assert body + assert.NotNil(t, r.Body) + {{ .BodyAssertions }}{{ end }} + + {{ if ne .TestCase.InputTest.URI "" }}// assert URL + awstesting.AssertURL(t, "https://test{{ .TestCase.InputTest.URI }}", r.URL.String()){{ end }} + + // assert headers +{{ range $k, $v := .TestCase.InputTest.Headers }}assert.Equal(t, "{{ $v }}", r.Header.Get("{{ $k }}")) +{{ end }} +} +`)) + +type tplInputTestCaseData struct { + TestCase *testCase + OpName, ParamsString string +} + +func (t tplInputTestCaseData) BodyAssertions() string { + code := &bytes.Buffer{} + protocol := t.TestCase.TestSuite.API.Metadata.Protocol + + // Extract the body bytes + switch protocol { + case "rest-xml": + fmt.Fprintln(code, "body := util.SortXML(r.Body)") + default: + fmt.Fprintln(code, "body, _ := ioutil.ReadAll(r.Body)") + } + + // Generate the body verification code + expectedBody := util.Trim(t.TestCase.InputTest.Body) + switch protocol { + case "ec2", "query": + fmt.Fprintf(code, "awstesting.AssertQuery(t, `%s`, util.Trim(string(body)))", + expectedBody) + case "rest-xml": + if strings.HasPrefix(expectedBody, "<") { + fmt.Fprintf(code, "awstesting.AssertXML(t, `%s`, util.Trim(string(body)), %s{})", + expectedBody, t.TestCase.Given.InputRef.ShapeName) + } else { + fmt.Fprintf(code, "assert.Equal(t, `%s`, util.Trim(string(body)))", + expectedBody) + } + case "json", "jsonrpc", "rest-json": + if strings.HasPrefix(expectedBody, "{") { + fmt.Fprintf(code, "awstesting.AssertJSON(t, `%s`, util.Trim(string(body)))", + expectedBody) + } else { + fmt.Fprintf(code, "assert.Equal(t, `%s`, util.Trim(string(body)))", + expectedBody) + } + default: + fmt.Fprintf(code, "assert.Equal(t, `%s`, util.Trim(string(body)))", + expectedBody) + } + + return code.String() +} + +var tplOutputTestCase = template.Must(template.New("outputcase").Parse(` +func Test{{ .OpName }}(t *testing.T) { + sess := session.New() + svc := New{{ .TestCase.TestSuite.API.StructName }}(sess, &aws.Config{Endpoint: aws.String("https://test")}) + + buf := bytes.NewReader([]byte({{ .Body }})) + req, out := svc.{{ .TestCase.Given.ExportedName }}Request(nil) + req.HTTPResponse = &http.Response{StatusCode: 200, Body: ioutil.NopCloser(buf), Header: http.Header{}} + + // set headers + {{ range $k, $v := .TestCase.OutputTest.Headers }}req.HTTPResponse.Header.Set("{{ $k }}", "{{ $v }}") + {{ end }} + + // unmarshal response + {{ .TestCase.TestSuite.API.ProtocolPackage }}.UnmarshalMeta(req) + {{ .TestCase.TestSuite.API.ProtocolPackage }}.Unmarshal(req) + assert.NoError(t, req.Error) + + // assert response + assert.NotNil(t, out) // ensure out variable is used + {{ .Assertions }} +} +`)) + +type tplOutputTestCaseData struct { + TestCase *testCase + Body, OpName, Assertions string +} + +func (i *testCase) TestCase(idx int) string { + var buf bytes.Buffer + + opName := i.TestSuite.API.StructName() + i.TestSuite.title + "Case" + strconv.Itoa(idx+1) + + if i.TestSuite.Type == TestSuiteTypeInput { // input test + // query test should sort body as form encoded values + switch i.TestSuite.API.Metadata.Protocol { + case "query", "ec2": + m, _ := url.ParseQuery(i.InputTest.Body) + i.InputTest.Body = m.Encode() + case "rest-xml": + i.InputTest.Body = util.SortXML(bytes.NewReader([]byte(i.InputTest.Body))) + case "json", "rest-json": + i.InputTest.Body = strings.Replace(i.InputTest.Body, " ", "", -1) + } + + input := tplInputTestCaseData{ + TestCase: i, + OpName: strings.ToUpper(opName[0:1]) + opName[1:], + ParamsString: api.ParamsStructFromJSON(i.Params, i.Given.InputRef.Shape, false), + } + + if err := tplInputTestCase.Execute(&buf, input); err != nil { + panic(err) + } + } else if i.TestSuite.Type == TestSuiteTypeOutput { + output := tplOutputTestCaseData{ + TestCase: i, + Body: fmt.Sprintf("%q", i.OutputTest.Body), + OpName: strings.ToUpper(opName[0:1]) + opName[1:], + Assertions: GenerateAssertions(i.Data, i.Given.OutputRef.Shape, "out"), + } + + if err := tplOutputTestCase.Execute(&buf, output); err != nil { + panic(err) + } + } + + return buf.String() +} + +// generateTestSuite generates a protocol test suite for a given configuration +// JSON protocol test file. +func generateTestSuite(filename string) string { + inout := "Input" + if strings.Contains(filename, "output/") { + inout = "Output" + } + + var suites []testSuite + f, err := os.Open(filename) + if err != nil { + panic(err) + } + + err = json.NewDecoder(f).Decode(&suites) + if err != nil { + panic(err) + } + + var buf bytes.Buffer + buf.WriteString("package " + suites[0].ProtocolPackage() + "_test\n\n") + + var innerBuf bytes.Buffer + innerBuf.WriteString("//\n// Tests begin here\n//\n\n\n") + + for i, suite := range suites { + svcPrefix := inout + "Service" + strconv.Itoa(i+1) + suite.API.Metadata.ServiceAbbreviation = svcPrefix + "ProtocolTest" + suite.API.Operations = map[string]*api.Operation{} + for idx, c := range suite.Cases { + c.Given.ExportedName = svcPrefix + "TestCaseOperation" + strconv.Itoa(idx+1) + suite.API.Operations[c.Given.ExportedName] = c.Given + } + + suite.Type = getType(inout) + suite.API.NoInitMethods = true // don't generate init methods + suite.API.NoStringerMethods = true // don't generate stringer methods + suite.API.NoConstServiceNames = true // don't generate service names + suite.API.Setup() + suite.API.Metadata.EndpointPrefix = suite.API.PackageName() + + // Sort in order for deterministic test generation + names := make([]string, 0, len(suite.API.Shapes)) + for n := range suite.API.Shapes { + names = append(names, n) + } + sort.Strings(names) + for _, name := range names { + s := suite.API.Shapes[name] + s.Rename(svcPrefix + "TestShape" + name) + } + + svcCode := addImports(suite.API.ServiceGoCode()) + if i == 0 { + importMatch := reImportRemoval.FindStringSubmatch(svcCode) + buf.WriteString(importMatch[0] + "\n\n") + buf.WriteString(preamble + "\n\n") + } + svcCode = removeImports(svcCode) + svcCode = strings.Replace(svcCode, "func New(", "func New"+suite.API.StructName()+"(", -1) + svcCode = strings.Replace(svcCode, "func newClient(", "func new"+suite.API.StructName()+"Client(", -1) + svcCode = strings.Replace(svcCode, "return newClient(", "return new"+suite.API.StructName()+"Client(", -1) + buf.WriteString(svcCode + "\n\n") + + apiCode := removeImports(suite.API.APIGoCode()) + apiCode = strings.Replace(apiCode, "var oprw sync.Mutex", "", -1) + apiCode = strings.Replace(apiCode, "oprw.Lock()", "", -1) + apiCode = strings.Replace(apiCode, "defer oprw.Unlock()", "", -1) + buf.WriteString(apiCode + "\n\n") + + innerBuf.WriteString(suite.TestSuite() + "\n") + } + + return buf.String() + innerBuf.String() +} + +// findMember searches the shape for the member with the matching key name. +func findMember(shape *api.Shape, key string) string { + for actualKey := range shape.MemberRefs { + if strings.ToLower(key) == strings.ToLower(actualKey) { + return actualKey + } + } + return "" +} + +// GenerateAssertions builds assertions for a shape based on its type. +// +// The shape's recursive values also will have assertions generated for them. +func GenerateAssertions(out interface{}, shape *api.Shape, prefix string) string { + switch t := out.(type) { + case map[string]interface{}: + keys := util.SortedKeys(t) + + code := "" + if shape.Type == "map" { + for _, k := range keys { + v := t[k] + s := shape.ValueRef.Shape + code += GenerateAssertions(v, s, prefix+"[\""+k+"\"]") + } + } else { + for _, k := range keys { + v := t[k] + m := findMember(shape, k) + s := shape.MemberRefs[m].Shape + code += GenerateAssertions(v, s, prefix+"."+m+"") + } + } + return code + case []interface{}: + code := "" + for i, v := range t { + s := shape.MemberRef.Shape + code += GenerateAssertions(v, s, prefix+"["+strconv.Itoa(i)+"]") + } + return code + default: + switch shape.Type { + case "timestamp": + return fmt.Sprintf("assert.Equal(t, time.Unix(%#v, 0).UTC().String(), %s.String())\n", out, prefix) + case "blob": + return fmt.Sprintf("assert.Equal(t, %#v, string(%s))\n", out, prefix) + case "integer", "long": + return fmt.Sprintf("assert.Equal(t, int64(%#v), *%s)\n", out, prefix) + default: + if !reflect.ValueOf(out).IsValid() { + return fmt.Sprintf("assert.Nil(t, %s)\n", prefix) + } + return fmt.Sprintf("assert.Equal(t, %#v, *%s)\n", out, prefix) + } + } +} + +func getType(t string) uint { + switch t { + case "Input": + return TestSuiteTypeInput + case "Output": + return TestSuiteTypeOutput + default: + panic("Invalid type for test suite") + } +} + +func main() { + out := generateTestSuite(os.Args[1]) + if len(os.Args) == 3 { + f, err := os.Create(os.Args[2]) + defer f.Close() + if err != nil { + panic(err) + } + f.WriteString(util.GoFmt(out)) + f.Close() + + c := exec.Command("gofmt", "-s", "-w", os.Args[2]) + if err := c.Run(); err != nil { + panic(err) + } + } else { + fmt.Println(out) + } +} diff --git a/vendor/github.com/aws/aws-sdk-go/models/protocol_tests/input/ec2.json b/vendor/github.com/aws/aws-sdk-go/models/protocol_tests/input/ec2.json new file mode 100644 index 000000000..046626eab --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/protocol_tests/input/ec2.json @@ -0,0 +1,422 @@ +[ + { + "description": "Scalar members", + "metadata": { + "protocol": "ec2", + "apiVersion": "2014-01-01" + }, + "shapes": { + "InputShape": { + "type": "structure", + "members": { + "Foo": { + "shape": "StringType" + }, + "Bar": { + "shape": "StringType" + } + } + }, + "StringType": { + "type": "string" + } + }, + "cases": [ + { + "given": { + "input": { + "shape": "InputShape" + }, + "name": "OperationName" + }, + "params": { + "Foo": "val1", + "Bar": "val2" + }, + "serialized": { + "uri": "/", + "body": "Action=OperationName&Version=2014-01-01&Foo=val1&Bar=val2" + } + } + ] + }, + { + "description": "Structure with locationName and queryName applied to members", + "metadata": { + "protocol": "ec2", + "apiVersion": "2014-01-01" + }, + "shapes": { + "InputShape": { + "type": "structure", + "members": { + "Foo": { + "shape": "StringType" + }, + "Bar": { + "shape": "StringType", + "locationName": "barLocationName" + }, + "Yuck": { + "shape": "StringType", + "locationName": "yuckLocationName", + "queryName": "yuckQueryName" + } + } + }, + "StringType": { + "type": "string" + } + }, + "cases": [ + { + "given": { + "input": { + "shape": "InputShape" + }, + "name": "OperationName" + }, + "params": { + "Foo": "val1", + "Bar": "val2", + "Yuck": "val3" + }, + "serialized": { + "uri": "/", + "body": "Action=OperationName&Version=2014-01-01&Foo=val1&BarLocationName=val2&yuckQueryName=val3" + } + } + ] + }, + { + "description": "Nested structure members", + "metadata": { + "protocol": "ec2", + "apiVersion": "2014-01-01" + }, + "shapes": { + "InputShape": { + "type": "structure", + "members": { + "StructArg": { + "shape": "StructType", + "locationName": "Struct" + } + } + }, + "StructType": { + "type": "structure", + "members": { + "ScalarArg": { + "shape": "StringType", + "locationName": "Scalar" + } + } + }, + "StringType": { + "type": "string" + } + }, + "cases": [ + { + "given": { + "input": { + "shape": "InputShape" + }, + "name": "OperationName" + }, + "params": { + "StructArg": { + "ScalarArg": "foo" + } + }, + "serialized": { + "uri": "/", + "body": "Action=OperationName&Version=2014-01-01&Struct.Scalar=foo" + } + } + ] + }, + { + "description": "List types", + "metadata": { + "protocol": "ec2", + "apiVersion": "2014-01-01" + }, + "shapes": { + "InputShape": { + "type": "structure", + "members": { + "ListArg": { + "shape": "ListType" + } + } + }, + "ListType": { + "type": "list", + "member": { + "shape": "Strings" + } + }, + "Strings": { + "type": "string" + } + }, + "cases": [ + { + "given": { + "input": { + "shape": "InputShape" + }, + "name": "OperationName" + }, + "params": { + "ListArg": [ + "foo", + "bar", + "baz" + ] + }, + "serialized": { + "uri": "/", + "body": "Action=OperationName&Version=2014-01-01&ListArg.1=foo&ListArg.2=bar&ListArg.3=baz" + } + } + ] + }, + { + "description": "List with location name applied to member", + "metadata": { + "protocol": "ec2", + "apiVersion": "2014-01-01" + }, + "shapes": { + "InputShape": { + "type": "structure", + "members": { + "ListArg": { + "shape": "ListType", + "locationName": "ListMemberName" + } + } + }, + "ListType": { + "type": "list", + "member": { + "shape": "StringType", + "LocationName": "item" + } + }, + "StringType": { + "type": "string" + } + }, + "cases": [ + { + "given": { + "input": { + "shape": "InputShape" + }, + "name": "OperationName" + }, + "params": { + "ListArg": [ + "a", + "b", + "c" + ] + }, + "serialized": { + "uri": "/", + "body": "Action=OperationName&Version=2014-01-01&ListMemberName.1=a&ListMemberName.2=b&ListMemberName.3=c" + } + } + ] + }, + { + "description": "List with locationName and queryName", + "metadata": { + "protocol": "ec2", + "apiVersion": "2014-01-01" + }, + "shapes": { + "InputShape": { + "type": "structure", + "members": { + "ListArg": { + "shape": "ListType", + "locationName": "ListMemberName", + "queryName": "ListQueryName" + } + } + }, + "ListType": { + "type": "list", + "member": { + "shape": "StringType", + "LocationName": "item" + } + }, + "StringType": { + "type": "string" + } + }, + "cases": [ + { + "given": { + "input": { + "shape": "InputShape" + }, + "name": "OperationName" + }, + "params": { + "ListArg": [ + "a", + "b", + "c" + ] + }, + "serialized": { + "uri": "/", + "body": "Action=OperationName&Version=2014-01-01&ListQueryName.1=a&ListQueryName.2=b&ListQueryName.3=c" + } + } + ] + }, + { + "description": "Base64 encoded Blobs", + "metadata": { + "protocol": "ec2", + "apiVersion": "2014-01-01" + }, + "shapes": { + "InputShape": { + "type": "structure", + "members": { + "BlobArg": { + "shape": "BlobType" + } + } + }, + "BlobType": { + "type": "blob" + } + }, + "cases": [ + { + "given": { + "input": { + "shape": "InputShape" + }, + "name": "OperationName" + }, + "params": { + "BlobArg": "foo" + }, + "serialized": { + "uri": "/", + "body": "Action=OperationName&Version=2014-01-01&BlobArg=Zm9v" + } + } + ] + }, + { + "description": "Timestamp values", + "metadata": { + "protocol": "ec2", + "apiVersion": "2014-01-01" + }, + "shapes": { + "InputShape": { + "type": "structure", + "members": { + "TimeArg": { + "shape": "TimestampType" + } + } + }, + "TimestampType": { + "type": "timestamp" + } + }, + "cases": [ + { + "given": { + "input": { + "shape": "InputShape" + }, + "name": "OperationName" + }, + "params": { + "TimeArg": 1422172800 + }, + "serialized": { + "uri": "/", + "body": "Action=OperationName&Version=2014-01-01&TimeArg=2015-01-25T08%3A00%3A00Z" + } + } + ] + }, + { + "description": "Idempotency token auto fill", + "metadata": { + "protocol": "ec2", + "apiVersion": "2014-01-01" + }, + "shapes": { + "InputShape": { + "type": "structure", + "members": { + "Token": { + "shape": "StringType", + "idempotencyToken": true + } + } + }, + "StringType": { + "type": "string" + } + }, + "cases": [ + { + "given": { + "input": { + "shape": "InputShape" + }, + "http": { + "method": "POST", + "requestUri": "/path" + }, + "name": "OperationName" + }, + "params": { + "Token": "abc123" + }, + "serialized": { + "uri": "/path", + "headers": {}, + "body": "Token=abc123" + } + }, + { + "given": { + "input": { + "shape": "InputShape" + }, + "http": { + "method": "POST", + "requestUri": "/path" + }, + "name": "OperationName" + }, + "params": { + }, + "serialized": { + "uri": "/path", + "headers": {}, + "body": "Token=00000000-0000-4000-8000-000000000000" + } + } + ] + } +] diff --git a/vendor/github.com/aws/aws-sdk-go/models/protocol_tests/input/json.json b/vendor/github.com/aws/aws-sdk-go/models/protocol_tests/input/json.json new file mode 100644 index 000000000..32d734efb --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/protocol_tests/input/json.json @@ -0,0 +1,541 @@ +[ + { + "description": "Scalar members", + "metadata": { + "protocol": "json", + "jsonVersion": "1.1", + "targetPrefix": "com.amazonaws.foo" + }, + "shapes": { + "InputShape": { + "type": "structure", + "members": { + "Name": { + "shape": "StringType" + } + } + }, + "StringType": { + "type": "string" + } + }, + "cases": [ + { + "given": { + "input": { + "shape": "InputShape" + }, + "name": "OperationName", + "http": { + "method": "POST" + } + }, + "params": { + "Name": "myname" + }, + "serialized": { + "body": "{\"Name\": \"myname\"}", + "headers": { + "X-Amz-Target": "com.amazonaws.foo.OperationName", + "Content-Type": "application/x-amz-json-1.1" + }, + "uri": "/" + } + } + ] + }, + { + "description": "Timestamp values", + "metadata": { + "protocol": "json", + "jsonVersion": "1.1", + "targetPrefix": "com.amazonaws.foo" + }, + "shapes": { + "InputShape": { + "type": "structure", + "members": { + "TimeArg": { + "shape": "TimestampType" + } + } + }, + "TimestampType": { + "type": "timestamp" + } + }, + "cases": [ + { + "given": { + "input": { + "shape": "InputShape" + }, + "name": "OperationName" + }, + "params": { + "TimeArg": 1422172800 + }, + "serialized": { + "body": "{\"TimeArg\": 1422172800}", + "headers": { + "X-Amz-Target": "com.amazonaws.foo.OperationName", + "Content-Type": "application/x-amz-json-1.1" + }, + "uri": "/" + } + } + ] + }, + { + "description": "Base64 encoded Blobs", + "metadata": { + "protocol": "json", + "jsonVersion": "1.1", + "targetPrefix": "com.amazonaws.foo" + }, + "shapes": { + "InputShape": { + "type": "structure", + "members": { + "BlobArg": { + "shape": "BlobType" + }, + "BlobMap": { + "shape": "BlobMapType" + } + } + }, + "BlobType": { + "type": "blob" + }, + "BlobMapType": { + "type": "map", + "key": {"shape": "StringType"}, + "value": {"shape": "BlobType"} + }, + "StringType": { + "type": "string" + } + }, + "cases": [ + { + "given": { + "input": { + "shape": "InputShape" + }, + "name": "OperationName" + }, + "params": { + "BlobArg": "foo" + }, + "serialized": { + "body": "{\"BlobArg\": \"Zm9v\"}", + "headers": { + "X-Amz-Target": "com.amazonaws.foo.OperationName", + "Content-Type": "application/x-amz-json-1.1" + }, + "uri": "/" + } + }, + { + "given": { + "input": { + "shape": "InputShape" + }, + "name": "OperationName" + }, + "params": { + "BlobMap": { + "key1": "foo", + "key2": "bar" + } + }, + "serialized": { + "body": "{\"BlobMap\": {\"key1\": \"Zm9v\", \"key2\": \"YmFy\"}}", + "headers": { + "X-Amz-Target": "com.amazonaws.foo.OperationName", + "Content-Type": "application/x-amz-json-1.1" + }, + "uri": "/" + } + } + ] + }, + { + "description": "Nested blobs", + "metadata": { + "protocol": "json", + "jsonVersion": "1.1", + "targetPrefix": "com.amazonaws.foo" + }, + "shapes": { + "InputShape": { + "type": "structure", + "members": { + "ListParam": { + "shape": "ListOfStructures" + } + } + }, + "ListOfStructures": { + "type": "list", + "member": { + "shape": "BlobType" + } + }, + "BlobType": { + "type": "blob" + } + }, + "cases": [ + { + "given": { + "http": { + "method": "POST" + }, + "input": { + "shape": "InputShape" + }, + "name": "OperationName" + }, + "params": { + "ListParam": ["foo", "bar"] + }, + "serialized": { + "body": "{\"ListParam\": [\"Zm9v\", \"YmFy\"]}", + "uri": "/", + "headers": {"X-Amz-Target": "com.amazonaws.foo.OperationName", + "Content-Type": "application/x-amz-json-1.1"} + } + } + ] + }, + { + "description": "Recursive shapes", + "metadata": { + "protocol": "json", + "jsonVersion": "1.1", + "targetPrefix": "com.amazonaws.foo" + }, + "shapes": { + "InputShape": { + "type": "structure", + "members": { + "RecursiveStruct": { + "shape": "RecursiveStructType" + } + } + }, + "RecursiveStructType": { + "type": "structure", + "members": { + "NoRecurse": { + "shape": "StringType" + }, + "RecursiveStruct": { + "shape": "RecursiveStructType" + }, + "RecursiveList": { + "shape": "RecursiveListType" + }, + "RecursiveMap": { + "shape": "RecursiveMapType" + } + } + }, + "RecursiveListType": { + "type": "list", + "member": { + "shape": "RecursiveStructType" + } + }, + "RecursiveMapType": { + "type": "map", + "key": { + "shape": "StringType" + }, + "value": { + "shape": "RecursiveStructType" + } + }, + "StringType": { + "type": "string" + } + }, + "cases": [ + { + "given": { + "input": { + "shape": "InputShape" + }, + "name": "OperationName" + }, + "params": { + "RecursiveStruct": { + "NoRecurse": "foo" + } + }, + "serialized": { + "uri": "/", + "headers": { + "X-Amz-Target": "com.amazonaws.foo.OperationName", + "Content-Type": "application/x-amz-json-1.1" + }, + "body": "{\"RecursiveStruct\": {\"NoRecurse\": \"foo\"}}" + } + }, + { + "given": { + "input": { + "shape": "InputShape" + }, + "name": "OperationName" + }, + "params": { + "RecursiveStruct": { + "RecursiveStruct": { + "NoRecurse": "foo" + } + } + }, + "serialized": { + "uri": "/", + "headers": { + "X-Amz-Target": "com.amazonaws.foo.OperationName", + "Content-Type": "application/x-amz-json-1.1" + }, + "body": "{\"RecursiveStruct\": {\"RecursiveStruct\": {\"NoRecurse\": \"foo\"}}}" + } + }, + { + "given": { + "input": { + "shape": "InputShape" + }, + "name": "OperationName" + }, + "params": { + "RecursiveStruct": { + "RecursiveStruct": { + "RecursiveStruct": { + "RecursiveStruct": { + "NoRecurse": "foo" + } + } + } + } + }, + "serialized": { + "uri": "/", + "headers": { + "X-Amz-Target": "com.amazonaws.foo.OperationName", + "Content-Type": "application/x-amz-json-1.1" + }, + "body": "{\"RecursiveStruct\": {\"RecursiveStruct\": {\"RecursiveStruct\": {\"RecursiveStruct\": {\"NoRecurse\": \"foo\"}}}}}" + } + }, + { + "given": { + "input": { + "shape": "InputShape" + }, + "name": "OperationName" + }, + "params": { + "RecursiveStruct": { + "RecursiveList": [ + { + "NoRecurse": "foo" + }, + { + "NoRecurse": "bar" + } + ] + } + }, + "serialized": { + "uri": "/", + "headers": { + "X-Amz-Target": "com.amazonaws.foo.OperationName", + "Content-Type": "application/x-amz-json-1.1" + }, + "body": "{\"RecursiveStruct\": {\"RecursiveList\": [{\"NoRecurse\": \"foo\"}, {\"NoRecurse\": \"bar\"}]}}" + } + }, + { + "given": { + "input": { + "shape": "InputShape" + }, + "name": "OperationName" + }, + "params": { + "RecursiveStruct": { + "RecursiveList": [ + { + "NoRecurse": "foo" + }, + { + "RecursiveStruct": { + "NoRecurse": "bar" + } + } + ] + } + }, + "serialized": { + "uri": "/", + "headers": { + "X-Amz-Target": "com.amazonaws.foo.OperationName", + "Content-Type": "application/x-amz-json-1.1" + }, + "body": "{\"RecursiveStruct\": {\"RecursiveList\": [{\"NoRecurse\": \"foo\"}, {\"RecursiveStruct\": {\"NoRecurse\": \"bar\"}}]}}" + } + }, + { + "given": { + "input": { + "shape": "InputShape" + }, + "name": "OperationName" + }, + "params": { + "RecursiveStruct": { + "RecursiveMap": { + "foo": { + "NoRecurse": "foo" + }, + "bar": { + "NoRecurse": "bar" + } + } + } + }, + "serialized": { + "uri": "/", + "headers": { + "X-Amz-Target": "com.amazonaws.foo.OperationName", + "Content-Type": "application/x-amz-json-1.1" + }, + "body": "{\"RecursiveStruct\": {\"RecursiveMap\": {\"foo\": {\"NoRecurse\": \"foo\"}, \"bar\": {\"NoRecurse\": \"bar\"}}}}" + } + } + ] + }, + { + "description": "Empty maps", + "metadata": { + "protocol": "json", + "jsonVersion": "1.1", + "targetPrefix": "com.amazonaws.foo" + }, + "shapes": { + "InputShape": { + "type": "structure", + "members": { + "Map": { + "shape": "MapType" + } + } + }, + "MapType": { + "type": "map", + "key": { + "shape": "StringType" + }, + "value": { + "shape": "StringType" + } + }, + "StringType": { + "type": "string" + } + }, + "cases": [ + { + "given": { + "input": { + "shape": "InputShape" + }, + "name": "OperationName", + "http": { + "method": "POST" + } + }, + "params": { + "Map": {} + }, + "serialized": { + "body": "{\"Map\": {}}", + "headers": { + "X-Amz-Target": "com.amazonaws.foo.OperationName", + "Content-Type": "application/x-amz-json-1.1" + }, + "uri": "/" + } + } + ] + }, + { + "description": "Idempotency token auto fill", + "metadata": { + "protocol": "json", + "apiVersion": "2014-01-01" + }, + "shapes": { + "InputShape": { + "type": "structure", + "members": { + "Token": { + "shape": "StringType", + "idempotencyToken": true + } + } + }, + "StringType": { + "type": "string" + } + }, + "cases": [ + { + "given": { + "input": { + "shape": "InputShape" + }, + "http": { + "method": "POST", + "requestUri": "/path" + }, + "name": "OperationName" + }, + "params": { + "Token": "abc123" + }, + "serialized": { + "uri": "/path", + "headers": {}, + "body": "{\"Token\": \"abc123\"}" + } + }, + { + "given": { + "input": { + "shape": "InputShape" + }, + "http": { + "method": "POST", + "requestUri": "/path" + }, + "name": "OperationName" + }, + "params": { + }, + "serialized": { + "uri": "/path", + "headers": {}, + "body": "{\"Token\": \"00000000-0000-4000-8000-000000000000\"}" + } + } + ] + } +] diff --git a/vendor/github.com/aws/aws-sdk-go/models/protocol_tests/input/query.json b/vendor/github.com/aws/aws-sdk-go/models/protocol_tests/input/query.json new file mode 100644 index 000000000..971b7ee61 --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/protocol_tests/input/query.json @@ -0,0 +1,842 @@ +[ + { + "description": "Scalar members", + "metadata": { + "protocol": "query", + "apiVersion": "2014-01-01" + }, + "shapes": { + "InputShape": { + "type": "structure", + "members": { + "Foo": { + "shape": "StringType" + }, + "Bar": { + "shape": "StringType" + }, + "Baz": { + "shape": "BooleanType" + } + } + }, + "StringType": { + "type": "string" + }, + "BooleanType": { + "type": "boolean" + } + }, + "cases": [ + { + "given": { + "input": { + "shape": "InputShape" + }, + "name": "OperationName" + }, + "params": { + "Foo": "val1", + "Bar": "val2" + }, + "serialized": { + "uri": "/", + "body": "Action=OperationName&Version=2014-01-01&Foo=val1&Bar=val2" + } + }, + { + "given": { + "input": { + "shape": "InputShape" + }, + "name": "OperationName" + }, + "params": { + "Baz": true + }, + "serialized": { + "uri": "/", + "body": "Action=OperationName&Version=2014-01-01&Baz=true" + } + }, + { + "given": { + "input": { + "shape": "InputShape" + }, + "name": "OperationName" + }, + "params": { + "Baz": false + }, + "serialized": { + "uri": "/", + "body": "Action=OperationName&Version=2014-01-01&Baz=false" + } + } + ] + }, + { + "description": "Nested structure members", + "metadata": { + "protocol": "query", + "apiVersion": "2014-01-01" + }, + "shapes": { + "InputShape": { + "type": "structure", + "members": { + "StructArg": { + "shape": "StructType" + } + } + }, + "StructType": { + "type": "structure", + "members": { + "ScalarArg": { + "shape": "StringType" + } + } + }, + "StringType": { + "type": "string" + } + }, + "cases": [ + { + "given": { + "input": { + "shape": "InputShape" + }, + "name": "OperationName" + }, + "params": { + "StructArg": { + "ScalarArg": "foo" + } + }, + "serialized": { + "uri": "/", + "body": "Action=OperationName&Version=2014-01-01&StructArg.ScalarArg=foo" + } + } + ] + }, + { + "description": "List types", + "metadata": { + "protocol": "query", + "apiVersion": "2014-01-01" + }, + "shapes": { + "InputShape": { + "type": "structure", + "members": { + "ListArg": { + "shape": "ListType" + } + } + }, + "ListType": { + "type": "list", + "member": { + "shape": "Strings" + } + }, + "Strings": { + "type": "string" + } + }, + "cases": [ + { + "given": { + "input": { + "shape": "InputShape" + }, + "name": "OperationName" + }, + "params": { + "ListArg": [ + "foo", + "bar", + "baz" + ] + }, + "serialized": { + "uri": "/", + "body": "Action=OperationName&Version=2014-01-01&ListArg.member.1=foo&ListArg.member.2=bar&ListArg.member.3=baz" + } + }, + { + "given": { + "input": { + "shape": "InputShape" + }, + "name": "OperationName" + }, + "params": { + "ListArg": [] + }, + "serialized": { + "uri": "/", + "body": "Action=OperationName&Version=2014-01-01&ListArg=" + } + } + ] + }, + { + "description": "Flattened list", + "metadata": { + "protocol": "query", + "apiVersion": "2014-01-01" + }, + "shapes": { + "InputShape": { + "type": "structure", + "members": { + "ScalarArg": { + "shape": "StringType" + }, + "ListArg": { + "shape": "ListType" + }, + "NamedListArg": { + "shape": "NamedListType" + } + } + }, + "ListType": { + "type": "list", + "member": { + "shape": "StringType" + }, + "flattened": true + }, + "NamedListType": { + "type": "list", + "member": { + "shape": "StringType", + "locationName": "Foo" + }, + "flattened": true + }, + "StringType": { + "type": "string" + } + }, + "cases": [ + { + "given": { + "input": { + "shape": "InputShape" + }, + "name": "OperationName" + }, + "params": { + "ScalarArg": "foo", + "ListArg": [ + "a", + "b", + "c" + ] + }, + "serialized": { + "uri": "/", + "body": "Action=OperationName&Version=2014-01-01&ScalarArg=foo&ListArg.1=a&ListArg.2=b&ListArg.3=c" + } + }, + { + "given": { + "input": { + "shape": "InputShape" + }, + "name": "OperationName" + }, + "params": { + "NamedListArg": [ + "a" + ] + }, + "serialized": { + "uri": "/", + "body": "Action=OperationName&Version=2014-01-01&Foo.1=a" + } + } + ] + }, + { + "description": "Serialize flattened map type", + "metadata": { + "protocol": "query", + "apiVersion": "2014-01-01" + }, + "shapes": { + "InputShape": { + "type": "structure", + "members": { + "MapArg": { + "shape": "StringMap" + } + } + }, + "StringMap": { + "type": "map", + "key": { + "shape": "StringType" + }, + "value": { + "shape": "StringType" + }, + "flattened": true + }, + "StringType": { + "type": "string" + } + }, + "cases": [ + { + "given": { + "input": { + "shape": "InputShape" + }, + "name": "OperationName" + }, + "params": { + "MapArg": { + "key1": "val1", + "key2": "val2" + } + }, + "serialized": { + "uri": "/", + "body": "Action=OperationName&Version=2014-01-01&MapArg.1.key=key1&MapArg.1.value=val1&MapArg.2.key=key2&MapArg.2.value=val2" + } + } + ] + }, + { + "description": "Non flattened list with LocationName", + "metadata": { + "protocol": "query", + "apiVersion": "2014-01-01" + }, + "shapes": { + "InputShape": { + "type": "structure", + "members": { + "ListArg": { + "shape": "ListType" + } + } + }, + "ListType": { + "type": "list", + "member": { + "shape": "StringType", + "locationName": "item" + } + }, + "StringType": { + "type": "string" + } + }, + "cases": [ + { + "given": { + "input": { + "shape": "InputShape" + }, + "name": "OperationName" + }, + "params": { + "ListArg": [ + "a", + "b", + "c" + ] + }, + "serialized": { + "uri": "/", + "body": "Action=OperationName&Version=2014-01-01&ListArg.item.1=a&ListArg.item.2=b&ListArg.item.3=c" + } + } + ] + }, + { + "description": "Flattened list with LocationName", + "metadata": { + "protocol": "query", + "apiVersion": "2014-01-01" + }, + "shapes": { + "InputShape": { + "type": "structure", + "members": { + "ScalarArg": { + "shape": "StringType" + }, + "ListArg": { + "shape": "ListType" + } + } + }, + "ListType": { + "type": "list", + "member": { + "shape": "StringType", + "locationName": "ListArgLocation" + }, + "flattened": true + }, + "StringType": { + "type": "string" + } + }, + "cases": [ + { + "given": { + "input": { + "shape": "InputShape" + }, + "name": "OperationName" + }, + "params": { + "ScalarArg": "foo", + "ListArg": [ + "a", + "b", + "c" + ] + }, + "serialized": { + "uri": "/", + "body": "Action=OperationName&Version=2014-01-01&ScalarArg=foo&ListArgLocation.1=a&ListArgLocation.2=b&ListArgLocation.3=c" + } + } + ] + }, + { + "description": "Serialize map type", + "metadata": { + "protocol": "query", + "apiVersion": "2014-01-01" + }, + "shapes": { + "InputShape": { + "type": "structure", + "members": { + "MapArg": { + "shape": "StringMap" + } + } + }, + "StringMap": { + "type": "map", + "key": { + "shape": "StringType" + }, + "value": { + "shape": "StringType" + } + }, + "StringType": { + "type": "string" + } + }, + "cases": [ + { + "given": { + "input": { + "shape": "InputShape" + }, + "name": "OperationName" + }, + "params": { + "MapArg": { + "key1": "val1", + "key2": "val2" + } + }, + "serialized": { + "uri": "/", + "body": "Action=OperationName&Version=2014-01-01&MapArg.entry.1.key=key1&MapArg.entry.1.value=val1&MapArg.entry.2.key=key2&MapArg.entry.2.value=val2" + } + } + ] + }, + { + "description": "Serialize map type with locationName", + "metadata": { + "protocol": "query", + "apiVersion": "2014-01-01" + }, + "shapes": { + "InputShape": { + "type": "structure", + "members": { + "MapArg": { + "shape": "StringMap" + } + } + }, + "StringMap": { + "type": "map", + "key": { + "shape": "StringType", + "locationName": "TheKey" + }, + "value": { + "shape": "StringType", + "locationName": "TheValue" + } + }, + "StringType": { + "type": "string" + } + }, + "cases": [ + { + "given": { + "input": { + "shape": "InputShape" + }, + "name": "OperationName" + }, + "params": { + "MapArg": { + "key1": "val1", + "key2": "val2" + } + }, + "serialized": { + "uri": "/", + "body": "Action=OperationName&Version=2014-01-01&MapArg.entry.1.TheKey=key1&MapArg.entry.1.TheValue=val1&MapArg.entry.2.TheKey=key2&MapArg.entry.2.TheValue=val2" + } + } + ] + }, + { + "description": "Base64 encoded Blobs", + "metadata": { + "protocol": "query", + "apiVersion": "2014-01-01" + }, + "shapes": { + "InputShape": { + "type": "structure", + "members": { + "BlobArg": { + "shape": "BlobType" + } + } + }, + "BlobType": { + "type": "blob" + } + }, + "cases": [ + { + "given": { + "input": { + "shape": "InputShape" + }, + "name": "OperationName" + }, + "params": { + "BlobArg": "foo" + }, + "serialized": { + "uri": "/", + "body": "Action=OperationName&Version=2014-01-01&BlobArg=Zm9v" + } + } + ] + }, + { + "description": "Timestamp values", + "metadata": { + "protocol": "query", + "apiVersion": "2014-01-01" + }, + "shapes": { + "InputShape": { + "type": "structure", + "members": { + "TimeArg": { + "shape": "TimestampType" + } + } + }, + "TimestampType": { + "type": "timestamp" + } + }, + "cases": [ + { + "given": { + "input": { + "shape": "InputShape" + }, + "name": "OperationName" + }, + "params": { + "TimeArg": 1422172800 + }, + "serialized": { + "uri": "/", + "body": "Action=OperationName&Version=2014-01-01&TimeArg=2015-01-25T08%3A00%3A00Z" + } + } + ] + }, + { + "description": "Recursive shapes", + "metadata": { + "protocol": "query", + "apiVersion": "2014-01-01" + }, + "shapes": { + "InputShape": { + "type": "structure", + "members": { + "RecursiveStruct": { + "shape": "RecursiveStructType" + } + } + }, + "RecursiveStructType": { + "type": "structure", + "members": { + "NoRecurse": { + "shape": "StringType" + }, + "RecursiveStruct": { + "shape": "RecursiveStructType" + }, + "RecursiveList": { + "shape": "RecursiveListType" + }, + "RecursiveMap": { + "shape": "RecursiveMapType" + } + } + }, + "RecursiveListType": { + "type": "list", + "member": { + "shape": "RecursiveStructType" + } + }, + "RecursiveMapType": { + "type": "map", + "key": { + "shape": "StringType" + }, + "value": { + "shape": "RecursiveStructType" + } + }, + "StringType": { + "type": "string" + } + }, + "cases": [ + { + "given": { + "input": { + "shape": "InputShape" + }, + "name": "OperationName" + }, + "params": { + "RecursiveStruct": { + "NoRecurse": "foo" + } + }, + "serialized": { + "uri": "/", + "body": "Action=OperationName&Version=2014-01-01&RecursiveStruct.NoRecurse=foo" + } + }, + { + "given": { + "input": { + "shape": "InputShape" + }, + "name": "OperationName" + }, + "params": { + "RecursiveStruct": { + "RecursiveStruct": { + "NoRecurse": "foo" + } + } + }, + "serialized": { + "uri": "/", + "body": "Action=OperationName&Version=2014-01-01&RecursiveStruct.RecursiveStruct.NoRecurse=foo" + } + }, + { + "given": { + "input": { + "shape": "InputShape" + }, + "name": "OperationName" + }, + "params": { + "RecursiveStruct": { + "RecursiveStruct": { + "RecursiveStruct": { + "RecursiveStruct": { + "NoRecurse": "foo" + } + } + } + } + }, + "serialized": { + "uri": "/", + "body": "Action=OperationName&Version=2014-01-01&RecursiveStruct.RecursiveStruct.RecursiveStruct.RecursiveStruct.NoRecurse=foo" + } + }, + { + "given": { + "input": { + "shape": "InputShape" + }, + "name": "OperationName" + }, + "params": { + "RecursiveStruct": { + "RecursiveList": [ + { + "NoRecurse": "foo" + }, + { + "NoRecurse": "bar" + } + ] + } + }, + "serialized": { + "uri": "/", + "body": "Action=OperationName&Version=2014-01-01&RecursiveStruct.RecursiveList.member.1.NoRecurse=foo&RecursiveStruct.RecursiveList.member.2.NoRecurse=bar" + } + }, + { + "given": { + "input": { + "shape": "InputShape" + }, + "name": "OperationName" + }, + "params": { + "RecursiveStruct": { + "RecursiveList": [ + { + "NoRecurse": "foo" + }, + { + "RecursiveStruct": { + "NoRecurse": "bar" + } + } + ] + } + }, + "serialized": { + "uri": "/", + "body": "Action=OperationName&Version=2014-01-01&RecursiveStruct.RecursiveList.member.1.NoRecurse=foo&RecursiveStruct.RecursiveList.member.2.RecursiveStruct.NoRecurse=bar" + } + }, + { + "given": { + "input": { + "shape": "InputShape" + }, + "name": "OperationName" + }, + "params": { + "RecursiveStruct": { + "RecursiveMap": { + "foo": { + "NoRecurse": "foo" + }, + "bar": { + "NoRecurse": "bar" + } + } + } + }, + "serialized": { + "uri": "/", + "body": "Action=OperationName&Version=2014-01-01&RecursiveStruct.RecursiveMap.entry.1.key=foo&RecursiveStruct.RecursiveMap.entry.1.value.NoRecurse=foo&RecursiveStruct.RecursiveMap.entry.2.key=bar&RecursiveStruct.RecursiveMap.entry.2.value.NoRecurse=bar" + } + } + ] + }, + { + "description": "Idempotency token auto fill", + "metadata": { + "protocol": "query", + "apiVersion": "2014-01-01" + }, + "shapes": { + "InputShape": { + "type": "structure", + "members": { + "Token": { + "shape": "StringType", + "idempotencyToken": true + } + } + }, + "StringType": { + "type": "string" + } + }, + "cases": [ + { + "given": { + "input": { + "shape": "InputShape" + }, + "http": { + "method": "POST", + "requestUri": "/path" + }, + "name": "OperationName" + }, + "params": { + "Token": "abc123" + }, + "serialized": { + "uri": "/path", + "headers": {}, + "body": "Token=abc123" + } + }, + { + "given": { + "input": { + "shape": "InputShape" + }, + "http": { + "method": "POST", + "requestUri": "/path" + }, + "name": "OperationName" + }, + "params": { + }, + "serialized": { + "uri": "/path", + "headers": {}, + "body": "Token=00000000-0000-4000-8000-000000000000" + } + } + ] + } +] diff --git a/vendor/github.com/aws/aws-sdk-go/models/protocol_tests/input/rest-json.json b/vendor/github.com/aws/aws-sdk-go/models/protocol_tests/input/rest-json.json new file mode 100644 index 000000000..01d6ab217 --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/protocol_tests/input/rest-json.json @@ -0,0 +1,1240 @@ +[ + { + "description": "No parameters", + "metadata": { + "protocol": "rest-json", + "apiVersion": "2014-01-01" + }, + "shapes": {}, + "cases": [ + { + "given": { + "http": { + "method": "GET", + "requestUri": "/2014-01-01/jobs" + }, + "name": "OperationName" + }, + "serialized": { + "body": "", + "uri": "/2014-01-01/jobs", + "headers": {} + } + } + ] + }, + { + "description": "URI parameter only with no location name", + "metadata": { + "protocol": "rest-json", + "apiVersion": "2014-01-01" + }, + "shapes": { + "InputShape": { + "type": "structure", + "members": { + "PipelineId": { + "shape": "StringType", + "location": "uri" + } + } + }, + "StringType": { + "type": "string" + } + }, + "cases": [ + { + "given": { + "http": { + "method": "GET", + "requestUri": "/2014-01-01/jobsByPipeline/{PipelineId}" + }, + "input": { + "shape": "InputShape" + }, + "name": "OperationName" + }, + "params": { + "PipelineId": "foo" + }, + "serialized": { + "body": "", + "uri": "/2014-01-01/jobsByPipeline/foo", + "headers": {} + } + } + ] + }, + { + "description": "URI parameter only with location name", + "metadata": { + "protocol": "rest-json", + "apiVersion": "2014-01-01" + }, + "shapes": { + "InputShape": { + "type": "structure", + "members": { + "Foo": { + "shape": "StringType", + "location": "uri", + "locationName": "PipelineId" + } + } + }, + "StringType": { + "type": "string" + } + }, + "cases": [ + { + "given": { + "http": { + "method": "GET", + "requestUri": "/2014-01-01/jobsByPipeline/{PipelineId}" + }, + "input": { + "shape": "InputShape" + }, + "name": "OperationName" + }, + "params": { + "Foo": "bar" + }, + "serialized": { + "body": "", + "uri": "/2014-01-01/jobsByPipeline/bar", + "headers": {} + } + } + ] + }, + { + "description": "Querystring list of strings", + "metadata": { + "protocol": "rest-json", + "apiVersion": "2014-01-01" + }, + "shapes": { + "InputShape": { + "type": "structure", + "members": { + "Items": { + "shape": "StringList", + "location": "querystring", + "locationName": "item" + } + } + }, + "StringList": { + "type": "list", + "member": { + "shape": "String" + } + }, + "String": { + "type": "string" + } + }, + "cases": [ + { + "given": { + "http": { + "method": "GET", + "requestUri": "/path" + }, + "input": { + "shape": "InputShape" + }, + "name": "OperationName" + }, + "params": { + "Items": ["value1", "value2"] + }, + "serialized": { + "body": "", + "uri": "/path?item=value1&item=value2", + "headers": {} + } + } + ] + }, + { + "description": "String to string maps in querystring", + "metadata": { + "protocol": "rest-json", + "apiVersion": "2014-01-01" + }, + "shapes": { + "InputShape": { + "type": "structure", + "members": { + "PipelineId": { + "shape": "StringType", + "location": "uri" + }, + "QueryDoc": { + "shape": "MapStringStringType", + "location": "querystring" + } + } + }, + "MapStringStringType": { + "type": "map", + "key": { + "shape": "StringType" + }, + "value": { + "shape": "StringType" + } + }, + "StringType": { + "type": "string" + } + }, + "cases": [ + { + "given": { + "http": { + "method": "GET", + "requestUri": "/2014-01-01/jobsByPipeline/{PipelineId}" + }, + "input": { + "shape": "InputShape" + }, + "name": "OperationName" + }, + "params": { + "PipelineId": "foo", + "QueryDoc": { + "bar": "baz", + "fizz": "buzz" + } + }, + "serialized": { + "body": "", + "uri": "/2014-01-01/jobsByPipeline/foo?bar=baz&fizz=buzz", + "headers": {} + } + } + ] + }, + { + "description": "String to string list maps in querystring", + "metadata": { + "protocol": "rest-json", + "apiVersion": "2014-01-01" + }, + "shapes": { + "InputShape": { + "type": "structure", + "members": { + "PipelineId": { + "shape": "StringType", + "location": "uri" + }, + "QueryDoc": { + "shape": "MapStringStringListType", + "location": "querystring" + } + } + }, + "MapStringStringListType": { + "type": "map", + "key": { + "shape": "StringType" + }, + "value": { + "shape": "StringListType" + } + }, + "StringListType": { + "type": "list", + "member": { + "shape": "StringType" + } + }, + "StringType": { + "type": "string" + } + }, + "cases": [ + { + "given": { + "http": { + "method": "GET", + "requestUri": "/2014-01-01/jobsByPipeline/{PipelineId}" + }, + "input": { + "shape": "InputShape" + }, + "name": "OperationName" + }, + "params": { + "PipelineId": "id", + "QueryDoc": { + "foo": ["bar", "baz"], + "fizz": ["buzz", "pop"] + } + }, + "serialized": { + "body": "", + "uri": "/2014-01-01/jobsByPipeline/id?foo=bar&foo=baz&fizz=buzz&fizz=pop", + "headers": {} + } + } + ] + }, + { + "description": "URI parameter and querystring params", + "metadata": { + "protocol": "rest-json", + "apiVersion": "2014-01-01" + }, + "shapes": { + "InputShape": { + "type": "structure", + "members": { + "PipelineId": { + "shape": "StringType", + "location": "uri", + "locationName": "PipelineId" + }, + "Ascending": { + "shape": "StringType", + "location": "querystring", + "locationName": "Ascending" + }, + "PageToken": { + "shape": "StringType", + "location": "querystring", + "locationName": "PageToken" + } + } + }, + "StringType": { + "type": "string" + } + }, + "cases": [ + { + "given": { + "http": { + "method": "GET", + "requestUri": "/2014-01-01/jobsByPipeline/{PipelineId}" + }, + "input": { + "shape": "InputShape" + }, + "name": "OperationName" + }, + "params": { + "PipelineId": "foo", + "Ascending": "true", + "PageToken": "bar" + }, + "serialized": { + "body": "", + "uri": "/2014-01-01/jobsByPipeline/foo?Ascending=true&PageToken=bar", + "headers": {} + } + } + ] + }, + { + "description": "URI parameter, querystring params and JSON body", + "metadata": { + "protocol": "rest-json", + "apiVersion": "2014-01-01" + }, + "shapes": { + "InputShape": { + "type": "structure", + "members": { + "PipelineId": { + "shape": "StringType", + "location": "uri", + "locationName": "PipelineId" + }, + "Ascending": { + "shape": "StringType", + "location": "querystring", + "locationName": "Ascending" + }, + "PageToken": { + "shape": "StringType", + "location": "querystring", + "locationName": "PageToken" + }, + "Config": { + "shape": "StructType" + } + } + }, + "StringType": { + "type": "string" + }, + "StructType": { + "type": "structure", + "members": { + "A": { + "shape": "StringType" + }, + "B": { + "shape": "StringType" + } + } + } + }, + "cases": [ + { + "given": { + "http": { + "method": "POST", + "requestUri": "/2014-01-01/jobsByPipeline/{PipelineId}" + }, + "input": { + "shape": "InputShape" + }, + "name": "OperationName" + }, + "params": { + "PipelineId": "foo", + "Ascending": "true", + "PageToken": "bar", + "Config": { + "A": "one", + "B": "two" + } + }, + "serialized": { + "body": "{\"Config\": {\"A\": \"one\", \"B\": \"two\"}}", + "uri": "/2014-01-01/jobsByPipeline/foo?Ascending=true&PageToken=bar", + "headers": {} + } + } + ] + }, + { + "description": "URI parameter, querystring params, headers and JSON body", + "metadata": { + "protocol": "rest-json", + "apiVersion": "2014-01-01" + }, + "shapes": { + "InputShape": { + "type": "structure", + "members": { + "PipelineId": { + "shape": "StringType", + "location": "uri", + "locationName": "PipelineId" + }, + "Ascending": { + "shape": "StringType", + "location": "querystring", + "locationName": "Ascending" + }, + "Checksum": { + "shape": "StringType", + "location": "header", + "locationName": "x-amz-checksum" + }, + "PageToken": { + "shape": "StringType", + "location": "querystring", + "locationName": "PageToken" + }, + "Config": { + "shape": "StructType" + } + } + }, + "StringType": { + "type": "string" + }, + "StructType": { + "type": "structure", + "members": { + "A": { + "shape": "StringType" + }, + "B": { + "shape": "StringType" + } + } + } + }, + "cases": [ + { + "given": { + "http": { + "method": "POST", + "requestUri": "/2014-01-01/jobsByPipeline/{PipelineId}" + }, + "input": { + "shape": "InputShape" + }, + "name": "OperationName" + }, + "params": { + "PipelineId": "foo", + "Ascending": "true", + "Checksum": "12345", + "PageToken": "bar", + "Config": { + "A": "one", + "B": "two" + } + }, + "serialized": { + "body": "{\"Config\": {\"A\": \"one\", \"B\": \"two\"}}", + "uri": "/2014-01-01/jobsByPipeline/foo?Ascending=true&PageToken=bar", + "headers": { + "x-amz-checksum": "12345" + } + } + } + ] + }, + { + "description": "Streaming payload", + "metadata": { + "protocol": "rest-json", + "apiVersion": "2014-01-01" + }, + "shapes": { + "InputShape": { + "type": "structure", + "members": { + "vaultName": { + "shape": "StringType", + "location": "uri", + "locationName": "vaultName" + }, + "checksum": { + "shape": "StringType", + "location": "header", + "locationName": "x-amz-sha256-tree-hash" + }, + "body": { + "shape": "Stream" + } + }, + "required": [ + "vaultName" + ], + "payload": "body" + }, + "StringType": { + "type": "string" + }, + "Stream": { + "type": "blob", + "streaming": true + } + }, + "cases": [ + { + "given": { + "http": { + "method": "POST", + "requestUri": "/2014-01-01/vaults/{vaultName}/archives" + }, + "input": { + "shape": "InputShape" + }, + "name": "OperationName" + }, + "params": { + "vaultName": "name", + "checksum": "foo", + "body": "contents" + }, + "serialized": { + "body": "contents", + "uri": "/2014-01-01/vaults/name/archives", + "headers": { + "x-amz-sha256-tree-hash": "foo" + } + } + } + ] + }, + { + "description": "Serialize blobs in body", + "metadata": { + "protocol": "rest-json", + "apiVersion": "2014-01-01" + }, + "shapes": { + "InputShape": { + "type": "structure", + "members": { + "Foo": { + "shape": "StringType", + "location": "uri", + "locationName": "Foo" + }, + "Bar": {"shape": "BlobType"} + }, + "required": [ + "Foo" + ] + }, + "StringType": { + "type": "string" + }, + "BlobType": { + "type": "blob" + } + }, + "cases": [ + { + "given": { + "http": { + "method": "GET", + "requestUri": "/2014-01-01/{Foo}" + }, + "input": { + "shape": "InputShape" + }, + "name": "OperationName" + }, + "params": { + "Foo": "foo_name", + "Bar": "Blob param" + }, + "serialized": { + "body": "{\"Bar\": \"QmxvYiBwYXJhbQ==\"}", + "uri": "/2014-01-01/foo_name" + } + } + ] + }, + { + "description": "Blob payload", + "metadata": { + "protocol": "rest-json", + "apiVersion": "2014-01-01" + }, + "shapes": { + "InputShape": { + "type": "structure", + "members": { + "foo": { + "shape": "FooShape" + } + } + }, + "FooShape": { + "type": "blob" + } + }, + "cases": [ + { + "given": { + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "InputShape", + "payload": "foo" + }, + "name": "OperationName" + }, + "params": { + "foo": "bar" + }, + "serialized": { + "method": "POST", + "body": "bar", + "uri": "/" + } + }, + { + "given": { + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "InputShape", + "payload": "foo" + }, + "name": "OperationName" + }, + "params": { + }, + "serialized": { + "method": "POST", + "body": "", + "uri": "/" + } + } + ] + }, + { + "description": "Structure payload", + "metadata": { + "protocol": "rest-json", + "apiVersion": "2014-01-01" + }, + "shapes": { + "InputShape": { + "type": "structure", + "members": { + "foo": { + "shape": "FooShape" + } + } + }, + "FooShape": { + "locationName": "foo", + "type": "structure", + "members": { + "baz": { + "shape": "BazShape" + } + } + }, + "BazShape": { + "type": "string" + } + }, + "cases": [ + { + "given": { + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "InputShape", + "payload": "foo" + }, + "name": "OperationName" + }, + "params": { + "foo": { + "baz": "bar" + } + }, + "serialized": { + "method": "POST", + "body": "{\"baz\": \"bar\"}", + "uri": "/" + } + }, + { + "given": { + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "InputShape", + "payload": "foo" + }, + "name": "OperationName" + }, + "params": {}, + "serialized": { + "method": "POST", + "body": "", + "uri": "/" + } + } + ] + }, + { + "description": "Omits null query params, but serializes empty strings", + "metadata": { + "protocol": "rest-json", + "apiVersion": "2014-01-01" + }, + "shapes": { + "InputShape": { + "type": "structure", + "members": { + "foo": { + "location":"querystring", + "locationName":"param-name", + "shape": "Foo" + } + } + }, + "Foo": { + "type": "string" + } + }, + "cases": [ + { + "given": { + "name": "OperationName", + "http": { + "method": "POST", + "requestUri": "/path" + }, + "input": { "shape": "InputShape" } + }, + "params": { "foo": null }, + "serialized": { + "method": "POST", + "body": "", + "uri": "/path" + } + }, + { + "given": { + "name": "OperationName", + "http": { + "method": "POST", + "requestUri": "/path?abc=mno" + }, + "input": { "shape": "InputShape" } + }, + "params": { "foo": "" }, + "serialized": { + "method": "POST", + "body": "", + "uri": "/path?abc=mno¶m-name=" + } + } + ] + }, + { + "description": "Recursive shapes", + "metadata": { + "protocol": "rest-json", + "apiVersion": "2014-01-01" + }, + "shapes": { + "InputShape": { + "type": "structure", + "members": { + "RecursiveStruct": { + "shape": "RecursiveStructType" + } + } + }, + "RecursiveStructType": { + "type": "structure", + "members": { + "NoRecurse": { + "shape": "StringType" + }, + "RecursiveStruct": { + "shape": "RecursiveStructType" + }, + "RecursiveList": { + "shape": "RecursiveListType" + }, + "RecursiveMap": { + "shape": "RecursiveMapType" + } + } + }, + "RecursiveListType": { + "type": "list", + "member": { + "shape": "RecursiveStructType" + } + }, + "RecursiveMapType": { + "type": "map", + "key": { + "shape": "StringType" + }, + "value": { + "shape": "RecursiveStructType" + } + }, + "StringType": { + "type": "string" + } + }, + "cases": [ + { + "given": { + "input": { + "shape": "InputShape" + }, + "http": { + "method": "POST", + "requestUri": "/path" + }, + "name": "OperationName" + }, + "params": { + "RecursiveStruct": { + "NoRecurse": "foo" + } + }, + "serialized": { + "uri": "/path" , + "headers": {}, + "body": "{\"RecursiveStruct\": {\"NoRecurse\": \"foo\"}}" + } + }, + { + "given": { + "input": { + "shape": "InputShape" + }, + "http": { + "method": "POST", + "requestUri": "/path" + }, + "name": "OperationName" + }, + "params": { + "RecursiveStruct": { + "RecursiveStruct": { + "NoRecurse": "foo" + } + } + }, + "serialized": { + "uri": "/path", + "headers": {}, + "body": "{\"RecursiveStruct\": {\"RecursiveStruct\": {\"NoRecurse\": \"foo\"}}}" + } + }, + { + "given": { + "input": { + "shape": "InputShape" + }, + "http": { + "method": "POST", + "requestUri": "/path" + }, + "name": "OperationName" + }, + "params": { + "RecursiveStruct": { + "RecursiveStruct": { + "RecursiveStruct": { + "RecursiveStruct": { + "NoRecurse": "foo" + } + } + } + } + }, + "serialized": { + "uri": "/path", + "headers": {}, + "body": "{\"RecursiveStruct\": {\"RecursiveStruct\": {\"RecursiveStruct\": {\"RecursiveStruct\": {\"NoRecurse\": \"foo\"}}}}}" + } + }, + { + "given": { + "input": { + "shape": "InputShape" + }, + "http": { + "method": "POST", + "requestUri": "/path" + }, + "name": "OperationName" + }, + "params": { + "RecursiveStruct": { + "RecursiveList": [ + { + "NoRecurse": "foo" + }, + { + "NoRecurse": "bar" + } + ] + } + }, + "serialized": { + "uri": "/path", + "headers": {}, + "body": "{\"RecursiveStruct\": {\"RecursiveList\": [{\"NoRecurse\": \"foo\"}, {\"NoRecurse\": \"bar\"}]}}" + } + }, + { + "given": { + "input": { + "shape": "InputShape" + }, + "http": { + "method": "POST", + "requestUri": "/path" + }, + "name": "OperationName" + }, + "params": { + "RecursiveStruct": { + "RecursiveList": [ + { + "NoRecurse": "foo" + }, + { + "RecursiveStruct": { + "NoRecurse": "bar" + } + } + ] + } + }, + "serialized": { + "uri": "/path", + "headers": {}, + "body": "{\"RecursiveStruct\": {\"RecursiveList\": [{\"NoRecurse\": \"foo\"}, {\"RecursiveStruct\": {\"NoRecurse\": \"bar\"}}]}}" + } + }, + { + "given": { + "input": { + "shape": "InputShape" + }, + "http": { + "method": "POST", + "requestUri": "/path" + }, + "name": "OperationName" + }, + "params": { + "RecursiveStruct": { + "RecursiveMap": { + "foo": { + "NoRecurse": "foo" + }, + "bar": { + "NoRecurse": "bar" + } + } + } + }, + "serialized": { + "uri": "/path", + "headers": {}, + "body": "{\"RecursiveStruct\": {\"RecursiveMap\": {\"foo\": {\"NoRecurse\": \"foo\"}, \"bar\": {\"NoRecurse\": \"bar\"}}}}" + } + } + ] + }, + { + "description": "Timestamp values", + "metadata": { + "protocol": "rest-json", + "apiVersion": "2014-01-01" + }, + "shapes": { + "InputShape": { + "type": "structure", + "members": { + "TimeArg": { + "shape": "TimestampType" + }, + "TimeArgInHeader": { + "shape": "TimestampType", + "location": "header", + "locationName": "x-amz-timearg" + } + } + }, + "TimestampType": { + "type": "timestamp" + } + }, + "cases": [ + { + "given": { + "input": { + "shape": "InputShape" + }, + "http": { + "method": "POST", + "requestUri": "/path" + }, + "name": "OperationName" + }, + "params": { + "TimeArg": 1422172800 + }, + "serialized": { + "uri": "/path", + "headers": {}, + "body": "{\"TimeArg\": 1422172800}" + } + }, + { + "given": { + "input": { + "shape": "InputShape" + }, + "http": { + "method": "POST", + "requestUri": "/path" + }, + "name": "OperationName" + }, + "params": { + "TimeArgInHeader": 1422172800 + }, + "serialized": { + "uri": "/path", + "headers": {"x-amz-timearg": "Sun, 25 Jan 2015 08:00:00 GMT"}, + "body": "" + } + } + ] + }, + { + "description": "Named locations in JSON body", + "metadata": { + "protocol": "rest-json", + "apiVersion": "2014-01-01" + }, + "shapes": { + "InputShape": { + "type": "structure", + "members": { + "TimeArg": { + "shape": "TimestampType", + "locationName": "timestamp_location" + } + } + }, + "TimestampType": { + "type": "timestamp" + } + }, + "cases": [ + { + "given": { + "input": { + "shape": "InputShape" + }, + "http": { + "method": "POST", + "requestUri": "/path" + }, + "name": "OperationName" + }, + "params": { + "TimeArg": 1422172800 + }, + "serialized": { + "uri": "/path", + "headers": {}, + "body": "{\"timestamp_location\": 1422172800}" + } + } + ] + }, + { + "description": "String payload", + "metadata": { + "protocol": "rest-json", + "apiVersion": "2014-01-01" + }, + "shapes": { + "InputShape": { + "type": "structure", + "members": { + "foo": { + "shape": "FooShape" + } + } + }, + "FooShape": { + "type": "string" + } + }, + "cases": [ + { + "given": { + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "InputShape", + "payload": "foo" + }, + "name": "OperationName" + }, + "params": { + "foo": "bar" + }, + "serialized": { + "method": "POST", + "body": "bar", + "uri": "/" + } + } + ] + }, + { + "description": "Idempotency token auto fill", + "metadata": { + "protocol": "rest-json", + "apiVersion": "2014-01-01" + }, + "shapes": { + "InputShape": { + "type": "structure", + "members": { + "Token": { + "shape": "StringType", + "idempotencyToken": true + } + } + }, + "StringType": { + "type": "string" + } + }, + "cases": [ + { + "given": { + "input": { + "shape": "InputShape" + }, + "http": { + "method": "POST", + "requestUri": "/path" + }, + "name": "OperationName" + }, + "params": { + "Token": "abc123" + }, + "serialized": { + "uri": "/path", + "headers": {}, + "body": "{\"Token\": \"abc123\"}" + } + }, + { + "given": { + "input": { + "shape": "InputShape" + }, + "http": { + "method": "POST", + "requestUri": "/path" + }, + "name": "OperationName" + }, + "params": { + }, + "serialized": { + "uri": "/path", + "headers": {}, + "body": "{\"Token\": \"00000000-0000-4000-8000-000000000000\"}" + } + } + ] + } +] diff --git a/vendor/github.com/aws/aws-sdk-go/models/protocol_tests/input/rest-xml.json b/vendor/github.com/aws/aws-sdk-go/models/protocol_tests/input/rest-xml.json new file mode 100644 index 000000000..ad3f30441 --- /dev/null +++ b/vendor/github.com/aws/aws-sdk-go/models/protocol_tests/input/rest-xml.json @@ -0,0 +1,1633 @@ +[ + { + "description": "Basic XML serialization", + "metadata": { + "protocol": "rest-xml", + "apiVersion": "2014-01-01" + }, + "shapes": { + "InputShape": { + "type": "structure", + "members": { + "Name": { + "shape": "StringType" + }, + "Description": { + "shape": "StringType" + } + } + }, + "StringType": { + "type": "string" + } + }, + "cases": [ + { + "given": { + "http": { + "method": "POST", + "requestUri": "/2014-01-01/hostedzone" + }, + "input": { + "shape": "InputShape", + "locationName": "OperationRequest", + "xmlNamespace": {"uri": "https://foo/"} + }, + "name": "OperationName" + }, + "params": { + "Name": "foo", + "Description": "bar" + }, + "serialized": { + "method": "POST", + "body": "InvalidDomainName
+ ErrorCodeSomeExceptionSomeException`)
+ buf.WriteString(e.code)
+ buf.WriteString(`+13vGnVI80IWX!Je^WW I7&@Q(o`(c-WT?Vhh+Uvzp&*eBS=L
zm}zu&7}sE6_l*gn4TfWsI$)#>8WvyRUs1haVjvg2`lZCR;G=&KU@bki&Vrz>*y?;H
z^9&o&@OD7ilhYO~o^ R&qShhCgHNMD{$Xzgvx@8^vkKC9zQ
ziESivT?NLc>w0TI)6~i=KJ8q5owQV9*2TRGFmGtjZwy-rUkm-Jp7P=}0wOz_N(IC9>>*T*3Ulh}0+SP!o>sloG}T;El83qP
zx0uL|eK20{fguHFoF<)`R%KsIYMDtZ-Yf^5={SZnv0E#bV)kBG%qyNK=K7g}Hc~VV
z;;ez&Ty<(NVKZ=m@1{Cs+UeNO`axcbl7^w4(~ED^AuS?JFWULUHtkkn#KC86ts?w-
z=a2G^18uh=JIiyLz{A$UeZ9_rS#CqD6~esq=y4mVN`s0%TWi^OOK{wNs%~Qb;kCz8
zZZQB&hrk$Wo<+f1wI|Z)_~&n#(15i*BNgfT!6nU!H3UC-e`?WOPibE^q`bHh8TG>=wJEfR*QIF17g#sQeDtJ620CmxkDZPP!7#
zE(GRO0iN1te)W^rY}m_BMX29=S5EuZf~{Dub{zAx*>N3Xl_m1am$3{Hc|o3@ItkAw
zW3}*SMEEzJB@s1@B+Z`~5iY^Lm}v
z6C2cO31Xwk5ZhJU?uXQwteV=NUC_n@?g80Ai`!taZGkk!0C9zK>lNcDoW^xiIs(+|
z68yq#ccUf@10;v^sSOiJlIIFvJXZ6lS@k_~*hMw1NW<$|bKsPcs)FIsn|v!YX-QO<
z-A-D=dOcKetD<4lI~8&{iaMniJWae6(?4Axg>tFQ9MTGAj+cI(tn5Wjwz%4ZI&ma-
z-`9IIhtKn*!zy8m;scT|zL!AQN49c0k)8#B+d0hAj5+tkXXn?8oL?t~lfpYksM=fB
zCA>M$l)mcuGEotC4lyz~EvDaCb4ZZyt$0=Msu;L$&E6%O+Bo+IKG^vQf8`RS7*0LW
zPKUcyY`L1^EF8gFX~~?okZiwekz=2Mz}nxgsk3j+rjG`G$$rkeX?a?kkz|EsJT@ww
z96CrE==W7K4Vs*$O-*mD*LO$%Y}g_Wde1zmoNFkrm|GZl^~4$}So|T+37-N5S`EsI
zdI!V0=V}&Nj#uMR0$(yxR3=};S^uopZvA(kRclh*9Dl-lqw4baazS
+ {{end}} + {{.XML}} +